A compute resource is a building block that represents compute resources such as GPUs, CPU cores, and CPU memory.The compute resources may consist of multiple physical resources, for example, 0.5 GPU, 8 cores and 200 Megabytes of CPU memory. A compute resource is available to a scope and and all of the organizational units within that scope. For more information, see [Compute resource](https://run-ai-docs.nvidia.com/saas/workloads-in-nvidia-run-ai/assets/compute-resources).
NVIDIA Run:ai Compute 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 Compute. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
5 operations
across 2 paths,
and defines 49 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 operations2 paths49 schemas1 DELETE2 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
NVIDIA Run:ai Compute 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Compute 5
A compute resource is a building block that represents compute resources such as GPUs, CPU cores, and CPU memory. The compute resources may consist of multiple physical resources,…
The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are ComputeAssetSpec (12 properties), AssetReadOnlyFields (11 properties), AssetCreationFields (7 properties), AssetUsageInfo (6 properties). Each schema is shown below with its type and property counts.
CpuMemoryRequest
string
The amount of CPU memory to allocate for this workload (1G, 20M, .etc). The workload will receive at least this amount of memory. Note that the workload will n…
ExtendedResource
object
Quantity of an extended resource.
3 properties
HttpResponse
object
2 properties2 required
AssetDescription
string
The description of the asset.
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…
DataSourceOverrides
object
specific fields to override in the data source.
1 property
WorkloadId1
string
A unique ID of the workload.
WorkloadName
string
The name of the workload.
WorkloadSupportedTypes
object
5 properties
AssetsUsageRefCompute
object
ComputeListResponse
object
1 property1 required
GpuPortionRequest
number
Required if and only if gpuRequestType is portion. States the portion of the GPU to allocate for the created workload, per GPU device, between 0 and 1. The def…
AssetUpdatableFields
object
2 properties1 required
ComputeAssetSpec
object
12 properties
Scope
string
The scope in which an asset can be used. The highest scope, system, is intended for internal purposes only.
Error
object
3 properties2 required
AssetId
string
Unique identifier of the asset.
EnvironmentAssetRef
object
Reference information about environment asset.
3 properties2 required
GpuPortionLimit
number
Limitations on the portion consumed by the workload, per GPU device. The system guarantees The gpuPotionLimit must be no less than the gpuPortionRequest.
ToolType
string
Super set of Internal and External tool types.
AssetCreationFields
object
7 properties1 required
CpuMemoryLimit
string
Limitations on the CPU memory to allocate for this workload (1G, 20M, .etc). The system guarantees that this workload will not be able to consume more than thi…
CpuCoreRequest
number
CPU units to allocate for the created workload (0.5, 1, .etc). The workload will receive at least this amount of CPU. Note that the workload will not be schedu…
UsageTimesInfo
object
Details about times the asset has been used by workloads, etc.
1 property
AssetsUsageRef
object
Reference information about usage of assets by other assets, for example datasources that uses credentials.
5 properties
ComputeCreationRequest
object
2 properties2 required
AssetName
string
The name of the asset.
PolicyRuleEnum
string
Indicates which validation rule (e.g., min, max, step, options, required, canEdit, canAdd) conflicted with policy restrictions, causing the asset or template t…
AssetReadOnlyFields
object
11 properties6 required
UpdateCount
integer
the value of an update counter of a data in the system.
ExtendedResources
array
Extended resources and their quantity.
AssetKind
string
The kind of the asset.
AssetCreationRequest
AssetDatasourceRef
object
Reference information about a datasource asset.
4 properties3 required
GpuMemoryRequest
string
Required if and only if gpuRequestType is memory. States the GPU memory to allocate for the created workload, per GPU device. Note that the workload will not b…
ComplianceInfoReason
object
An issue preventing the use of a template or asset for creating workloads in a given project.
3 properties1 required
AssetMeta
ComputeUpdateRequest
object
2 properties2 required
AssetRef
object
Reference information about an asset.
2 properties2 required
GpuMemoryLimit
string
Limitation on the memory consumed by the workload, per GPU device. The system guarantees The gpuMemoryLimit must be no less than gpuMemoryRequest.
LargeShmRequest
boolean
A large /dev/shm device to mount into a container running the created workload. An shm is a shared file system mounted on RAM.
CpuCoreLimit
number
Limitations on the number of CPUs consumed by the workload (0.5, 1, .etc). The system guarantees that this workload will not be able to consume more than this…
ComputeAsset
object
5 properties2 required
AssetUpdateRequest
AssetUsageInfo
object
Details about resources that use the asset.
6 properties
GpuDevicesRequest
integer
Requested number of GPU devices. Currently if more than one device is requested, it is not possible to provide values for gpuMemory or gpuPortion.
ClusterIdOptional
string
The id of the cluster.
ComplianceInfo
object
Compliance of an asset with creation of workloads in a given project.
3 properties
WorkloadRefAndStatus
object
Id, name and status of a workspace or training
3 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
