# NVIDIA Run:ai Workload properties API

**Canonical:** https://apis.io/apis/runai/runai-workload-properties-api/  
**Provider:** NVIDIA Run:ai — https://apis.io/providers/runai/  
**Base URL:** https://app.run.ai  
**Documentation:** https://run-ai-docs.nvidia.com/api/readme.md

NVIDIA Run:ai Workload properties API is one of 62 APIs that [NVIDIA Run:ai](https://apis.io/providers/runai/) publishes on the [APIs.io](https://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.

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

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/runai/refs/heads/main/openapi/runai-workload-properties-api-openapi.yml
- **Documentation** — https://run-ai-docs.nvidia.com/api/getting-started/about-the-rest-api.md
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/runai/refs/heads/main/authentication/runai-authentication.yml

## Other NVIDIA Run:ai APIs (12)

- [NVIDIA Run:ai Access Keys API](https://apis.io/apis/runai/runai-access-keys-api/)
- [NVIDIA Run:ai Access rules API](https://apis.io/apis/runai/runai-access-rules-api/)
- [NVIDIA Run:ai Administrator Command Line Interface API](https://apis.io/apis/runai/runai-administrator-command-line-interface-api/)
- [NVIDIA Run:ai AI Applications API](https://apis.io/apis/runai/runai-ai-applications-api/)
- [NVIDIA Run:ai Applications API](https://apis.io/apis/runai/runai-applications-api/)
- [NVIDIA Run:ai AuditLogs API](https://apis.io/apis/runai/runai-auditlogs-api/)
- [NVIDIA Run:ai Clusters API](https://apis.io/apis/runai/runai-clusters-api/)
- [NVIDIA Run:ai Compute API](https://apis.io/apis/runai/runai-compute-api/)
- [NVIDIA Run:ai ConfigMap API](https://apis.io/apis/runai/runai-configmap-api/)
- [NVIDIA Run:ai Credentials API](https://apis.io/apis/runai/runai-credentials-api/)
- [NVIDIA Run:ai Datasources API](https://apis.io/apis/runai/runai-datasources-api/)
- [NVIDIA Run:ai Datavolumes API](https://apis.io/apis/runai/runai-datavolumes-api/)

## Tags

Workload properties

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/runai/runai-workload-properties-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/runai/.