Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NVIDIA Run:ai Workloads V2 API

The Workloads V2 API allows you to create, retrieve, and delete workloads that originate from third-party ML frameworks, tools, or the broader Kubernetes ecosystem. These workloads are registered in the platform through the Workload Types API, some are already registered in NVIDIA Run:ai, while others can be added by administrators.Each submission combines the user's Kubernetes manifest with NVIDIA Run:ai scheduling metadata, enabling consistent orchestration, monitoring, and governance. See [Extending workload support](https://run-ai-docs.nvidia.com/saas/workloads-in-nvidia-run-ai/workload-types/extending-workload-support) for more details.

NVIDIA Run:ai Workloads V2 API is one of 62 APIs that NVIDIA Run:ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workloads V2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 2 paths, and defines 27 schemas. It is described by OpenAPI 3.0.3, at version latest.

Requests are made against a single base URL, https://app.run.ai.

4 operations 2 paths 27 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
latest
Base URL
https://app.run.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

NVIDIA Run:ai Workloads V2 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Workloads V2 4

The Workloads V2 API allows you to create, retrieve, and delete workloads that originate from third-party ML frameworks, tools, or the broader Kubernetes ecosystem. These workload…

POST
/api/v2/workloads
Create a workload. [Experimental]
create_workload_v2 body → 202400401403409500503
GET
/api/v2/workloads/{WorkloadV2Id}
Get a specific workload. [Experimental]
get_workload_v2_by_id 1 param → 200401403404500503
DELETE
/api/v2/workloads/{WorkloadV2Id}
Delete a workload. [Experimental]
delete_workload_v2 1 param → 202401403404500503
PUT
/api/v2/workloads/{WorkloadV2Id}
Update workload spec. [Experimental]
update_workload_v2 1 param body → 202401403404500503

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are WorkloadV2MetadataAutoFill (13 properties), WorkloadV2MetadataCreateParams (7 properties), WorkloadV2MetadataResponse (5 properties), WorkloadV2 (4 properties). Each schema is shown below with its type and property counts.

Category
string
Specify the workload category assigned to the workload. Categories are used to classify and monitor different types of workloads within the NVIDIA Run:ai platf…
WorkloadId3
string
A unique ID of the workload.
ProjectName2
string
The name of the project
WorkloadName
string
The name of the workload.
WorkloadV2SyncInfo
object
2 properties 1 required
ManifestEncoded
string
Kubernetes YAML manifest encoded in base 64. Mutually exclusive with manifest.
Error
object
3 properties 2 required
WorkloadV2Metadata
DepartmentName1
string
The name of the department
WorkloadV2MetadataUpdateParams
object
2 properties
TenantId
integer
The id of the tenant.
Preemptibility
string
Specifies whether the workload can be preempted by higher-priority workloads. Valid values are preemptible and non-preemptible. If explicitly set, this value t…
WorkloadV2UpdateRequest
object
3 properties
ClusterId
string
The id of the cluster.
PriorityClass
string
Specifies the priority class for the workload, which determines its scheduling behavior. Valid values are: very-low, low, medium-low, medium, medium-high, high…
WorkloadV2SyncStatus
string
WorkloadV2MetadataAutoFill
object
13 properties 11 required
WorkloadV2CreateRequest
object
3 properties 1 required
DesiredPhase
string
The desired phase of the workload.
WorkloadV2GetResponse
object
2 properties 1 required
GVK
object
Specifies the Group, Version, and Kind (GVK) of the Kubernetes resource that defines the workload.
3 properties 3 required
WorkloadV2MetadataResponse
object
5 properties 2 required
Manifest
object
The full Kubernetes manifest for the workload in JSON form. Mutually exclusive with manifestEncodedBase64.
WorkloadV2
object
4 properties 4 required
DepartmentId3
string
The id of the department.
ProjectId
string
The id of the project.
WorkloadV2MetadataCreateParams
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-workloads-v2-api-openapi.yml Raw ↑

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API
NVIDIA Run:ai Access rules API
NVIDIA Run:ai Administrator Command Line Interface API
NVIDIA Run:ai AI Applications API
NVIDIA Run:ai Applications API
NVIDIA Run:ai AuditLogs API
NVIDIA Run:ai Clusters API
NVIDIA Run:ai Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API