NVIDIA Run:ai REST API

The purpose of the NVIDIA Run:ai REST API is to provide an easy-to-use programming interface for administrative tasks.

NVIDIA Run:ai REST API documentation

The NVIDIA Run:ai REST API offers developers a robust interface for interacting with and managing NVIDIA Run:ai metadata objects, including Projects, Departments, Clusters, and Users.

Public API documentation is available at api-docs.run.ai. For self-hosted deployments, access the documentation at https://<control-plane-url>/api/docs.

NVIDIA Run:ai API policy

At NVIDIA Run:ai, we are dedicated to delivering stable, reliable, and well-documented APIs. Our goal is to ensure that our APIs evolve in a predictable, transparent manner, offering users a seamless experience.

NVIDIA Run:ai follows strict API design and operational standards to ensure a consistent and high-quality experience for users.

API lifecycle and deprecation

While our goal is to maintain stable and backward-compatible APIs, there may be times when breaking changes or deprecations are necessary.

In case of breaking changes, the deprecated version of the API will be supported for two additional versions in self-hosted deployments and for six months in SaaS deployments. During this period, no new features or functionality will be added to the deprecated API. When an API or API field is deprecated, the following process is followed: Documentation: The deprecated API or field is clearly labeled in the documentation, with a replacement provided where applicable. Release Notes: Information about deprecated APIs, including those scheduled for future removal, is included in the release notes. Customer Notification: Customers are notified of upcoming deprecations as part of the regular release communications.

API removal

After the defined backward compatibility period has ended, deprecated APIs or fields are removed from both the codebase and the documentation.