Create model environment

Authorizations

Authorization

string

headerrequired

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

autoscaling_settings

object | null

Autoscaling settings for the environment

autoscaling_settings.min_replica

integer | null

Minimum number of replicas

autoscaling_settings.max_replica

integer | null

Maximum number of replicas

autoscaling_settings.autoscaling_window

integer | null

Timeframe of traffic considered for autoscaling decisions

autoscaling_settings.scale_down_delay

integer | null

Waiting period before scaling down any active replica

autoscaling_settings.concurrency_target

integer | null

Number of requests per replica before scaling up

promotion_settings

object | null

Promotion settings for the environment

promotion_settings.redeploy_on_promotion

boolean | null

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.

promotion_settings.ramp_up_while_promoting

boolean | null

Whether to ramp up traffic while promoting

promotion_settings.ramp_up_duration_seconds

integer | null

Duration of the ramp up in seconds

Response

200 - application/json

Environment for oracles.

name

string

required

Name of the environment

created_at

string

required

Time the environment was created in ISO 8601 format

model_id

string

required

Unique identifier of the model

current_deployment

object | null

required

Current deployment of the environment

current_deployment.id

string

required

Unique identifier of the deployment

current_deployment.created_at

string

required

Time the deployment was created in ISO 8601 format

current_deployment.name

string

required

Name of the deployment

current_deployment.model_id

string

required

Unique identifier of the model

current_deployment.is_production

boolean

required

Whether the deployment is the production deployment of the model

current_deployment.is_development

boolean

required

Whether the deployment is the development deployment of the model

current_deployment.status

enum<string>

required

Status of the deployment

Available options:

BUILDING,

DEPLOYING,

DEPLOY_FAILED,

LOADING_MODEL,

ACTIVE,

UNHEALTHY,

BUILD_FAILED,

BUILD_STOPPED,

DEACTIVATING,

INACTIVE,

FAILED,

UPDATING,

SCALED_TO_ZERO,

WAKING_UP

current_deployment.active_replica_count

integer

required

Number of active replicas

current_deployment.autoscaling_settings

object | null

required

Autoscaling settings for the deployment. If null, the model has not finished deploying

current_deployment.autoscaling_settings.min_replica

integer

required

Minimum number of replicas

current_deployment.autoscaling_settings.max_replica

integer

required

Maximum number of replicas

current_deployment.autoscaling_settings.autoscaling_window

integer | null

required

Timeframe of traffic considered for autoscaling decisions

current_deployment.autoscaling_settings.scale_down_delay

integer | null

required

Waiting period before scaling down any active replica

current_deployment.autoscaling_settings.concurrency_target

integer

required

Number of requests per replica before scaling up

current_deployment.environment

string | null

required

The environment associated with the deployment

autoscaling_settings

object

required

Autoscaling settings for the environment

autoscaling_settings.min_replica

integer

required

Minimum number of replicas

autoscaling_settings.max_replica

integer

required

Maximum number of replicas

autoscaling_settings.autoscaling_window

integer | null

required

Timeframe of traffic considered for autoscaling decisions

autoscaling_settings.scale_down_delay

integer | null

required

Waiting period before scaling down any active replica

autoscaling_settings.concurrency_target

integer

required

Number of requests per replica before scaling up

promotion_settings

object

required

Promotion settings for the environment

promotion_settings.redeploy_on_promotion

boolean | null

default: false

promotion_settings.ramp_up_while_promoting

boolean | null

default: false

Whether to ramp up traffic while promoting

promotion_settings.ramp_up_duration_seconds

integer | null

default: 600

Duration of the ramp up in seconds

Inference API

Async Inference API

Management API

Chains Inference API

Create model environment

Authorizations

Path Parameters

Body

Response