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

# NVIDIA Run:ai REST API Documentation

NVIDIA Run:ai is a platform for accelerating and managing AI workloads in shared computing environments. It enables teams to dynamically schedule, allocate, and monitor GPU resources across clusters.

The NVIDIA Run:ai control plane API provides programmatic access to these capabilities, allowing you to integrate workload submission, resource management, and administrative operations directly into your own applications, services, or automation pipelines.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-gear-code">:gear-code:</i></h4><p><strong>About the REST API</strong><br>Overview of the NVIDIA Run:ai REST API, structure, and core concepts</p></td><td><a href="/api/getting-started/about-the-rest-api.md">About the REST API</a></td></tr><tr><td><h4><i class="fa-code-pull-request">:code-pull-request:</i></h4><p><strong>Authenticate to the API</strong><br>Create and use access tokens to authorize API requests</p></td><td><a href="/api/getting-started/how-to-authenticate-to-the-api.md">How to Authenticate to the API</a></td></tr><tr><td><h4><i class="fa-square-terminal">:square-terminal:</i></h4><p><strong>Using the REST API</strong><br>Make your first requests and learn common request, response, and pagination patterns</p></td><td><a href="/api/getting-started/using-the-rest-api.md">Using the REST API</a></td></tr></tbody></table>

Developers use the NVIDIA Run:ai APIs to:

* **Automate workload management** - Submit, suspend/resume, and monitor AI training and inference jobs programmatically.
* **Optimize resource utilization** - Dynamically allocate GPU and CPU resources based on workload demand.
* **Integrate with existing systems** - Connect NVIDIA Run:ai with CI/CD pipelines, data science platforms, or custom dashboards.
* **Manage multi-tenant environments** - Streamline access control, quotas, and user management across teams or projects.

By integrating with the API, you gain fine-grained control and scalability beyond the user interface, making it easier to embed NVIDIA Run:ai capabilities into your organization’s AI infrastructure.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://run-ai-docs.nvidia.com/api/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.