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

Departments, in the hierarchy of resource allocation, are above Projects. A Department can contain multiple Projects, and has its own quotas. A Department's quota supersedes the total of the Project quotas in the Department, so tt is recommended that a Department's quota be the total, or more than of all the Project quotas in the Department. For further information see, [Working with Departments](https://run-ai-docs.nvidia.com/saas/platform-management/aiinitiatives/organization/departments).

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

This API exposes 14 operations across 10 paths, and defines 63 schemas. It is described by OpenAPI 3.2.0, at version latest.

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

14 operations 10 paths 63 schemas 1 DELETE8 GET1 PATCH1 POST3 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 Departments 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 14

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

Departments 14

Departments, in the hierarchy of resource allocation, are above Projects. A Department can contain multiple Projects, and has its own quotas. A Department's quota supersedes the t…

POST
/api/v1/org-unit/departments
Create department
create_department body → 201400401403409503
GET
/api/v1/org-unit/departments
Get departments
get_departments 6 params → 200400401403503
PUT
/api/v1/org-unit/departments/{departmentId}
Update department
update_department 1 param body → 200400401403404503
GET
/api/v1/org-unit/departments/{departmentId}
Get department
get_department 1 param → 200401403404503
DELETE
/api/v1/org-unit/departments/{departmentId}
Delete department
delete_department 1 param → 204400401403404503
PUT
/api/v1/org-unit/departments/{departmentId}/resources
Update department resources
update_department_resources 1 param body → 200400401403404500503
PATCH
/api/v1/org-unit/departments/{departmentId}/resources
Patch department resources
patch_department_resources 1 param body → 200400401403404500503
GET
/api/v1/org-unit/departments/{departmentId}/metrics
Get department metrics data
get_department_metrics 6 params → 200207400401403404500503
GET
/api/v1/org-unit/departments/telemetry
Get departments telemetry
get_departments_telemetry 5 params → 200400401403503
GET
/api/v1/org-unit/departments/count
Count departments
count_departments 1 param → 200400401403503
GET
/v1/k8s/clusters/{clusterUuid}/departments/metricsdeprecated
Get metrics for all departments
getDepartmentsMetrics 5 params → 200401403404500503
GET
/v1/k8s/clusters/{clusterUuid}/departments/{departmentId}/metricsdeprecated
Get metrics for a specific department
getDepartmentMetrics 6 params → 200401403404500503
GET
/v1/k8s/clusters/{clusterId}/departmentsdeprecated
List all departments
getDepartments 3 params → 200
PUT
/v1/k8s/clusters/{clusterId}/departments/{department-id}/access-controldeprecated
Set the department admins
updateDepartmentAdmins 2 params body → 201400401403

Schemas 63

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

Resource1
object
3 properties
departments
object
2 properties 1 required
DepartmentId
integer
The id of the department
ProjectCommonFields
object
12 properties
Verbosity
string
JobsNodeAffinity
object
2 properties
QuotaStatusResourceList
object
3 properties
DepartmentCommonFields
object
5 properties
units
string
OrgUnitTelemetryType
string
Select a telemetry type.
NodepoolName
string
NodePoolResources
object
2 properties 1 required
AggregatedResources
object
Sum of all resources assigned to the projects under this department per Node Pool
4 properties 1 required
Department
TotalResources
object
3 properties
QuotaStatusResource
object
3 properties
ProjectName1
string
NodeAffinity
object
2 properties
AssignedResources
object
4 properties
NodeTypeForProject
object
2 properties
ResourceData
object
quota equals to the given resources and allocated equal to the real count of used resources
3 properties 2 required
MeasurementResponse
object
3 properties 2 required
DepartmentCreationRequest
ResourcesDataOvertime
DepartmentProjectChild
object
Department or project child
3 properties 2 required
DepartmentUpdateRequest
NodePoolAssignedResourcesCreate
object
4 properties 1 required
NodePoolAssignedResources
1 required
ResourcesNullable
object
5 properties
Error
object
3 properties 2 required
DepartmentFilterSortFields
string
TimeRange
object
Overtime metrics data. Returned only if both start and end query parameters are set.
1 property 1 required
NonNullResource
object
3 properties
ClusterName
string
ResourcesData
object
4 properties 4 required
DataDepartmentFields
Department1
object
3 properties 2 required
DepartmentForList
DataUpdatableDepartmentFields
object
Updatable fields
4 properties 1 required
ResourcesUpdateRequest
array
Resources assigned to this Project per Node Pool
MetricsResponse
object
1 property 1 required
Resource
object
3 properties
OrgUnitMetricType
string
Specify which metric data to request.
ResourcePermissions
object
3 properties
department
object
3 properties 2 required
Department2
DeservedResource
object
1 property
NodePoolsQuotaStatuses
array
The current quota status for each node pool. Supported only for cluster versions 2.15+ or higher.
ProjectStatus1
object
3 properties
DepartmentAccessControl
object
2 properties
QuotaStatus
object
Sum of all quota statuses of all the node pools
3 properties
Resources
object
5 properties 1 required
ClusterId
string
The id of the cluster.
DepartmentName
string
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
SchedulingRules
objectnull
5 properties
NodePoolQuotaStatus
object
4 properties
QuotaStatusNodePool
TelemetryResponse
object
3 properties 3 required
CountResponse
object
1 property 1 required
NodeTypesPerWorkload
object
3 properties
Project2
OvertimeData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-departments-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 Clusters API
NVIDIA Run:ai Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Distributed API
NVIDIA Run:ai Distributed Inferences API
NVIDIA Run:ai Environment API
Where this information came from

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