NVIDIA Run:ai Projects API

Projects implement resource allocation policies and create segregation between different initiatives. It can represent a team, an individual, or an initiative that shares resources or has a specific resources budget (quota). See [Projects](https://run-ai-docs.nvidia.com/saas/platform-management/aiinitiatives/organization/projects) for more information.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 17 operations across 10 paths, and defines 61 schemas. It is described by OpenAPI 3.0.3, at version latest.

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

17 operations 10 paths 61 schemas 2 DELETE9 GET1 PATCH2 POST3 PUT

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

License

NVIDIA Run:ai

Resource Areas

Authentication & Security 1

NVIDIA Run:ai Projects 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 17

Across 10 paths, the API surfaces 17 operations — 2 DELETE, 9 GET, 1 PATCH, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Projects 17

Projects implement resource allocation policies and create segregation between different initiatives. It can represent a team, an individual, or an initiative that shares resource…

POST

/api/v1/org-unit/projects

Create project

create_project body → 201400401403409503

GET

/api/v1/org-unit/projects

Get projects

get_projects 6 params → 200400401403503

PUT

/api/v1/org-unit/projects/{projectId}

Update project

update_project 1 param body → 200400401403404503

GET

/api/v1/org-unit/projects/{projectId}

Get project

get_project 1 param → 200401403404503

DELETE

/api/v1/org-unit/projects/{projectId}

Delete project

delete_project 1 param → 202204400401403404500503

PUT

/api/v1/org-unit/projects/{projectId}/resources

Update project resources

update_project_resources 1 param body → 200400401403404503

PATCH

/api/v1/org-unit/projects/{projectId}/resources

Patch project resources

patch_project_resources 1 param body → 200400401403404503

GET

/api/v1/org-unit/projects/{projectId}/metrics

Get project metrics data.

get_project_metrics 6 params → 200207400401403404500503

GET

/api/v1/org-unit/projects/telemetry

Get projects telemetry

get_projects_telemetry 5 params → 200400401403503

GET

/api/v1/org-unit/projects/count

Count projects

count_projects 2 params → 200400401403503

GET

/v1/k8s/clusters/{clusterUuid}/projects/metricsdeprecated

Get metrics data for all projects.

getProjectsMetrics 5 params → 200401403404500503

GET

/v1/k8s/clusters/{clusterUuid}/projects/{projectId}/metricsdeprecated

Get metrics data for a specific project.

getProjectMetrics 6 params → 200401403404500503

POST

/v1/k8s/clusters/{clusterId}/projectsdeprecated

Create a new project.

createProject 2 params body → 200400409

GET

/v1/k8s/clusters/{clusterId}/projectsdeprecated

List all projects and their details.

getProjects 3 params → 200

PUT

/v1/k8s/clusters/{clusterId}/projects/{id}deprecated

Update a project.

updateProject 3 params body → 200400404409

DELETE

/v1/k8s/clusters/{clusterId}/projects/{id}deprecated

Delete a project.

deleteProject 2 params → 200404

GET

/v1/k8s/clusters/{clusterId}/projects/{id}deprecated

List details of a specific project.

getProject 3 params → 200404

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are ProjectCommonFields (12 properties), ProjectStatus (7 properties), Resources (5 properties), SchedulingRules (5 properties). Each schema is shown below with its type and property counts.

ProjectEffective

object

3 properties

NodePoolsQuotaStatuses

array

The current quota status for each node pool. Supported only for cluster versions 2.15+ or higher.

Resource

object

3 properties

Error

object

3 properties 2 required

units

string

ProjectName1

string

project

object

3 properties 2 required

TelemetryResponse

object

3 properties 3 required

ClusterId

string

The id of the cluster.

Project2

ResourcesDataOvertime

NodePoolAssignedResourcesCreate

object

4 properties 1 required

MeasurementResponse

object

3 properties 2 required

ProjectStatus

object

7 properties

OvertimeRangeData

object

Average data for the specified time range, or for the lifetime of the project/department if it exists for less than the time range.

4 properties

ProjectPhase

string

projects

object

2 properties 1 required

CountResponse

object

1 property 1 required

ProjectUpdateRequest

ClusterName

string

AssignedResources

object

4 properties

ResourceData

object

quota equals to the given resources and allocated equal to the real count of used resources

3 properties 2 required

NodePoolAssignedResources

1 required

SchedulingRules

object

5 properties

Resource1

object

3 properties

NodepoolName

string

ProjectCreationRequest

DepartmentProjectParent

object

Department or project parent

3 properties 2 required

OrgUnitMetricType

string

Specify which metric data to request.

ProjectFilterSortFields

string

ProjectStatus1

object

3 properties

NodeTypesPerWorkload

object

3 properties

DataUpdatableFields

object

Updatable fields

4 properties 1 required

ProjectId1

integer

QuotaStatusResourceList

object

3 properties

OvertimeData

object

3 properties

JobsNodeAffinity

object

2 properties

NodePoolResources

object

2 properties 1 required

Project1

object

3 properties 2 required

ResourcesNullable

object

5 properties

NodeTypeForProject

object

2 properties

QuotaStatusResource

object

3 properties

TotalResources

object

3 properties

OrgUnitTelemetryType

string

Select a telemetry type.

QuotaStatus

object

Sum of all quota statuses of all the node pools

3 properties

NodePoolQuotaStatus

object

4 properties

NonNullResource

object

3 properties

TimeRange

object

Overtime metrics data. Returned only if both start and end query parameters are set.

1 property 1 required

QuotaStatusNodePool

MetricsResponse

object

1 property 1 required

NodeAffinity

object

2 properties

ProjectUpdateRequest1

ProjectCreateRequest

2 required

Project

DepartmentId

integer

The id of the department

DepartmentName

string

ResourcePermissions

object

3 properties

ResourcesData

object

4 properties 4 required

ResourcesUpdateRequest

array

Resources assigned to this Project per Node Pool

Resources

object

5 properties 1 required

ProjectCommonFields

object

12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API

AE Profile APIs.io

NVIDIA Run:ai Access rules API

AE Profile APIs.io

NVIDIA Run:ai Administrator Command Line Interface API

AE Profile APIs.io

NVIDIA Run:ai AI Applications API

AE Profile APIs.io

NVIDIA Run:ai Applications API

AE Profile APIs.io

NVIDIA Run:ai AuditLogs API

AE Profile APIs.io

NVIDIA Run:ai Clusters API

AE Profile APIs.io

NVIDIA Run:ai Compute API

AE Profile APIs.io

NVIDIA Run:ai ConfigMap API

AE Profile APIs.io

NVIDIA Run:ai Credentials API

AE Profile APIs.io

NVIDIA Run:ai Datasources API

AE Profile APIs.io

NVIDIA Run:ai Datavolumes API

AE Profile APIs.io

#Projects

← Back to N APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

NVIDIA Run:ai Projects API

Metadata

Authentication & Security 1

Paths & Operations 17

Schemas 61

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

NVIDIA Run:ai Projects API

Metadata

Authentication & Security 1

Paths & Operations 17

Schemas 61

Specification

Source

More from NVIDIA Run:ai 12

API Details

Provider

Explore more