Skip to main content
POST
Python

Authorizations

Authorization
string
header
required

Modular Cloud API token. Obtain from the API Tokens page.

Body

application/json
name
string
required

URL-safe slug, max 50 characters. Immutable after creation.

Maximum string length: 50
Pattern: ^[a-z][a-z0-9-]{0,49}$
model_id
string
required

Model identifier from the console Models page. Immutable after creation.

Example:

"google/gemma-4-31B-it"

configuration
object
required
display_name
string

Human-readable label for the deployment.

region_group
enum<string>

Geographic region group for the deployment.

Available options:
us,
eu,
global
scaling
object

Response

200 - application/json

Deployment created. endpoint_url is null while provisioning.

name
string
required

Deployment name (the URL-safe slug).

deployment_id
string
required

Unique deployment identifier.

model_id
string
required

Model identifier.

status
enum<string>
required

Current lifecycle status of a deployment.

Available options:
unknown,
non-deployed,
deploying,
running,
unhealthy,
failed,
updating,
scaling,
terminating,
terminated,
image-building,
image-build-failed,
model-seed-failed,
image-build-succeeded,
scaled-to-zero,
scaling-up,
scaling-down
scaling
object
required
configuration
object
required
created_at
string<date-time>
required
created_by
string
required
updated_at
string<date-time>
required
updated_by
string
required
display_name
string
endpoint_url
string | null

Inference endpoint URL. Null until the deployment is running.

region_group
string
replicas
object