How to Authenticate to the API

NVIDIA Run:ai APIs are accessed using bearer tokens. A token can be obtained using an access key, which serves as the authentication method for both users and service accounts.

An access key consists of a client ID and client secret, which are used to generate an access token for API authentication. Once a token is obtained, it can be included in the Authorization header of subsequent API requests.

To create service accounts for your organization, see Service accounts
To create your own access keys, see User access keys

Assign Access Rules

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 Access rules. Make sure you assign the correct rules to your service account. Use the Roles to assign the correct access rules.

Request an API Token

Use the client credentials created to get a temporary token to access NVIDIA Run:ai as follows.

Example Command to Get an API Token

Replace <COMPANY-URL> below with:

For SaaS installations, use <tenant-name>.run.ai
For self-hosted use the NVIDIA Run:ai user interface URL.

curl -X POST \ 
  'https://<COMPANY-URL>/api/v1/token' \ 
  --header 'Accept: */*' \ 
  --header 'Content-Type: application/json' \ 
  --data-raw '{ 
  "grantType":"client_credentials", 
  "clientId":"<CLIENT ID>", 
  "clientSecret" : "<CLIENT SECRET>" 
}'

import requests 
import json 
reqUrl = "https://<COMPANY-URL>/api/v1/token" 
headersList = { 
 "Accept": "*/*", 
 "Content-Type": "application/json" 
} 
payload = json.dumps({ 
  "grantType":"client_credentials", 
  "clientId":"<CLIENT ID>", 
  "clientSecret" : "<CLIENT SECRET>" 
}) 
response = requests.request("POST", reqUrl, data=payload, headers=headersList) 
print(response.text)

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    url := "https://<COMPANY-URL>/api/v1/token"
    payload := map[string]string{
        "grantType":    "client_credentials",
        "clientId":     "<CLIENT ID>",
        "clientSecret": "<CLIENT SECRET>",
    }
    jsonPayload, err := json.Marshal(payload)
    if err != nil {
        panic(err)
    }

    req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonPayload))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Accept", "*/*")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println(string(body))
}

Response

The API response will look as follows:

{
  "accessToken": "<TOKEN>", 
}

To call NVIDIA Run:ai REST APIs, the application must pass the retrieved accessToken as a Bearer token in the Authorization header of your HTTP request.

Additional Code Examples

For more comprehensive code examples demonstrating how to authenticate and interact with the NVIDIA Run:ai API, visit the official NVIDIA Run:ai API Examples repository on GitHub.

This repository contains ready-to-use code samples in multiple programming languages, including:

These examples cover common authentication flows, API requests, and best practices for securely accessing the NVIDIA Run:ai platform. You can use them as a reference or starting point for your own integrations.

PreviousHTTP Status Codes NextNVIDIA Run:ai API Policy

Last updated 6 days ago

Good night

hashtagAssign Access Rules

hashtagRequest an API Token

hashtagExample Command to Get an API Token

hashtagResponse

hashtagAdditional Code Examples

Assign Access Rules

Request an API Token

Example Command to Get an API Token

Response

Additional Code Examples