API Authentication
NVIDIA DSX Air uses NGC API keys for authenticating API requests. This page covers Air-specific authentication details. For general information about NGC API keys, see the NGC API Keys documentation.
For the full API reference, navigate the API reference.
API Key Types
NGC supports two types of API keys:
For most Air API usage, a Personal Key is sufficient. Use Service Keys when you need automation that shouldn’t depend on an individual user’s account.
Generating API Keys
To generate an API key:
- Personal Key: See Generating a Personal API Key
- Service Key: See Generating a Service API Key
When generating a key, select NVIDIA Air from the services list to grant Air API access.
Using API Keys
Include your API key in the Authorization header:
Roles and Scopes
Air uses a role-based access control system managed through NGC. The Air API checks scopes to authorize requests. How you get scopes depends on the key type:
- Personal API Keys: You assign roles to users in NGC. Air automatically derives scopes from those roles.
- Service Keys: You assign scopes directly when creating the key, giving you fine-grained control.
Roles
Roles are assigned to users in your NGC organization and apply to Personal API Keys. To manage user roles, see Updating User Roles in the NGC documentation.
Scopes
Scopes are the permissions that the Air API checks to authorize requests. For Personal API Keys, scopes are derived from assigned roles. For Service Keys, you select scopes directly when generating the key.
Platform scopes (included in all Air roles):
Simulation scopes:
Image scopes:
Marketplace scopes:
Training scopes:
Role to Scope Mapping
Each role includes the platform scopes (org:read, team:read, air:access) plus the Air-specific scopes listed below.
Air User
Air Org Administrator
Includes all Air User scopes, plus:
Air Trainee
Additional roles grant additional scopes as indicated by their names.