> 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/multi-tenant-api/2.23/getting-started/about-the-rest-api.md). # About the REST API The NVIDIA Run:ai Multi-tenant REST APIs provide a programmatic interface for managing and operating multi-tenant NVIDIA Run:ai deployments. These APIs are used by platform administrators to manage shared control plane resources across tenants. You can use these APIs to: * Manage tenants and tenant-level configuration * Register and manage clusters * Configure platform-level settings * Monitor and audit multi-tenant operational activity All API requests are authenticated using access tokens. For details on authentication and access setup, see [API access setup](/multi-tenant-api/2.23/getting-started/api-access-setup.md). ## API Versions The NVIDIA Run:ai Multi-tenant REST APIs are release-based and are available only for self-hosted deployments. Each API version aligns with a specific NVIDIA Run:ai product release (for example, 2.22, 2.23, 2.24). * API behavior is fixed for the lifetime of the release * No new features are added after the release is published * Changes are introduced only in newer released versions Using a versioned API ensures stability and predictability for platform administrators operating multi-tenant environments. ## API Conventions he NVIDIA Run:ai Multi-tenant REST APIs follow RESTful design principles and use JSON for request and response payloads. See [Making REST API requests](/multi-tenant-api/2.23/getting-started/using-the-rest-api/making-rest-api-requests.md) for more details: * Authentication is provided via bearer tokens in the `Authorization` header * Requests use standard HTTP methods (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`) * Request and response bodies are formatted as JSON * Standard HTTP status codes are used to indicate request success or failure (`2xx`, `4xx`, `5xx`) ## API Lifecycle and Deprecation NVIDIA Run:ai is committed to providing stable and predictable Multi-tenant APIs. When an API or field is deprecated, the deprecated version remains supported for two additional released versions. After the deprecation period ends, deprecated APIs or fields are removed from both the codebase and the documentation. For full details, see [NVIDIA Run:ai API Policy](/multi-tenant-api/2.23/getting-started/nvidia-run-ai-api-policy.md). --- # 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/multi-tenant-api/2.23/getting-started/about-the-rest-api.md?ask=&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.