Skip to main content
POST
Create Instance

Headers

Content-Type
string
required

Allowed value: application/json.

Authorization
string
required

Bearer authentication format, e.g.: Bearer {{API_KEY}}.

Body

application/json
name
string
required

Instance name. String, length: 1-255 characters.

Example:

"example-instance"

product_id
string
required

Product ID.

Example:

"product-id"

image
string
required

Image address. String, length: 1-500 characters.

Example:

"registry.example.com/namespace/image:tag"

billing
object
required

Billing configuration.

resource
object
required

Resource configuration.

type
enum<string>

Instance type. Allowed values: gpu, cpu. Default: gpu.

Available options:
gpu,
cpu
registry_auth_id
string

Saved registry authentication ID. String, length: 0-255 characters.

Example:

"registry-auth-id"

entrypoint
string

Container entrypoint.

Example:

""

command
string

Container startup command.

Example:

""

envs
object[]

Environment variable list.

ports
object[]

Exposed port list.

network
object

VPC network configuration.

volumes
object[]

Data disk / network storage mounts.

candidate_regions
string[]

Candidate regions for scheduling. The instance is finally scheduled to one of them.

Example:
tools
object

Instance tool configuration. Currently only Jupyter is supported.

auto_migrate
object

Auto-migrate configuration.

Response

200 - application/json

OK

id
string

ID of the created instance

Example:

"ca338f12f3"

Last modified on June 23, 2026