Skip to main content
cURL
curl --request POST \
--url https://api.baseten.co/v1/models/{model_id}/environments \
--header "Authorization: Api-Key $BASETEN_API_KEY" \
--data '{
  "name": "staging",
  "autoscaling_settings": {
    "autoscaling_window": 800,
    "concurrency_target": 3,
    "max_replica": 2,
    "min_replica": 1,
    "scale_down_delay": 60,
    "target_in_flight_tokens": null,
    "target_utilization_percentage": null
  },
  "promotion_settings": {
    "promotion_cleanup_strategy": null,
    "ramp_up_duration_seconds": 600,
    "ramp_up_while_promoting": true,
    "redeploy_on_promotion": true,
    "rolling_deploy": true,
    "rolling_deploy_config": null
  }
}'
{
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "model_id": "<string>",
  "current_deployment": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "model_id": "<string>",
    "is_production": true,
    "is_development": true,
    "active_replica_count": 123,
    "autoscaling_settings": {
      "min_replica": 123,
      "max_replica": 123,
      "autoscaling_window": 123,
      "scale_down_delay": 123,
      "concurrency_target": 123,
      "target_utilization_percentage": 123,
      "target_in_flight_tokens": 123
    },
    "instance_type_name": "<string>",
    "environment": "<string>",
    "labels": {}
  },
  "autoscaling_settings": {
    "min_replica": 123,
    "max_replica": 123,
    "autoscaling_window": 123,
    "scale_down_delay": 123,
    "concurrency_target": 123,
    "target_utilization_percentage": 123,
    "target_in_flight_tokens": 123
  },
  "promotion_settings": {
    "redeploy_on_promotion": true,
    "rolling_deploy": true,
    "promotion_cleanup_strategy": "SCALE_TO_ZERO",
    "rolling_deploy_config": {
      "rolling_deploy_strategy": "REPLICA",
      "max_surge_percent": 10,
      "max_unavailable_percent": 0,
      "stabilization_time_seconds": 0,
      "replica_overhead_percent": 0
    },
    "ramp_up_while_promoting": true,
    "ramp_up_duration_seconds": 600
  },
  "instance_type": {
    "id": "<string>",
    "name": "<string>",
    "memory_limit_mib": 123,
    "millicpu_limit": 123,
    "gpu_count": 123,
    "gpu_type": "<string>",
    "gpu_memory_limit_mib": 123
  },
  "candidate_deployment": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "model_id": "<string>",
    "is_production": true,
    "is_development": true,
    "active_replica_count": 123,
    "autoscaling_settings": {
      "min_replica": 123,
      "max_replica": 123,
      "autoscaling_window": 123,
      "scale_down_delay": 123,
      "concurrency_target": 123,
      "target_utilization_percentage": 123,
      "target_in_flight_tokens": 123
    },
    "instance_type_name": "<string>",
    "environment": "<string>",
    "labels": {}
  },
  "in_progress_promotion": {
    "percent_traffic_to_new_version": 123,
    "error_message": "<string>",
    "rolling_deploy": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.baseten.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

You must specify the scheme 'Api-Key' in the Authorization header. For example, Authorization: Api-Key <Your_Api_Key>

Path Parameters

​
model_id
string
required

Body

application/json

A request to create an environment.

​
name
string
required

Name of the environment

Example:

"staging"

​
autoscaling_settings
UpdateAutoscalingSettingsV1 · object

Autoscaling settings for the environment

Example:
{
  "autoscaling_window": 800,
  "concurrency_target": 3,
  "max_replica": 2,
  "min_replica": 1,
  "scale_down_delay": 60,
  "target_in_flight_tokens": null,
  "target_utilization_percentage": null
}
​
promotion_settings
UpdatePromotionSettingsV1 · object

Promotion settings for the environment

Example:
{
  "promotion_cleanup_strategy": null,
  "ramp_up_duration_seconds": 600,
  "ramp_up_while_promoting": true,
  "redeploy_on_promotion": true,
  "rolling_deploy": true,
  "rolling_deploy_config": null
}

Response

200 - application/json

Environment for oracles.

​
name
string
required

Name of the environment

​
created_at
string<date-time>
required

Time the environment was created in ISO 8601 format

​
model_id
string
required

Unique identifier of the model

​
current_deployment
DeploymentV1 · object
required

Current deployment of the environment

​
autoscaling_settings
AutoscalingSettingsV1 · object
required

Autoscaling settings for the environment

​
promotion_settings
PromotionSettingsV1 · object
required

Promotion settings for the environment

​
instance_type
InstanceTypeV1 · object
required

Instance type for the environment

​
candidate_deployment
DeploymentV1 · object

Candidate deployment being promoted to the environment, if a promotion is in progress

​
in_progress_promotion
InProgressPromotionV1 · object

Details of the in-progress promotion, if any