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

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.2.0, at version latest.

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

5 operations 2 paths 49 schemas 1 DELETE2 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 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,…

GET
/api/v1/asset/compute
List compute assets.
list_compute_assets 10 params → 200401403503
POST
/api/v1/asset/compute
Create compute asset.
create_compute_asset body → 202400401403409503
GET
/api/v1/asset/compute/{AssetId}
Retrieve a compute asset.
get_compute_asset_by_id 5 params → 200401403404503
PUT
/api/v1/asset/compute/{AssetId}
Update a compute asset.
update_compute_asset_by_id 1 param body → 202401403404default
DELETE
/api/v1/asset/compute/{AssetId}
Delete a compute asset.
delete_compute_asset_by_id 1 param → 202401403404503

Schemas 49

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.

CpuCoreRequest
numbernull
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…
PolicyRuleEnum
stringnull
Indicates which validation rule (e.g., min, max, step, options, required, canEdit, canAdd) conflicted with policy restrictions, causing the asset or template t…
LargeShmRequest
booleannull
A large /dev/shm device to mount into a container running the created workload. An shm is a shared file system mounted on RAM.
UpdateCount
integer
the value of an update counter of a data in the system.
ComputeAsset
object
5 properties 2 required
Scope
string
The scope in which an asset can be used. The highest scope, system, is intended for internal purposes only.
CpuMemoryLimit
stringnull
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…
WorkloadName
string
The name of the workload.
GpuMemoryRequest
stringnull
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…
ComputeUpdateRequest
object
2 properties 2 required
AssetRef
object
Reference information about an asset.
2 properties 2 required
AssetUpdateRequest
WorkloadSupportedTypes
objectnull
5 properties
AssetUsageInfo
objectnull
Details about resources that use the asset.
6 properties
ExtendedResources
arraynull
Extended resources and their quantity.
ComplianceInfo
objectnull
Compliance of an asset with creation of workloads in a given project.
3 properties
CpuMemoryRequest
stringnull
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…
AssetName
string
The name of the asset.
GpuDevicesRequest
integernull
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
stringnull
The id of the cluster.
UsageTimesInfo
objectnull
Details about times the asset has been used by workloads, etc.
1 property
GpuPortionLimit
numbernull
Limitations on the portion consumed by the workload, per GPU device. The system guarantees The gpuPotionLimit must be no less than the gpuPortionRequest.
AssetId
string
Unique identifier of the asset.
ComputeCreationRequest
object
2 properties 2 required
ComputeAssetSpec
object
12 properties
ComputeListResponse
object
1 property 1 required
WorkloadId1
string
A unique ID of the workload.
GpuRequestType
stringnull
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…
AssetUpdatableFields
object
2 properties 1 required
ExtendedResource
objectnull
Quantity of an extended resource.
3 properties
AssetMeta
EnvironmentAssetRef
object
Reference information about environment asset.
3 properties 2 required
CpuCoreLimit
numbernull
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…
AssetDescription
stringnull
The description of the asset.
WorkloadRefAndStatus
object
Id, name and status of a workspace or training
3 properties 2 required
AssetDatasourceRef
object
Reference information about a datasource asset.
4 properties 3 required
DataSourceOverrides
objectnull
specific fields to override in the data source.
1 property
AssetKind
string
The kind of the asset.
AssetCreationFields
object
7 properties 1 required
Error
object
3 properties 2 required
AssetsUsageRef
object
Reference information about usage of assets by other assets, for example datasources that uses credentials.
5 properties
HttpResponse
object
2 properties 2 required
AssetCreationRequest
GpuPortionRequest
numbernull
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…
AssetReadOnlyFields
object
11 properties 6 required
AssetsUsageRefCompute
objectnull
ToolType
string
Super set of Internal and External tool types.
GpuMemoryLimit
stringnull
Limitation on the memory consumed by the workload, per GPU device. The system guarantees The gpuMemoryLimit must be no less than gpuMemoryRequest.
ComplianceInfoReason
object
An issue preventing the use of a template or asset for creating workloads in a given project.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-compute-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 ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API
NVIDIA Run:ai Departments API
Where this information came from

This is an independent, third-party profile of NVIDIA Run:ai Compute 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.