Inference API
- POST🆕 Inference by environment
- POSTProduction deployment
- POSTDevelopment deployment
- POSTPublished deployment
- OpenAI compatible endpoints
- Wake deployment endpoints
- Deprecated endpoints
Async Inference API
- POST🆕 Async inference by environment
- POSTProduction deployment
- POSTDevelopment deployment
- POSTPublished deployment
- Get async request status
- Cancel async request
- Get async queue status
Management API
- GETGet all secrets
- POSTUpsert a secret
- 🆕 Manage model environments
- 🆕 Manage chain environments
- GETGet instance types
- Get models
- DELDelete models
- Get chains
- DELDelete chains
- Get model deployments
- DELDelete model deployments
- Get chain deployments
- DELDelete chain deployments
- Promote deployment
- Update model deployment autoscaling settings
- Activate model deployment
- Deactivate model deployment
Get model environment
Gets an environment’s details and returns the environment.
curl --request GET \
--url https://api.baseten.co/v1/models/{model_id}/environments/{env_name} \
--header "Authorization: Api-Key $BASETEN_API_KEY"
{
"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,
"status": "BUILDING",
"active_replica_count": 123,
"autoscaling_settings": {
"min_replica": 123,
"max_replica": 123,
"autoscaling_window": 123,
"scale_down_delay": 123,
"concurrency_target": 123
},
"environment": "<string>"
},
"autoscaling_settings": {
"min_replica": 123,
"max_replica": 123,
"autoscaling_window": 123,
"scale_down_delay": 123,
"concurrency_target": 123
},
"promotion_settings": {
"redeploy_on_promotion": true,
"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
}
}Authorizations
You must specify the scheme 'Api-Key' in the Authorization header. For example, Authorization: Api-Key <Your_Api_Key>
Response
Environment for oracles.
Name of the environment
Time the environment was created in ISO 8601 format
Unique identifier of the model
Current deployment of the environment
Unique identifier of the deployment
Time the deployment was created in ISO 8601 format
Name of the deployment
Unique identifier of the model
Whether the deployment is the production deployment of the model
Whether the deployment is the development deployment of the model
Status of the deployment
BUILDING, DEPLOYING, DEPLOY_FAILED, LOADING_MODEL, ACTIVE, UNHEALTHY, BUILD_FAILED, BUILD_STOPPED, DEACTIVATING, INACTIVE, FAILED, UPDATING, SCALED_TO_ZERO, WAKING_UP Number of active replicas
Autoscaling settings for the deployment. If null, the model has not finished deploying
Minimum number of replicas
Maximum number of replicas
Timeframe of traffic considered for autoscaling decisions
Waiting period before scaling down any active replica
Number of requests per replica before scaling up
The environment associated with the deployment
Autoscaling settings for the environment
Minimum number of replicas
Maximum number of replicas
Timeframe of traffic considered for autoscaling decisions
Waiting period before scaling down any active replica
Number of requests per replica before scaling up
Promotion settings for the environment
Whether to deploy on all promotions. Enabling this flag allows model code to safely handle environment-specific logic. When a deployment is promoted, a new deployment will be created with a copy of the image.
true
Whether to ramp up traffic while promoting
true
Duration of the ramp up in seconds
600
Instance type for the environment
Identifier string for the instance type
Display name of the instance type
Memory limit of the instance type in Mebibytes
CPU limit of the instance type in millicpu
Number of GPUs on the instance type
Type of GPU on the instance type
Memory limit of the GPU on the instance type in Mebibytes
Was this page helpful?
curl --request GET \
--url https://api.baseten.co/v1/models/{model_id}/environments/{env_name} \
--header "Authorization: Api-Key $BASETEN_API_KEY"
{
"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,
"status": "BUILDING",
"active_replica_count": 123,
"autoscaling_settings": {
"min_replica": 123,
"max_replica": 123,
"autoscaling_window": 123,
"scale_down_delay": 123,
"concurrency_target": 123
},
"environment": "<string>"
},
"autoscaling_settings": {
"min_replica": 123,
"max_replica": 123,
"autoscaling_window": 123,
"scale_down_delay": 123,
"concurrency_target": 123
},
"promotion_settings": {
"redeploy_on_promotion": true,
"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
}
}