Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NVIDIA Run:ai Users API

The Users API from NVIDIA Run:ai — 6 operation(s) for users.

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

This API exposes 8 operations across 6 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version latest.

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

8 operations 6 paths 7 schemas 1 DELETE3 GET4 POST

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
Resource Areas
1

Authentication & Security 1

NVIDIA Run:ai Users 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 8

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

Users 8
GET
/api/v1/users
Get users.
get_users 7 params → 200400401403500503
POST
/api/v1/users
Create a local user.
create_user body → 201400401403409500503
GET
/api/v1/users/count
Count users
count_users 2 params → 200400401403503
POST
/api/v1/users/{userId}/logout
Logout a user.
logout_user 1 param → 200400401403404500503
POST
/api/v1/users/{userId}/password
Reset a user's password.
reset_user_password 1 param → 200400401403404500503
GET
/api/v1/users/{userId}
Get a user by id.
get_user_by_id 1 param → 200400401403404500503
DELETE
/api/v1/users/{userId}
Delete a user by id.
delete_user_by_id 1 param → 204400401403404500503
POST
/api/v1/me/password
change user password
change_user_password body → 200400401403404500503

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are User2 (8 properties), UserPostResponse (3 properties), UserCreationRequest1 (3 properties), Error (3 properties). Each schema is shown below with its type and property counts.

UserChangePasswordRequest
object
2 properties 2 required
Error
object
3 properties 2 required
UserCreationRequest1
object
3 properties 1 required
UsersFilterSortFields
string
Users1
array
User2
object
8 properties 7 required
UserPostResponse
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-users-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 AuditLogs API
NVIDIA Run:ai Clusters API
NVIDIA Run:ai Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API