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 Pods API

Retrieve data about workload pods from your NVIDIA Run:ai platform.

NVIDIA Run:ai Pods 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 Pods. 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 29 schemas. It is described by OpenAPI 3.0.3, at version latest.

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

5 operations 5 paths 29 schemas 5 GET

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 Pods 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.

Pods 5

Retrieve data about workload pods from your NVIDIA Run:ai platform.

GET
/api/v1/workloads/pods
List pods.
list_pods 9 params → 200401403404500503
GET
/api/v1/workloads/{workloadId}/pods/{podId}/metrics
Get pod metrics data.
get_workload_pod_metrics 6 params → 200207400401403404500503
GET
/api/v1/workloads/{workloadId}/pods
Get workload pods by id.
get_workload_pods 5 params → 200401403404500503
GET
/api/v1/workloads/pods/count
Get pods count.
count_pods 3 params → 200401403500503
GET
/api/v1/workloads/inferences/revisions/{revisionId}/pods
Get revision pods by id. [Experimental]
get_revision_pods 2 params → 200401403404500503

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are PodSyncFields (19 properties), PodRequestResources (6 properties), AllocatedResources (5 properties), PodToleration (5 properties). Each schema is shown below with its type and property counts.

MatchExpression
object
A selector that contains values, a key, and an operator that relates the key and values.
3 properties 2 required
PodToleration
object
5 properties
MatchExpressionOperator
string
Represents a key's relationship to a set of values (mandatory).
Pod1
GpuRequestType
string
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…
Container1
object
3 properties 2 required
Error
object
3 properties 2 required
HistogramSeries
object
2 properties 2 required
PodRequestResources
object
6 properties
PodPreferredNodeSelectorTerm
object
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is…
2 properties
HistogramValue
object
2 properties 2 required
TenantId
integer
The id of the tenant.
PodVerbosity
string
ClusterId
string
The id of the cluster.
PodTolerations
array
NodeSelectorTerm
object
A null or empty node selector term matches no objects. The requirements of them are ANDed.
1 property
PodSyncFields
object
19 properties 8 required
RequestResourceCores
object
2 properties
WorkloadsExtendedResources
array
Set of extended resources with their quantity
PodMetricType
string
Specify which data to request.
MetricsCompositeResponse
object
2 properties 1 required
PodNodeAffinity
object
group of node affinity scheduling rules.
2 properties
RequestResourceQuantity
object
2 properties
WorkloadsExtendedResource
object
Quantity of an extended resource.
3 properties
PodVerbosityFields
object
2 properties
PodComputedFields
object
4 properties 3 required
Pods1
array
AllocatedResources
object
5 properties
MeasurementResponse
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-pods-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