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

The Workloads batch API from NVIDIA Run:ai — 1 operation(s) for workloads batch.

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

This API exposes 1 operation across 1 path, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version latest.

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

1 operations 1 paths 9 schemas 1 POST

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 batch 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Workloads batch 1
POST
/api/v1/workloads/batch
Workload batch operations.
batch_workloads body → 200400401403500503

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are BatchResponse (3 properties), BatchResponseFailureItem (3 properties), Error (3 properties), WorkloadBatch (2 properties). Each schema is shown below with its type and property counts.

BatchResponse
object
3 properties 1 required
BatchId
string
The ID of the batch operation.
BatchResponseFailureItem
object
3 properties 3 required
Action1
string
The action to perform on the list of ids.
ErrorMessage
string
The error message.
WorkloadBatch
object
The ids and action to perform on a batch of workloads. The number of ids is limited to 100.
2 properties 2 required
ErrorCode
integer
A numeric code representing the error type.
IdsList
array
List of ids to perform the action on.
Error
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-workloads-batch-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