# VMs

## Create VM

> Create a new virtual machine

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"API v2","description":"Yotta API v2 - RESTful endpoints"},{"name":"VMs v2","description":"Virtual Machines API v2"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/v2/vms":{"post":{"tags":["VMs v2","API v2"],"summary":"Create VM","description":"Create a new virtual machine","operationId":"createVm","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VmV2CreateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"10000":{"description":"VM created successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVmV2Response"}}}},"10001":{"description":"Invalid request parameters","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}}}}},"components":{"schemas":{"VmV2CreateRequest":{"type":"object","description":"VM Create Request v2","properties":{"vmTypeId":{"type":"integer","format":"int32","description":"Machine model type ID"},"region":{"type":"string","description":"Region code","minLength":1},"name":{"type":"string","description":"VM nickname","minLength":1},"isSpot":{"type":"boolean","description":"Spot instance flag: true=spot, false=on-demand"},"volumeMountPaths":{"type":"object","additionalProperties":{"type":"string"},"description":"Volume mount paths mapping: volumeId -> mountPath. If not specified, default path will be used."}},"required":["isSpot","name","region","vmTypeId"]},"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}},"ResultVmV2Response":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"$ref":"#/components/schemas/VmV2Response","description":"data"}}},"VmV2Response":{"type":"object","description":"VM Response v2","properties":{"id":{"type":"integer","format":"int64","description":"VM ID"},"orgId":{"type":"string","description":"Organization ID"},"name":{"type":"string","description":"VM nickname"},"gpuDisplayName":{"type":"string","description":"GPU display name"},"ipAddress":{"type":"string","description":"Public IP address"},"domainName":{"type":"string","description":"Domain name"},"cpuCores":{"type":"integer","format":"int32","description":"CPU cores"},"memoryInGb":{"type":"string","description":"Memory in GB"},"gpuCount":{"type":"integer","format":"int32","description":"GPU count"},"gpuMemoryInGb":{"type":"string","description":"GPU memory in GB"},"region":{"type":"string","description":"Region code"},"storageInGb":{"type":"string","description":"Storage in GB"},"notebookUrl":{"type":"string","description":"Jupyter notebook URL"},"sshTemplate":{"type":"string","description":"SSH connection template"},"status":{"type":"string","description":"VM status","enum":["INITIALIZING","RUNNING","STOPPING","STOPPED","TERMINATING","TERMINATED","FAILED"]},"createdAt":{"type":"integer","format":"int64","description":"Creation timestamp (epoch milliseconds)"},"terminatedAt":{"type":"integer","format":"int64","description":"Termination timestamp (epoch milliseconds)"},"updatedAt":{"type":"integer","format":"int64","description":"Last update timestamp (epoch milliseconds)"},"osInfo":{"type":"string","description":"Operating system info"},"gpuType":{"type":"string","description":"GPU type"},"isSpot":{"type":"boolean","description":"Spot instance flag: true=spot, false=on-demand"}}},"Result":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```

## Update VM

> Update an existing VM (partial update)

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"API v2","description":"Yotta API v2 - RESTful endpoints"},{"name":"VMs v2","description":"Virtual Machines API v2"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/v2/vms/{id}":{"patch":{"tags":["VMs v2","API v2"],"summary":"Update VM","description":"Update an existing VM (partial update)","operationId":"updateVm","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VmV2UpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"10000":{"description":"VM updated","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVmV2Response"}}}},"11000":{"description":"VM not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}}}}},"components":{"schemas":{"VmV2UpdateRequest":{"type":"object","description":"VM Update Request v2","properties":{"name":{"type":"string","description":"VM nickname","maxLength":255,"minLength":1}}},"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}},"ResultVmV2Response":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"$ref":"#/components/schemas/VmV2Response","description":"data"}}},"VmV2Response":{"type":"object","description":"VM Response v2","properties":{"id":{"type":"integer","format":"int64","description":"VM ID"},"orgId":{"type":"string","description":"Organization ID"},"name":{"type":"string","description":"VM nickname"},"gpuDisplayName":{"type":"string","description":"GPU display name"},"ipAddress":{"type":"string","description":"Public IP address"},"domainName":{"type":"string","description":"Domain name"},"cpuCores":{"type":"integer","format":"int32","description":"CPU cores"},"memoryInGb":{"type":"string","description":"Memory in GB"},"gpuCount":{"type":"integer","format":"int32","description":"GPU count"},"gpuMemoryInGb":{"type":"string","description":"GPU memory in GB"},"region":{"type":"string","description":"Region code"},"storageInGb":{"type":"string","description":"Storage in GB"},"notebookUrl":{"type":"string","description":"Jupyter notebook URL"},"sshTemplate":{"type":"string","description":"SSH connection template"},"status":{"type":"string","description":"VM status","enum":["INITIALIZING","RUNNING","STOPPING","STOPPED","TERMINATING","TERMINATED","FAILED"]},"createdAt":{"type":"integer","format":"int64","description":"Creation timestamp (epoch milliseconds)"},"terminatedAt":{"type":"integer","format":"int64","description":"Termination timestamp (epoch milliseconds)"},"updatedAt":{"type":"integer","format":"int64","description":"Last update timestamp (epoch milliseconds)"},"osInfo":{"type":"string","description":"Operating system info"},"gpuType":{"type":"string","description":"GPU type"},"isSpot":{"type":"boolean","description":"Spot instance flag: true=spot, false=on-demand"}}},"Result":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```

## Terminate VM

> Terminate a virtual machine

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"API v2","description":"Yotta API v2 - RESTful endpoints"},{"name":"VMs v2","description":"Virtual Machines API v2"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/v2/vms/{id}":{"delete":{"tags":["VMs v2","API v2"],"summary":"Terminate VM","description":"Terminate a virtual machine","operationId":"terminateVm","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"10000":{"description":"VM terminated","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultBoolean"}}}},"11000":{"description":"VM not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}},"11001":{"description":"VM status invalid","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}},"11002":{"description":"No terminate permissions","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}},"12001":{"description":"Resource status invalid","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}}}}},"components":{"schemas":{"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}},"ResultBoolean":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"type":"boolean","description":"data"}}},"Result":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```

## Get VM

> Get details of a specific virtual machine

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"API v2","description":"Yotta API v2 - RESTful endpoints"},{"name":"VMs v2","description":"Virtual Machines API v2"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/v2/vms/{id}":{"get":{"tags":["VMs v2","API v2"],"summary":"Get VM","description":"Get details of a specific virtual machine","operationId":"getVm","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"10000":{"description":"VM found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultVmV2Response"}}}},"11000":{"description":"VM not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Result"}}}}}}}},"components":{"schemas":{"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}},"ResultVmV2Response":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"$ref":"#/components/schemas/VmV2Response","description":"data"}}},"VmV2Response":{"type":"object","description":"VM Response v2","properties":{"id":{"type":"integer","format":"int64","description":"VM ID"},"orgId":{"type":"string","description":"Organization ID"},"name":{"type":"string","description":"VM nickname"},"gpuDisplayName":{"type":"string","description":"GPU display name"},"ipAddress":{"type":"string","description":"Public IP address"},"domainName":{"type":"string","description":"Domain name"},"cpuCores":{"type":"integer","format":"int32","description":"CPU cores"},"memoryInGb":{"type":"string","description":"Memory in GB"},"gpuCount":{"type":"integer","format":"int32","description":"GPU count"},"gpuMemoryInGb":{"type":"string","description":"GPU memory in GB"},"region":{"type":"string","description":"Region code"},"storageInGb":{"type":"string","description":"Storage in GB"},"notebookUrl":{"type":"string","description":"Jupyter notebook URL"},"sshTemplate":{"type":"string","description":"SSH connection template"},"status":{"type":"string","description":"VM status","enum":["INITIALIZING","RUNNING","STOPPING","STOPPED","TERMINATING","TERMINATED","FAILED"]},"createdAt":{"type":"integer","format":"int64","description":"Creation timestamp (epoch milliseconds)"},"terminatedAt":{"type":"integer","format":"int64","description":"Termination timestamp (epoch milliseconds)"},"updatedAt":{"type":"integer","format":"int64","description":"Last update timestamp (epoch milliseconds)"},"osInfo":{"type":"string","description":"Operating system info"},"gpuType":{"type":"string","description":"GPU type"},"isSpot":{"type":"boolean","description":"Spot instance flag: true=spot, false=on-demand"}}},"Result":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```

## List VMs

> Get all VMs for your organization with pagination

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"API v2","description":"Yotta API v2 - RESTful endpoints"},{"name":"VMs v2","description":"Virtual Machines API v2"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/v2/vms":{"get":{"tags":["VMs v2","API v2"],"summary":"List VMs","description":"Get all VMs for your organization with pagination","operationId":"listVms","parameters":[{"name":"page","in":"query","description":"Page number (1-based)","required":false,"schema":{"type":"integer","format":"int64","default":1}},{"name":"size","in":"query","description":"Page size","required":false,"schema":{"type":"integer","format":"int64","default":10}},{"name":"status","in":"query","description":"Filter by status","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success, returns paginated list of VMs","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultV2PageResponseVmV2Response"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"10000":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultV2PageResponseVmV2Response"}}}}}}}},"components":{"schemas":{"ResultV2PageResponseVmV2Response":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"$ref":"#/components/schemas/V2PageResponseVmV2Response","description":"data"}}},"V2PageResponseVmV2Response":{"type":"object","description":"Paginated Response","properties":{"items":{"type":"array","description":"List of items in the current page","items":{"$ref":"#/components/schemas/VmV2Response"}},"page":{"type":"integer","format":"int64","description":"Current page number (1-based)"},"size":{"type":"integer","format":"int64","description":"Number of items per page"},"total":{"type":"integer","format":"int64","description":"Total number of items across all pages"},"pages":{"type":"integer","format":"int64","description":"Total number of pages"}}},"VmV2Response":{"type":"object","description":"VM Response v2","properties":{"id":{"type":"integer","format":"int64","description":"VM ID"},"orgId":{"type":"string","description":"Organization ID"},"name":{"type":"string","description":"VM nickname"},"gpuDisplayName":{"type":"string","description":"GPU display name"},"ipAddress":{"type":"string","description":"Public IP address"},"domainName":{"type":"string","description":"Domain name"},"cpuCores":{"type":"integer","format":"int32","description":"CPU cores"},"memoryInGb":{"type":"string","description":"Memory in GB"},"gpuCount":{"type":"integer","format":"int32","description":"GPU count"},"gpuMemoryInGb":{"type":"string","description":"GPU memory in GB"},"region":{"type":"string","description":"Region code"},"storageInGb":{"type":"string","description":"Storage in GB"},"notebookUrl":{"type":"string","description":"Jupyter notebook URL"},"sshTemplate":{"type":"string","description":"SSH connection template"},"status":{"type":"string","description":"VM status","enum":["INITIALIZING","RUNNING","STOPPING","STOPPED","TERMINATING","TERMINATED","FAILED"]},"createdAt":{"type":"integer","format":"int64","description":"Creation timestamp (epoch milliseconds)"},"terminatedAt":{"type":"integer","format":"int64","description":"Termination timestamp (epoch milliseconds)"},"updatedAt":{"type":"integer","format":"int64","description":"Last update timestamp (epoch milliseconds)"},"osInfo":{"type":"string","description":"Operating system info"},"gpuType":{"type":"string","description":"GPU type"},"isSpot":{"type":"boolean","description":"Spot instance flag: true=spot, false=on-demand"}}},"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```

## Get VM Types

> Get all available VM types (GPU models) and their regional availability

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"API v2","description":"Yotta API v2 - RESTful endpoints"},{"name":"VMs v2","description":"Virtual Machines API v2"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/v2/vms/types":{"get":{"tags":["VMs v2","API v2"],"summary":"Get VM Types","description":"Get all available VM types (GPU models) and their regional availability","operationId":"getVmTypes","responses":{"200":{"description":"Success, returns list of GPU types with regional availability","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultListVmV2GpuTypeResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"10000":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultListVmV2GpuTypeResponse"}}}}}}}},"components":{"schemas":{"ResultListVmV2GpuTypeResponse":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"type":"array","description":"data","items":{"$ref":"#/components/schemas/VmV2GpuTypeResponse"}}}},"VmV2GpuTypeResponse":{"type":"object","description":"GPU type with regional availability","properties":{"gpuType":{"type":"string","description":"GPU model name (e.g. H100, RTX 4090)"},"regions":{"type":"array","description":"Regional availability for this GPU type","items":{"$ref":"#/components/schemas/VmV2RegionResponse"}}}},"VmV2RegionResponse":{"type":"object","description":"Region with available VM types","properties":{"region":{"type":"string","description":"Region code"},"types":{"type":"array","description":"Available VM types in this region","items":{"$ref":"#/components/schemas/VmV2TypeItemResponse"}}}},"VmV2TypeItemResponse":{"type":"object","description":"VM type item","properties":{"vmTypeId":{"type":"integer","format":"int32","description":"VM type ID, used when creating a VM"},"gpuCount":{"type":"integer","format":"int32","description":"Number of GPU cards"},"pricePerHour":{"type":"string","description":"On-demand price per hour (USD)"},"supportSpot":{"type":"boolean","description":"Whether spot instances are supported"},"spotPricePerHour":{"type":"string","description":"Spot price per hour (USD), present only when supportSpot is true"},"currency":{"type":"string","description":"Currency"},"displayName":{"type":"string","description":"Display name of the VM type"},"cpuCores":{"type":"integer","format":"int32","description":"Number of vCPU cores"},"memoryInGb":{"type":"string","description":"Memory in GB"},"gpuMemoryInGb":{"type":"string","description":"Single GPU card VRAM in GB"},"gpuTotalMemoryInGb":{"type":"string","description":"Total GPU VRAM in GB"},"storageType":{"type":"string","description":"Storage type (e.g. ssd)"},"storageCapacityInGb":{"type":"string","description":"Storage capacity in GB"},"osName":{"type":"string","description":"Operating system name"},"osVersion":{"type":"string","description":"Operating system version"},"supportOnDemand":{"type":"boolean","description":"Whether on-demand instances are supported"},"ondemandAvailable":{"type":"boolean","description":"Whether on-demand instances are currently available"},"spotAvailable":{"type":"boolean","description":"Whether spot instances are currently available"}}},"ResultObject":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"description":"data"}}}}}}
```

## Get available Instance ModelType

> Get available Instance ModelType

```json
{"openapi":"3.1.0","info":{"title":"saas-platform","version":"1.0.0"},"tags":[{"name":"API v2","description":"Yotta API v2 - RESTful endpoints"},{"name":"OpenapiVm","description":"OpenAPI VM API"},{"name":"VMs v2","description":"Virtual Machines API v2"}],"servers":[{"url":"https://api.yottalabs.ai","description":"Generated server url"}],"security":[{}],"paths":{"/v2/vms/type":{"get":{"tags":["OpenapiVm","VMs v2","API v2"],"summary":"Get available Instance ModelType","description":"Get available Instance ModelType","operationId":"getAvailableMachineModelType","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultListOpenapiVmsResponse"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResultObject"}}}}}}}},"components":{"schemas":{"ResultListOpenapiVmsResponse":{"type":"object","properties":{"message":{"type":"string","description":"message"},"code":{"type":"integer","format":"int32","description":"code"},"data":{"type":"array","description":"data","items":{"$ref":"#/components/schemas/OpenapiVmsResponse"}}}},"OpenapiVmsResponse":{"type":"object","properties":{"gpuType":{"type":"string"},"regions":{"type":"array","items":{"$ref":"#/components/schemas/OpenapiVmsRegionsResponse"}}}},"OpenapiVmsRegionsResponse":{"type":"object","properties":{"region":{"type":"string"},"types":{"type":"array","items":{"$ref":"#/components/schemas/OpenapiVmsTypesResponse"}}}},"OpenapiVmsTypesResponse":{"type":"object","properties":{"vmTypeId":{"type":"integer","format":"int32"},"gpuCount":{"type":"integer","format":"int32"},"pricePerHour":{"type":"string"},"supportSpot":{"type":"integer","format":"int32"},"spotPricePerHour":{"type":"string"},"currency":{"type":"string"},"displayName":{"type":"string"},"cpuCores":{"type":"integer","format":"int32"},"memoryInGb":{"type":"string"},"gpuMemoryInGb":{"type":"string"},"gpuTotalMemoryInGb":{"type":"string"},"storageType":{"type":"string"},"storageCapacityInGb":{"type":"string"},"osName":{"type":"string"},"osVersion":{"type":"string"},"supportOnDemand":{"type":"integer","format":"int32"},"ondemandAvailable":{"type":"integer","format":"int32"},"spotAvailable":{"type":"integer","format":"int32"}}},"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-v2/vms.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.