Pods

Create Pod

post

Create a new pod

Authorizations

x-api-key

x-api-keystringRequired

Body

application/json

Pod Create Request v2

regionsstring[]Optional

Acceptable region codes

namestring · min: 1 · max: 255Required

Pod name

imagestring · min: 1 · max: 255Required

Docker image name

Example: pytorch/pytorch:2.0.0-cuda11.7-cudnn8-runtime

containerRegistryAuthIdinteger · int64Optional

Container registry auth ID

imageRegistrystring · max: 255Optional

Image registry URL

imagePublicTypestringOptional

Image type: PUBLIC or PRIVATE

Example: PUBLIC

resourceTypestringOptional

Resource type: GPU or CPU

Example: GPU

gpuTypestring · min: 1Required

GPU type

Example: RTX_4090_24G

gpuCountinteger · int32Required

GPU count (must be power of 2)

Example: 1

shmInGbinteger · int32Optional

Shared memory size in GB

minSingleCardRamInGbinteger · int32Optional

Minimum single card RAM in GB

minSingleCardVramInGbinteger · int32Optional

Minimum single card VRAM in GB

minSingleCardVcpuinteger · int32Optional

Minimum single card vCPU count

containerVolumeInGbinteger · int32Optional

Container volume size in GB

persistentVolumeInGbinteger · int32Optional

Persistent volume size in GB

initializationCommandstringOptional

Initialization command

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

10000

Pod created successfully

*/*

10001

Invalid request parameters

*/*

post

/v2/pods

HTTPcURLJavaScriptPython

POST /v2/pods HTTP/1.1
Host: api.yottalabs.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 699

{
  "regions": [
    "text"
  ],
  "name": "text",
  "image": "pytorch/pytorch:2.0.0-cuda11.7-cudnn8-runtime",
  "containerRegistryAuthId": 1,
  "imageRegistry": "text",
  "imagePublicType": "PUBLIC",
  "resourceType": "GPU",
  "gpuType": "RTX_4090_24G",
  "gpuCount": 1,
  "shmInGb": 1,
  "minSingleCardRamInGb": 1,
  "minSingleCardVramInGb": 1,
  "minSingleCardVcpu": 1,
  "containerVolumeInGb": 1,
  "persistentVolumeInGb": 1,
  "initializationCommand": "text",
  "environmentVars": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "expose": [
    {
      "port": 1,
      "protocol": "text"
    }
  ],
  "persistentVolumes": [
    {
      "id": 1,
      "name": "text",
      "volumeType": "text",
      "mountMode": "text",
      "volumeSize": 1,
      "volumePrice": 1,
      "mountPath": "text",
      "cloudStorageType": "text",
      "systemVolumeType": "text",
      "systemVolumeTypeEnum": "LOCAL"
    }
  ]
}

{
  "message": "text",
  "code": 1,
  "data": null
}

Resume Pod

post

Resume a paused pod

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

10000

Pod resumed

*/*

13000

Pod not found

*/*

post

/v2/pods/{id}/resume

HTTPcURLJavaScriptPython

POST /v2/pods/{id}/resume HTTP/1.1
Host: api.yottalabs.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "text",
  "code": 1,
  "data": null
}

Pause Pod

post

Pause a running pod

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

10000

Pod paused

*/*

13000

Pod not found

*/*

post

/v2/pods/{id}/pause

HTTPcURLJavaScriptPython

POST /v2/pods/{id}/pause HTTP/1.1
Host: api.yottalabs.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "text",
  "code": 1,
  "data": null
}

Delete Pod

delete

Delete a pod

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

10000

Pod deleted

*/*

13000

Pod not found

*/*

delete

/v2/pods/{id}

HTTPcURLJavaScriptPython

DELETE /v2/pods/{id} HTTP/1.1
Host: api.yottalabs.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "text",
  "code": 1,
  "data": null
}

Get Pod

get

Get details of a specific pod

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idinteger · int64Required

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

400

Bad Request

*/*

500

Internal Server Error

*/*

10000

Pod found

*/*

13000

Pod not found

*/*

get

/v2/pods/{id}

HTTPcURLJavaScriptPython

GET /v2/pods/{id} HTTP/1.1
Host: api.yottalabs.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "text",
  "code": 1,
  "data": null
}

List Pods

get

Get all pods for your organization

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

regionListstring[]Optional

statusListstring[]Optional

Filter by status names, e.g. RUNNING, PAUSED, TERMINATED

Responses

200

Success, returns list of pods

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

500

Internal Server Error

*/*

10000

Success

*/*

get

/v2/pods

HTTPcURLJavaScriptPython

GET /v2/pods HTTP/1.1
Host: api.yottalabs.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "text",
  "code": 1,
  "data": [
    {
      "id": 1,
      "orgId": 1,
      "applicantId": 1,
      "name": "text",
      "imageId": 1,
      "officialImage": "OFFICIAL",
      "imagePublicType": "PUBLIC",
      "image": "text",
      "imageRegistry": "text",
      "imageRegistryUsername": "text",
      "resourceType": "GPU",
      "gpuType": "text",
      "gpuDisplayName": "text",
      "gpuCount": 1,
      "shmInGb": 1,
      "singleCardVramInGb": 1,
      "singleCardRamInGb": 1,
      "singleCardVcpu": 1,
      "location": "text",
      "region": "text",
      "cloudType": "SECURE",
      "containerVolumeInGb": 1,
      "persistentVolumeInGb": 1,
      "persistentMountPath": "text",
      "networkUploadMbps": 1,
      "networkDownloadMbps": 1,
      "diskReadSpeedMbps": 1,
      "diskWriteSpeedMbps": 1,
      "singleCardPrice": 1,
      "persistentVolumePrice": 1,
      "containerVolumePrice": 1,
      "initializationCommand": "text",
      "environmentVars": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "expose": [
        {
          "port": 1,
          "proxyPort": 1,
          "protocol": "text",
          "host": "text",
          "healthy": true,
          "ingressUrl": "text",
          "serviceName": "text"
        }
      ],
      "sshCmd": "text",
      "status": "INITIALIZING",
      "createdAt": 1,
      "updatedAt": 1,
      "persistentVolumes": [
        {
          "id": 1,
          "name": "text",
          "volumeType": "text",
          "volumeSize": 1,
          "volumePrice": 1,
          "mountPath": "text",
          "cloudStorageType": "text",
          "systemVolumeType": "text"
        }
      ],
      "internalIp": "text",
      "desiredState": "RUNNING"
    }
  ]
}