> 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/gpu-instance/airuntime-templates.md).

# AIRuntime Templates

Browse NeevAI's curated catalog of **Platform Templates** — pre-built container configurations for common GPU workloads (JupyterLab with PyTorch, TensorFlow, etc.). Use a template's `id` as the `templateID` when creating a GPU Instance.

## List AI Runtime Templates

> Retrieves a list of available AI Runtime Templates.

```json
{"openapi":"3.0.3","info":{"title":"GPU Instance API","version":"0.1.0"},"tags":[{"name":"AIRuntime Templates","description":"Browse NeevAI's curated catalog of **Platform Templates** — pre-built container configurations for common GPU workloads (JupyterLab with PyTorch, TensorFlow, etc.). Use a template's `id` as the `templateID` when creating a GPU Instance.\n"}],"servers":[{"url":"https://api.ai.neevcloud.com/gpu","description":"Consolidated public API gateway"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Obtain an **`access_token`** from `POST /api/v1/auth/login` on the tenant API (same credentials as the console). In Authorize, paste **only that token** — do not prepend `Bearer`, and do not use inference keys (`sk-nc-*`).\n"}},"schemas":{"AIRuntimeTemplateListResponse":{"type":"object","description":"A response object containing a list of AI Runtime Templates and pagination details.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIRuntimeTemplateResponse"}},"pagination":{"$ref":"#/components/schemas/PaginationResponse"}}},"AIRuntimeTemplateResponse":{"type":"object","description":"Represents an AI Runtime Template.","required":["id","description","templateSpec","ownerOrgId"],"properties":{"id":{"type":"string","readOnly":true,"description":"The unique identifier for the AI Runtime Template."},"description":{"type":"string","description":"The user-friendly description of the AI Runtime Template."},"name":{"type":"string","description":"The name of the AI Runtime Template."},"icon":{"type":"string","nullable":true,"description":"Icon/logo image data as base64-encoded string."},"templateSpec":{"$ref":"#/components/schemas/TemplateSpec"},"ownerOrgId":{"$ref":"#/components/schemas/TemplateOwnerOrgId"}}},"TemplateSpec":{"type":"object","description":"Detailed specification for AI Runtime Templates.","required":["image","apps"],"properties":{"image":{"type":"string","description":"The container image to be used for the AI Runtime."},"command":{"type":"array","description":"The entrypoint command to execute when the container starts.","items":{"type":"string"}},"env":{"type":"array","description":"A list of environment variables to set inside the container.","items":{"$ref":"#/components/schemas/EnvVar"}},"apps":{"type":"array","description":"A list of applications available in this template.","items":{"$ref":"#/components/schemas/AppSpec"}},"metadata":{"type":"object","description":"Additional metadata about the template including category, tags, frameworks, use cases, etc."}}},"EnvVar":{"type":"object","description":"A key-value pair representing an environment variable.","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the environment variable."},"value":{"type":"string","description":"The value of the environment variable."}}},"AppSpec":{"type":"object","description":"Defines an application available in the template.","required":["name","port","protocol","isUI"],"properties":{"name":{"type":"string","description":"The name of the application."},"port":{"type":"integer","format":"int32","description":"The port number for the application."},"protocol":{"type":"string","enum":["HTTP","TCP","UDP","WebSocket"],"description":"The network protocol used by the application."},"isUI":{"type":"boolean","description":"Whether this application provides a user interface."}}},"TemplateOwnerOrgId":{"type":"string","description":"The organization ID that owns this template. Use \"neevai\" for NeevCloud-provided templates, or the customer's organization ID for customer-managed templates."},"PaginationResponse":{"type":"object","properties":{"total_items":{"type":"integer","description":"The total number of items available across all pages."},"total_pages":{"type":"integer","description":"The total number of pages."},"current_page":{"type":"integer","description":"The current page number."},"items_per_page":{"type":"integer","description":"The number of items returned per page."}}},"ErrorResponse":{"type":"object","description":"A standard format for error responses.","properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable message providing details about the error."}},"required":["code","message"]}}},"paths":{"/api/v1beta1/airuntime-templates":{"get":{"tags":["AIRuntime Templates"],"summary":"List AI Runtime Templates","description":"Retrieves a list of available AI Runtime Templates.","operationId":"listAIRuntimeTemplates","responses":{"200":{"description":"A paginated list of AI Runtime Templates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIRuntimeTemplateListResponse"}}}},"401":{"description":"Unauthorized access.","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 an AI Runtime Template

> Retrieves the details of a specific AI Runtime Template by its unique ID.

```json
{"openapi":"3.0.3","info":{"title":"GPU Instance API","version":"0.1.0"},"tags":[{"name":"AIRuntime Templates","description":"Browse NeevAI's curated catalog of **Platform Templates** — pre-built container configurations for common GPU workloads (JupyterLab with PyTorch, TensorFlow, etc.). Use a template's `id` as the `templateID` when creating a GPU Instance.\n"}],"servers":[{"url":"https://api.ai.neevcloud.com/gpu","description":"Consolidated public API gateway"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Obtain an **`access_token`** from `POST /api/v1/auth/login` on the tenant API (same credentials as the console). In Authorize, paste **only that token** — do not prepend `Bearer`, and do not use inference keys (`sk-nc-*`).\n"}},"schemas":{"AIRuntimeTemplateResponse":{"type":"object","description":"Represents an AI Runtime Template.","required":["id","description","templateSpec","ownerOrgId"],"properties":{"id":{"type":"string","readOnly":true,"description":"The unique identifier for the AI Runtime Template."},"description":{"type":"string","description":"The user-friendly description of the AI Runtime Template."},"name":{"type":"string","description":"The name of the AI Runtime Template."},"icon":{"type":"string","nullable":true,"description":"Icon/logo image data as base64-encoded string."},"templateSpec":{"$ref":"#/components/schemas/TemplateSpec"},"ownerOrgId":{"$ref":"#/components/schemas/TemplateOwnerOrgId"}}},"TemplateSpec":{"type":"object","description":"Detailed specification for AI Runtime Templates.","required":["image","apps"],"properties":{"image":{"type":"string","description":"The container image to be used for the AI Runtime."},"command":{"type":"array","description":"The entrypoint command to execute when the container starts.","items":{"type":"string"}},"env":{"type":"array","description":"A list of environment variables to set inside the container.","items":{"$ref":"#/components/schemas/EnvVar"}},"apps":{"type":"array","description":"A list of applications available in this template.","items":{"$ref":"#/components/schemas/AppSpec"}},"metadata":{"type":"object","description":"Additional metadata about the template including category, tags, frameworks, use cases, etc."}}},"EnvVar":{"type":"object","description":"A key-value pair representing an environment variable.","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the environment variable."},"value":{"type":"string","description":"The value of the environment variable."}}},"AppSpec":{"type":"object","description":"Defines an application available in the template.","required":["name","port","protocol","isUI"],"properties":{"name":{"type":"string","description":"The name of the application."},"port":{"type":"integer","format":"int32","description":"The port number for the application."},"protocol":{"type":"string","enum":["HTTP","TCP","UDP","WebSocket"],"description":"The network protocol used by the application."},"isUI":{"type":"boolean","description":"Whether this application provides a user interface."}}},"TemplateOwnerOrgId":{"type":"string","description":"The organization ID that owns this template. Use \"neevai\" for NeevCloud-provided templates, or the customer's organization ID for customer-managed templates."},"ErrorResponse":{"type":"object","description":"A standard format for error responses.","properties":{"code":{"type":"string","description":"A machine-readable error code."},"message":{"type":"string","description":"A human-readable message providing details about the error."}},"required":["code","message"]}}},"paths":{"/api/v1beta1/airuntime-templates/{template_id}":{"get":{"tags":["AIRuntime Templates"],"summary":"Get an AI Runtime Template","description":"Retrieves the details of a specific AI Runtime Template by its unique ID.","operationId":"getAIRuntimeTemplate","parameters":[{"in":"path","name":"template_id","required":true,"schema":{"type":"string","pattern":"^tpl-[a-zA-Z0-9-]+$"},"description":"The unique identifier of the AI Runtime Template."}],"responses":{"200":{"description":"Detailed information about the AI Runtime Template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIRuntimeTemplateResponse"}}}},"401":{"description":"Unauthorized access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"An AI Runtime Template 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/gpu-instance/airuntime-templates.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.