Skip to main content
POST
/
v1
/
containers
Container Rentals Start
curl --request POST \
  --url https://api.example.com/v1/containers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "gpu_config": "<string>",
  "container_image": "<string>",
  "cloud_init_user_data": "<string>"
}
'
{
  "container_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
xi-api-key
string | null

Body

application/json
​
name
string
required

Container Name

Required string length: 1 - 64
​
gpu_config
string
required

GPU config

Minimum string length: 1
​
container_image
string
required

Container Image

Minimum string length: 1
​
cloud_init_user_data
string
required

Cloud Init User Data

Required string length: 1 - 32000

Response

Successful Response

​
container_id
string
required

Container Id