# Pods

## Create pod

> Create pod

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"OpenapiPod","description":"OpenAPI pod V1"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/openapi/v1/pods/create":{"post":{"tags":["OpenapiPod"],"summary":"Create pod","description":"Create pod","operationId":"create_4","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenapiPodCreateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultLong"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}}}}}},"components":{"schemas":{"OpenapiPodCreateRequest":{"type":"object","description":"OpenapiPodCreateRequest","properties":{"imagePublicType":{"type":"string","description":"ImagePublicTypeEnum: PUBLIC, PRIVATE"},"resourceType":{"type":"string","description":"ResourceTypeEnum: GPU,CPU"},"region":{"type":"string","description":"Region"},"regionList":{"type":"array","description":"Region List","items":{"type":"string"},"uniqueItems":true},"podName":{"type":"string","description":"pod nick name"},"image":{"type":"string","description":"image name","maxLength":255,"minLength":1},"imageRegistry":{"type":"string","default":"https://index.docker.io/v1/","description":"image registry url"},"credentialId":{"type":"integer","format":"int64","description":"container registry credential ID"},"imageRegistryUsername":{"type":"string","description":"image registry username"},"imageRegistryToken":{"type":"string","description":"image registry token or password"},"gpuType":{"type":"string","description":"gpu type","minLength":1},"gpuCount":{"type":"integer","format":"int32","description":"gpu count"},"shmInGb":{"type":"integer","format":"int32","description":"shm unit:GB","minimum":1},"minSingleCardRamInGb":{"type":"integer","format":"int32","description":"min single card ram unit: GB","maximum":1536,"minimum":0},"minSingleCardVramInGb":{"type":"integer","format":"int32","description":"min single card vram unit: GB","maximum":1536,"minimum":0},"minSingleCardVcpu":{"type":"integer","format":"int32","description":"min single card vcpu unit: count","minimum":0},"containerVolumeInGb":{"type":"integer","format":"int32","description":"container volume unit:GB"},"persistentVolumeInGb":{"type":"integer","format":"int32","description":"persistent volume unit:GB"},"persistentMountPath":{"type":"string","description":"persistent mount path"},"initializationCommand":{"type":"string","description":"initialization command"},"environmentVars":{"type":"array","description":"image needed environment vars [{\"key\":\"myKey\", \"value\": myValue}]","items":{"$ref":"#/components/schemas/KeyValuePairDTO"}},"expose":{"type":"array","description":"expose ports [{\"port\": 8000, \"protocol\": \"HTTP\"]","items":{"$ref":"#/components/schemas/OpenapiPodExposePortRequest"}},"persistentVolumes":{"type":"array","description":"persistent volumes","items":{"$ref":"#/components/schemas/PersistentVolumesRequest"}}},"required":["gpuType","image"]},"KeyValuePairDTO":{"type":"object","description":"KeyValuePairDTO","properties":{"key":{"type":"string","description":"key","minLength":1},"value":{"type":"string","description":"value","minLength":1}},"required":["key","value"]},"OpenapiPodExposePortRequest":{"type":"object","description":"OpenapiPodExposePortRequest","properties":{"port":{"type":"integer","format":"int32","description":"port","maximum":65535,"minimum":0},"protocol":{"type":"string","description":"protocol"}},"required":["port"]},"PersistentVolumesRequest":{"type":"object","description":"PersistentVolumesRequest","properties":{"id":{"type":"integer","format":"int64","description":"pv id"},"name":{"type":"string","description":"pv name"},"volumeType":{"type":"string","description":"NFS or CloudStorage"},"mountMode":{"type":"string","description":"mountMode"},"volumeSize":{"type":"integer","format":"int32","description":"volumeSize"},"volumePrice":{"type":"number","description":"volume price"},"mountPath":{"type":"string","description":"mount path","minLength":1},"cloudStorageType":{"type":"string","description":"cloud storage type, currently only S3, may support R2 in future"},"systemVolumeType":{"type":"string","description":"System volume type: Local or Ceph. Required when volumeType is System"},"systemVolumeTypeEnum":{"type":"string","enum":["LOCAL","CEPH"]}},"required":["mountPath","volumeType"]},"ResultLong":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"type":"integer","format":"int64","description":"data"}}},"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```

## Pod resume

> Pod resume

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"OpenapiPod","description":"OpenAPI pod V1"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/openapi/v1/pods/resume/{podId}":{"post":{"tags":["OpenapiPod"],"summary":"Pod resume","description":"Pod resume","operationId":"resume","parameters":[{"name":"podId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}}}}}},"components":{"schemas":{"ResultVoid":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}},"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```

## Pod pause

> Pod pause

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"OpenapiPod","description":"OpenAPI pod V1"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/openapi/v1/pods/pause/{podId}":{"post":{"tags":["OpenapiPod"],"summary":"Pod pause","description":"Pod pause","operationId":"pause_1","parameters":[{"name":"podId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}}}}}},"components":{"schemas":{"ResultVoid":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}},"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```

## Pod delete

> Pod delete

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"OpenapiPod","description":"OpenAPI pod V1"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/openapi/v1/pods/{podId}":{"delete":{"tags":["OpenapiPod"],"summary":"Pod delete","description":"Pod delete","operationId":"delete_1","parameters":[{"name":"podId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVoid"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}}}}}},"components":{"schemas":{"ResultVoid":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}},"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```

## Get pod detail

> Fetch detailed information of a specific pod by its ID

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"OpenapiPod","description":"OpenAPI pod V1"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/openapi/v1/pods/{podId}":{"get":{"tags":["OpenapiPod"],"summary":"Get pod detail","description":"Fetch detailed information of a specific pod by its ID","operationId":"getPodDetail","parameters":[{"name":"podId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultOpenapiPodListDetailResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}}}}}},"components":{"schemas":{"ResultOpenapiPodListDetailResponse":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"$ref":"#/components/schemas/OpenapiPodListDetailResponse","description":"data"}}},"OpenapiPodListDetailResponse":{"type":"object","description":"OpenapiPodListDetailResponse","properties":{"id":{"type":"integer","format":"int64","description":"id"},"orgId":{"type":"integer","format":"int64","description":"org id"},"applicantId":{"type":"integer","format":"int64","description":"The applicant id"},"podName":{"type":"string","description":"pod nick name"},"imageId":{"type":"integer","format":"int64","description":"image id"},"officialImage":{"type":"string","description":"ImageSourceEnum: OFFICIAL, CUSTOM","enum":["OFFICIAL","CUSTOM"]},"imagePublicType":{"type":"string","description":"ImagePublicTypeEnum: PUBLIC, PRIVATE","enum":["PUBLIC","PRIVATE"]},"image":{"type":"string","description":"image name"},"imageRegistry":{"type":"string","description":"image registry url"},"imageRegistryUsername":{"type":"string","description":"image registry username"},"resourceType":{"type":"string","description":"ResourceTypeEnum: GPU, CPU","enum":["GPU","CPU"]},"gpuType":{"type":"string","description":"gpu type： RTX_4090_24G"},"gpuDisplayName":{"type":"string","description":"gpu display name"},"gpuCount":{"type":"integer","format":"int32","description":"gpu count"},"shmInGb":{"type":"integer","format":"int32","description":"shm unit:GB"},"singleCardVramInGb":{"type":"integer","format":"int32","description":"single card vram unit: GB"},"singleCardRamInGb":{"type":"integer","format":"int32","description":"single card ram unit: GB"},"singleCardVcpu":{"type":"integer","format":"int32","description":"single card vcpu count"},"location":{"type":"string","description":"location"},"region":{"type":"string","description":"region"},"cloudType":{"type":"string","description":"CloudTypeEnum: SECURE, COMMUNITY","enum":["SECURE","COMMUNITY"]},"containerVolumeInGb":{"type":"integer","format":"int32","description":"container volume unit:GB"},"persistentVolumeInGb":{"type":"integer","format":"int32","description":"persistent volume unit:GB"},"persistentMountPath":{"type":"string","description":"persistent mount path"},"networkUploadMbps":{"type":"number","description":"network upload"},"networkDownloadMbps":{"type":"number","description":"network download"},"diskReadSpeedMbps":{"type":"number","description":"disk read speed"},"diskWriteSpeedMbps":{"type":"number","description":"disk write speed"},"singleCardPrice":{"type":"number","description":"gpu single card price"},"persistentVolumePrice":{"type":"number","description":"persistent volume price"},"containerVolumePrice":{"type":"number","description":"container volume price"},"initializationCommand":{"type":"string","description":"initialization command"},"environmentVars":{"type":"array","description":"image needed environment vars [{\"key\":\"myKey\", \"value\": myValue}]","items":{"$ref":"#/components/schemas/KeyValuePairDTO"}},"expose":{"type":"array","description":"expose ports","items":{"$ref":"#/components/schemas/OpenapiPodExposePortResponse"}},"sshCmd":{"type":"string","description":"ssh cmd"},"status":{"type":"string","description":"PodStatusEnum","enum":["INITIALIZE","RUNNING","PAUSING","PAUSED","TERMINATING","TERMINATED","FAILED","PENDING","PREPARING"]},"createdAt":{"type":"string","format":"date-time","description":"create time"},"updatedAt":{"type":"string","format":"date-time","description":"update time"},"persistentVolumes":{"type":"array","description":"persistent volumes","items":{"$ref":"#/components/schemas/PersistentVolumesResponse"}},"internalIp":{"type":"string","description":"internal ip"}}},"KeyValuePairDTO":{"type":"object","description":"KeyValuePairDTO","properties":{"key":{"type":"string","description":"key","minLength":1},"value":{"type":"string","description":"value","minLength":1}},"required":["key","value"]},"OpenapiPodExposePortResponse":{"type":"object","description":"OpenapiPodExposePortResponse","properties":{"port":{"type":"integer","format":"int32","description":"port","maximum":65535,"minimum":0},"proxyPort":{"type":"integer","format":"int32","description":"proxy port"},"protocol":{"type":"string","description":"protocol"},"host":{"type":"string","description":"host"},"healthy":{"type":"boolean","description":"healthy"},"ingressUrl":{"type":"string","description":"ingress url"},"serviceName":{"type":"string","description":"service name"}},"required":["port"]},"PersistentVolumesResponse":{"type":"object","description":"PersistentVolumesResponse","properties":{"id":{"type":"integer","format":"int64","description":"pv id"},"name":{"type":"string","description":"pv name"},"volumeType":{"type":"string","description":"Ceph or CloudStorage"},"volumeSize":{"type":"integer","format":"int32","description":"volumeSize"},"volumePrice":{"type":"number","description":"volume price"},"mountPath":{"type":"string","description":"mount path","minLength":1},"cloudStorageType":{"type":"string","description":"cloud storage type, currently only S3, may support R2 in future"},"systemVolumeType":{"type":"string","description":"System volume type: Local or Ceph (only for System volumeType)"}},"required":["mountPath","volumeType"]},"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```

## Get Org pod list

> Get Org pod list

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"OpenapiPod","description":"OpenAPI pod V1"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/openapi/v1/pods/list":{"get":{"tags":["OpenapiPod"],"summary":"Get Org pod list","description":"Get Org pod list","operationId":"getPodList_1","parameters":[{"name":"regionList","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"statusList","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultListOpenapiPodListDetailResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}}}}}},"components":{"schemas":{"ResultListOpenapiPodListDetailResponse":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"type":"array","description":"data","items":{"$ref":"#/components/schemas/OpenapiPodListDetailResponse"}}}},"OpenapiPodListDetailResponse":{"type":"object","description":"OpenapiPodListDetailResponse","properties":{"id":{"type":"integer","format":"int64","description":"id"},"orgId":{"type":"integer","format":"int64","description":"org id"},"applicantId":{"type":"integer","format":"int64","description":"The applicant id"},"podName":{"type":"string","description":"pod nick name"},"imageId":{"type":"integer","format":"int64","description":"image id"},"officialImage":{"type":"string","description":"ImageSourceEnum: OFFICIAL, CUSTOM","enum":["OFFICIAL","CUSTOM"]},"imagePublicType":{"type":"string","description":"ImagePublicTypeEnum: PUBLIC, PRIVATE","enum":["PUBLIC","PRIVATE"]},"image":{"type":"string","description":"image name"},"imageRegistry":{"type":"string","description":"image registry url"},"imageRegistryUsername":{"type":"string","description":"image registry username"},"resourceType":{"type":"string","description":"ResourceTypeEnum: GPU, CPU","enum":["GPU","CPU"]},"gpuType":{"type":"string","description":"gpu type： RTX_4090_24G"},"gpuDisplayName":{"type":"string","description":"gpu display name"},"gpuCount":{"type":"integer","format":"int32","description":"gpu count"},"shmInGb":{"type":"integer","format":"int32","description":"shm unit:GB"},"singleCardVramInGb":{"type":"integer","format":"int32","description":"single card vram unit: GB"},"singleCardRamInGb":{"type":"integer","format":"int32","description":"single card ram unit: GB"},"singleCardVcpu":{"type":"integer","format":"int32","description":"single card vcpu count"},"location":{"type":"string","description":"location"},"region":{"type":"string","description":"region"},"cloudType":{"type":"string","description":"CloudTypeEnum: SECURE, COMMUNITY","enum":["SECURE","COMMUNITY"]},"containerVolumeInGb":{"type":"integer","format":"int32","description":"container volume unit:GB"},"persistentVolumeInGb":{"type":"integer","format":"int32","description":"persistent volume unit:GB"},"persistentMountPath":{"type":"string","description":"persistent mount path"},"networkUploadMbps":{"type":"number","description":"network upload"},"networkDownloadMbps":{"type":"number","description":"network download"},"diskReadSpeedMbps":{"type":"number","description":"disk read speed"},"diskWriteSpeedMbps":{"type":"number","description":"disk write speed"},"singleCardPrice":{"type":"number","description":"gpu single card price"},"persistentVolumePrice":{"type":"number","description":"persistent volume price"},"containerVolumePrice":{"type":"number","description":"container volume price"},"initializationCommand":{"type":"string","description":"initialization command"},"environmentVars":{"type":"array","description":"image needed environment vars [{\"key\":\"myKey\", \"value\": myValue}]","items":{"$ref":"#/components/schemas/KeyValuePairDTO"}},"expose":{"type":"array","description":"expose ports","items":{"$ref":"#/components/schemas/OpenapiPodExposePortResponse"}},"sshCmd":{"type":"string","description":"ssh cmd"},"status":{"type":"string","description":"PodStatusEnum","enum":["INITIALIZE","RUNNING","PAUSING","PAUSED","TERMINATING","TERMINATED","FAILED","PENDING","PREPARING"]},"createdAt":{"type":"string","format":"date-time","description":"create time"},"updatedAt":{"type":"string","format":"date-time","description":"update time"},"persistentVolumes":{"type":"array","description":"persistent volumes","items":{"$ref":"#/components/schemas/PersistentVolumesResponse"}},"internalIp":{"type":"string","description":"internal ip"}}},"KeyValuePairDTO":{"type":"object","description":"KeyValuePairDTO","properties":{"key":{"type":"string","description":"key","minLength":1},"value":{"type":"string","description":"value","minLength":1}},"required":["key","value"]},"OpenapiPodExposePortResponse":{"type":"object","description":"OpenapiPodExposePortResponse","properties":{"port":{"type":"integer","format":"int32","description":"port","maximum":65535,"minimum":0},"proxyPort":{"type":"integer","format":"int32","description":"proxy port"},"protocol":{"type":"string","description":"protocol"},"host":{"type":"string","description":"host"},"healthy":{"type":"boolean","description":"healthy"},"ingressUrl":{"type":"string","description":"ingress url"},"serviceName":{"type":"string","description":"service name"}},"required":["port"]},"PersistentVolumesResponse":{"type":"object","description":"PersistentVolumesResponse","properties":{"id":{"type":"integer","format":"int64","description":"pv id"},"name":{"type":"string","description":"pv name"},"volumeType":{"type":"string","description":"Ceph or CloudStorage"},"volumeSize":{"type":"integer","format":"int32","description":"volumeSize"},"volumePrice":{"type":"number","description":"volume price"},"mountPath":{"type":"string","description":"mount path","minLength":1},"cloudStorageType":{"type":"string","description":"cloud storage type, currently only S3, may support R2 in future"},"systemVolumeType":{"type":"string","description":"System volume type: Local or Ceph (only for System volumeType)"}},"required":["mountPath","volumeType"]},"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.yottalabs.ai/api-and-sdk/api-reference-v1/pods.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.