> For the complete documentation index, see [llms.txt](https://docs.ai.neevcloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ai.neevcloud.com/api-reference/vm-service/image.md).

# Image

## List available OS images

> Retrieves a paginated list of available OS images for creating VMs.

```json
{"openapi":"3.0.3","info":{"title":"VM Service API","version":"0.1.0"},"servers":[{"url":"https://api.ai.neevcloud.com/vm","description":"Consolidated public API gateway"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token for authentication."}},"schemas":{"ListLimit":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Page size for list endpoints (default 20, maximum 100)."},"OSImageListResponse":{"type":"object","description":"Paginated list of OS images.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OSImage"}},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}}},"OSImage":{"type":"object","description":"Full OS image representation as returned by the API.","required":["id","name","version","os_family","os_type","architecture","min_root_disk_gb","recommended_root_disk_gb"],"properties":{"id":{"type":"string","description":"The unique identifier of the OS image."},"name":{"type":"string","description":"The display name of the OS image."},"version":{"type":"string","description":"The version of the OS."},"os_family":{"type":"string","description":"The OS family/distribution."},"os_type":{"type":"string","description":"The OS type (linux or windows).","enum":["linux","windows"]},"architecture":{"type":"string","description":"CPU architecture.","enum":["x86_64","arm64"]},"min_root_disk_gb":{"type":"integer","description":"Minimum root disk size required in GB."},"recommended_root_disk_gb":{"type":"integer","description":"Recommended root disk size in GB."},"description":{"type":"string","nullable":true,"description":"Detailed description of the OS image."},"metadata":{"type":"object","nullable":true,"description":"Additional metadata including source_type and source_url."}}},"PaginationResponse":{"type":"object","description":"Pagination metadata.","properties":{"total_items":{"type":"integer","description":"Total number of items across all pages."},"total_pages":{"type":"integer","description":"Total number of pages."},"current_page":{"type":"integer","description":"Current page number."},"items_per_page":{"type":"integer","description":"Number of items per page."}}},"ErrorResponse":{"type":"object","description":"Standard format for error responses.","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code."},"message":{"type":"string","description":"Human-readable error message."}}}}},"paths":{"/api/v1/images":{"get":{"tags":["Image"],"summary":"List available OS images","description":"Retrieves a paginated list of available OS images for creating VMs.","operationId":"listOSImages","parameters":[{"in":"query","name":"page","schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination (starts from 1)."},{"in":"query","name":"limit","schema":{"$ref":"#/components/schemas/ListLimit"},"description":"Number of items to return per page (default 20, maximum 100)."}],"responses":{"200":{"description":"A paginated list of OS images.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OSImageListResponse"}}}},"400":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"An unexpected internal server error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Get OS image details

> Fetches the details of a specific OS image by its unique identifier.

```json
{"openapi":"3.0.3","info":{"title":"VM Service API","version":"0.1.0"},"servers":[{"url":"https://api.ai.neevcloud.com/vm","description":"Consolidated public API gateway"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token for authentication."}},"schemas":{"OSImage":{"type":"object","description":"Full OS image representation as returned by the API.","required":["id","name","version","os_family","os_type","architecture","min_root_disk_gb","recommended_root_disk_gb"],"properties":{"id":{"type":"string","description":"The unique identifier of the OS image."},"name":{"type":"string","description":"The display name of the OS image."},"version":{"type":"string","description":"The version of the OS."},"os_family":{"type":"string","description":"The OS family/distribution."},"os_type":{"type":"string","description":"The OS type (linux or windows).","enum":["linux","windows"]},"architecture":{"type":"string","description":"CPU architecture.","enum":["x86_64","arm64"]},"min_root_disk_gb":{"type":"integer","description":"Minimum root disk size required in GB."},"recommended_root_disk_gb":{"type":"integer","description":"Recommended root disk size in GB."},"description":{"type":"string","nullable":true,"description":"Detailed description of the OS image."},"metadata":{"type":"object","nullable":true,"description":"Additional metadata including source_type and source_url."}}},"ErrorResponse":{"type":"object","description":"Standard format for error responses.","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code."},"message":{"type":"string","description":"Human-readable error message."}}}}},"paths":{"/api/v1/images/{image_id}":{"get":{"tags":["Image"],"summary":"Get OS image details","description":"Fetches the details of a specific OS image by its unique identifier.","operationId":"getOSImage","parameters":[{"in":"path","name":"image_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the OS image."}],"responses":{"200":{"description":"Detailed information about the OS image.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OSImage"}}}},"400":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"An OS image with the specified ID was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"An unexpected internal server error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.ai.neevcloud.com/api-reference/vm-service/image.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.