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 Workload properties API

Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priority determine how workloads are classified, monitored, and scheduled.- Type - Defines the functional behavior of a workload, such as training or inference, and serves as the foundation for how it is classified within the platform. Each workload type includes a default category (used for monitoring) and a default priority (used for scheduling within a project).- Category - Represents the role or purpose of a workload, such as Build, Train, Deploy. Each workload type is assigned a default category to ensure consistent classification across the platform for monitoring purposes. See [Monitor workloads by category](https://run-ai-docs.nvidia.com/saas/platform-management/monitor-performance/workload-categories).- Priority - Determines the scheduling order of workloads within a project and whether a workload can be preempted. Higher-priority workloads are scheduled first and may become non-preemptible, preventing interruption by lower-priority workloads. See [Workload priority control](https://run-ai-docs.nvidia.com/saas/platform-management/runai-scheduler/scheduling/workload-priority-control).

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

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

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

8 operations 5 paths 21 schemas 1 DELETE5 GET1 POST1 PUT

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 Workload properties 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 8

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

Workload properties 8

Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priori…

GET
/api/v1/workload-categories
List workload categories.
list_categories → 200400401403503
GET
/api/v1/workload-categories/{categoryId}
Get workload category by id.
get_category_by_id 1 param → 200400401403404503
GET
/api/v1/workload-types
List workload types.
list_workload_types 2 params → 200400401403503
POST
/api/v1/workload-types
Create a workload type. [Experimental]
create_workload_type body → 201400401403409503
GET
/api/v1/workload-types/{workloadTypeId}
List workload type by id.
get_workload_type 1 param → 200400401403404503
PUT
/api/v1/workload-types/{workloadTypeId}
Update a workload type by id.
update_workload_type 1 param body → 200400401403404503
DELETE
/api/v1/workload-types/{workloadTypeId}
Delete a workload type by id. [Experimental]
delete_workload_type 1 param → 204401403500503
GET
/api/v1/workload-priorities
Get workload priorities.
get_workload_priorities 3 params → 200400401403500503

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are BasePriority (6 properties), WorkloadCategory (5 properties), Condition1 (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

ClusterId
string
The id of the cluster.
WorkloadTypeCreateFields
WorkloadTypeCreateUpdateInnerFields
object
2 properties
WorkloadTypeResourceInterfaces
array
Lists the versions of the custom resource definition (CRD) supported for this workload type, such as v1, v1beta1, or v1alpha1. This enables the platform to cor…
Conditions
array
WorkloadTypeStatusFields
object
3 properties
WorkloadCategories
array
WorkloadTypeResourceInterfacesWithVersion
array
Lists the versions of the custom resource definition (CRD) supported for this workload type, such as v1, v1beta1, or v1alpha1. This enables the platform to cor…
WorkloadCategory
object
5 properties 2 required
PriorityStatus
object
2 properties
WorkloadPriority
WorkloadTypeStatus
Priorities
array
WorkloadTypeConfig
WorkloadTypeResourceInterface
object
The resource interface for the workload type.
BasePriority
object
6 properties 3 required
Condition1
object
5 properties 2 required
WorkloadTypeConfigs
array
WorkloadTypeAdditionalCreateFields
object
2 properties
WorkloadTypeUpdateFields
Error
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-workload-properties-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 Workload properties 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.