How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NVIDIA Run:ai Workloads API

Workloads are both native platform workloads, Workspaces, Training and Inference, as well as workloads that originate from third-party ML frameworks, tools, or the broader Kubernetes ecosystems. For more details on the supported workloads, see [Introduction to workloads](https://run-ai-docs.nvidia.com/saas/workloads-in-nvidia-run-ai/introduction-to-workloads). Workloads endpoints allow you to list, retrieve, count, and view telemetry or metrics data for all workload types in your environment.

NVIDIA Run:ai Workloads 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. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 5 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version latest.

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

5 operations 5 paths 34 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

NVIDIA Run:ai Workloads 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 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Workloads 5

Workloads are both native platform workloads, Workspaces, Training and Inference, as well as workloads that originate from third-party ML frameworks, tools, or the broader Kuberne…

GET
/api/v1/workloads
List workloads.
get_workloads 7 params → 200401403500503
GET
/api/v1/workloads/{workloadId}
Get a workload.
get_workload 1 param → 200401403404500503
GET
/api/v1/workloads/count
Count workloads.
count_workloads 3 params → 200401403500503
GET
/api/v1/workloads/telemetry
Get the workloads telemetry.
get_workloads_telemetry 6 params → 200400401403404500503
GET
/api/v1/workloads/{workloadId}/metrics
Get workload metrics data.
get_workload_metrics 5 params → 200207400401403404500503

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Workload (55 properties), Connection1 (8 properties), WorkloadRequestResources (6 properties), WorkloadAllocatedResources (5 properties). Each schema is shown below with its type and property counts.

PhaseReason
string
ClusterId
string
The id of the cluster.
WorkloadAllocatedResources
objectnull
5 properties
ReplicaType
stringnull
ActionsSupport
object
The actions support provided for the workload.
2 properties
TelemetryResponse
object
3 properties 3 required
WorkloadTelemetryType
string
Select a telemetry type.
Datasource
object
3 properties 2 required
MetricsCompositeResponse
object
2 properties 1 required
Source
string
WorkloadsExtendedResource
objectnull
Quantity of an extended resource.
3 properties
RequestResourceQuantity
objectnull
2 properties
RequestedPods
object
5 properties
Conditions
array
TenantId
integer
The id of the tenant.
Environment
object
4 properties 2 required
WorkloadsExtendedResources
arraynull
Set of extended resources with their quantity
HistogramValue
object
2 properties 2 required
OrgType
string
GpuRequestType
stringnull
Sets the unit type for GPU resources requests. Stated in terms of portion or memory. Sets the unit type for other GPU request fields. If gpuDevicesRequest 1, o…
WorkloadDetailed
Phase
string
WorkloadRequestResources
objectnull
6 properties
Workloads
array
HistogramSeries
object
2 properties 2 required
Workload
object
55 properties 23 required
SourceApi
stringnull
RequestResourceCores
objectnull
2 properties
PendingSchedulingMessage
object
5 properties 3 required
MeasurementResponse
object
3 properties 2 required
WorkloadMetricType
string
Specify which metric data to request.
Connection1
object
Connection that either expose port from the container (a port is associated with a tool that the container runs), or URL to be used for connecting to an extern…
8 properties 3 required
Condition1
object
5 properties 2 required
Error
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-workloads-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
Where this information came from

This is an independent, third-party profile of NVIDIA Run:ai Workloads API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.