OpenAPI Specification
openapi: 3.0.3
info:
version: latest
description: '# Introduction
The NVIDIA Run:ai Control-Plane API reference is a guide that provides an easy-to-use programming interface for adding various tasks to your application, including workload submission, resource management, and administrative operations.
NVIDIA Run:ai APIs are accessed using *bearer tokens*. To obtain a token, you need to create a **Service account** through the NVIDIA Run:ai user interface.
To create a service account, in your UI, go to Access → Service Accounts (for organization-level service accounts) or User settings → Access Keys (for user access keys), and create a new one.
After you have created a new service account, you will need to assign it access rules.
To assign access rules to the service account, see [Create access rules](https://run-ai-docs.nvidia.com/saas/infrastructure-setup/authentication/accessrules#create-or-delete-rules).
Make sure you assign the correct rules to your service account. Use the [Roles](https://run-ai-docs.nvidia.com/saas/infrastructure-setup/authentication/roles) to assign the correct access rules.
To get your access token, follow the instructions in [Request a token](https://run-ai-docs.nvidia.com/saas/reference/api/rest-auth/#request-an-api-token).
'
title: NVIDIA Run:ai Access Keys AI Applications API
x-logo:
url: https://api.redocly.com/registry/raw/runai-xq8/saas/latest/public/runai-logo-api.png
altText: NVIDIA Run:ai
href: https://run.ai
license:
name: NVIDIA Run:ai
url: https://www.nvidia.com/en-us/agreements/enterprise-software/nvidia-software-license-agreement/
servers:
- url: https://app.run.ai
security:
- bearerAuth: []
tags:
- name: AI Applications
description: AI Applications.
paths:
/api/v1/ai-applications:
get:
summary: List AI applications. [Experimental]
description: List AI applications.
operationId: list_applications
tags:
- AI Applications
parameters:
- $ref: '#/components/parameters/ApplicationQueryVerbosity'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/SortOrder'
- $ref: '#/components/parameters/ApplicationsSort'
- $ref: '#/components/parameters/ApplicationsFilter'
- $ref: '#/components/parameters/Search'
responses:
'200':
description: ok.
content:
application/json:
schema:
type: object
required:
- applications
properties:
next:
type: integer
example: 1
applications:
$ref: '#/components/schemas/Applications1'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'503':
$ref: '#/components/responses/503ServiceUnavailable'
/api/v1/ai-applications/count:
get:
summary: Count AI applications. [Experimental]
description: Get the total number of AI applications.
operationId: count_applications
tags:
- AI Applications
parameters:
- $ref: '#/components/parameters/ApplicationsFilter'
- $ref: '#/components/parameters/Search'
responses:
'200':
description: Executed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/CountResponse'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'500':
$ref: '#/components/responses/500InternalServerError'
'503':
$ref: '#/components/responses/503ServiceUnavailable'
/api/v1/ai-applications/{aiApplicationId}:
get:
summary: Get AI application. [Experimental]
description: Get AI application.
operationId: get_application
tags:
- AI Applications
parameters:
- $ref: '#/components/parameters/ApplicationId'
responses:
'200':
description: ok.
content:
application/json:
schema:
$ref: '#/components/schemas/Application1'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'503':
$ref: '#/components/responses/503ServiceUnavailable'
components:
parameters:
ApplicationsSort:
name: sortBy
in: query
required: false
description: Sort results by a parameter.
schema:
type: string
enum:
- clusterId
- name
- projectId
- projectName
- source
- type
ApplicationsFilter:
name: filterBy
in: query
required: false
description: Filter results by a parameter. Use the format field-name operator value. Operators are `==` Equals, `!=` Not equals, `<=` Less than or equal, `>=` Greater than or equal, `=@` contains, `!@` Does not contain, `=^` Starts with and `=$` Ends with. Dates are in ISO 8601 timestamp format and available for operators `==`, `!=`, `<=` and `>=`.
schema:
type: array
items:
type: string
pattern: ^(clusterId|name|projectId|projectName|source|type)(==|!=|<=|>=|=@|!@|=\^|=\$).+$
example:
- name!=some-name
explode: false
Limit:
name: limit
in: query
required: false
description: The maximum number of entries to return.
schema:
type: integer
format: int32
default: 50
minimum: 1
maximum: 500
ApplicationQueryVerbosity:
name: verbosity
in: query
required: false
description: response verbosity level.
example: full
schema:
$ref: '#/components/schemas/ApplicationVerbosity'
Search:
name: search
in: query
required: false
description: Filter results by a free text search.
schema:
type: string
example: test project
ApplicationId:
name: aiApplicationId
in: path
required: true
description: The unique identifier of the application.
schema:
type: string
format: uuid
SortOrder:
name: sortOrder
in: query
required: false
description: Sort results in descending or ascending order.
schema:
type: string
enum:
- asc
- desc
default: asc
Offset:
name: offset
in: query
required: false
description: The offset of the first item returned in the collection.
schema:
type: integer
format: int32
example: 100
schemas:
Application1:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
source:
type: string
type:
type: string
phase:
type: string
projectId:
type: string
projectName:
type: string
resources:
type: array
items:
$ref: '#/components/schemas/ApplicationResource'
allocatedResources:
$ref: '#/components/schemas/ApplicationAllocatedResources'
requestedResources:
$ref: '#/components/schemas/ApplicationRequestResources'
Error:
required:
- code
- message
properties:
code:
type: integer
minimum: 100
maximum: 599
message:
type: string
details:
type: string
example:
code: 400
message: Bad request - Resource should have a name
CountResponse:
type: object
required:
- count
properties:
count:
type: integer
format: int64
example: 1
ApplicationVerbosity:
type: string
enum:
- brief
- full
default: brief
ApplicationAllocatedResources:
type: object
nullable: true
properties:
gpu:
type: number
nullable: true
format: double
example: 1.5
description: States the number of GPUs allocated for the created workloads.
gpuMemory:
type: string
pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$
nullable: true
example: 200Mi
cpu:
type: number
nullable: true
format: double
description: States the amount of CPU cores used by the workloads running.
example: 0.5
cpuMemory:
type: string
pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$
nullable: true
example: 0B
RequestResourceCores:
type: object
properties:
limit:
type: number
nullable: true
format: double
example: 1.5
request:
type: number
nullable: true
format: double
example: 1
nullable: true
ApplicationResource:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
kind:
type: string
ApplicationRequestResources:
type: object
nullable: true
properties:
gpu:
$ref: '#/components/schemas/RequestResourceCores'
gpuMemory:
$ref: '#/components/schemas/RequestResourceQuantity'
cpu:
$ref: '#/components/schemas/RequestResourceCores'
cpuMemory:
$ref: '#/components/schemas/RequestResourceQuantity'
Applications1:
type: array
items:
$ref: '#/components/schemas/Application1'
RequestResourceQuantity:
type: object
properties:
limit:
type: string
nullable: true
pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$
example: 2G
request:
type: string
nullable: true
pattern: ^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$
example: 200M
nullable: true
responses:
500InternalServerError:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 500
message: Something went wrong.
403Forbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 403
message: You do not have sufficient permissions.
503ServiceUnavailable:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 503
message: Please try again in few minutes.
401Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 401
message: Issuer is not familiar.
400BadRequest:
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: 400
message: Required parameter is missing
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Bearer authentication
x-tagGroups:
- name: Organizations
tags:
- Clusters
- Departments
- Reports
- NodePools
- Nodes
- Projects
- Tenant
- Logo
- Researcher Command Line Interface
- Researcher Command Line Interface Deprecated
- Administrator Command Line Interface
- Network Topologies
- name: Authentication and Authorization
tags:
- Access Keys
- Access rules
- Permissions
- Applications
- Service Accounts
- Roles
- Tokens
- Users
- User Applications
- Idps
- Me
- Settings
- Org unit
- name: Audit
tags:
- AuditLogs
- name: Datavolumes
tags:
- Datavolumes
- name: Workloads
tags:
- Events
- Pods
- Workloads
- Workloads V2
- NVIDIA NIM
- Workspaces
- Trainings
- Inferences
- Revisions
- Distributed
- Workloads batch
- Workload properties
- Workload templates
- Distributed Inferences
- name: Workload assets
tags:
- Compute
- Credentials
- Datasources
- Environment
- Storage Classes
- Storage Class Configuration
- Git
- HostPath
- NFS
- PVC
- Registry
- S3
- ConfigMap
- Secret
- Template
- name: Policies
tags:
- Policy
- name: Notifications
tags:
- Notification State
- Notification Types
- NotificationChannels
- Subscriptions
- name: AI Applications
tags:
- AI Applications