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 NIM Health API

Liveness, readiness, and startup probes exposed by self-hosted NIM containers (/v1/health/live, /v1/health/ready) and a Prometheus /v1/metrics scrape endpoint for GPU utilization, request latency, and queue depth. Drives Kubernetes pod lifecycle and HPA scaling via the NIM Operator.

NVIDIA NIM Health API is one of 11 APIs that NVIDIA NIM publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Health, Observability, and Kubernetes. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2026-05-25.

Requests are made against 2 base URLs: https://integrate.api.nvidia.com, http://localhost:8000.

3 operations 3 paths 1 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2026-05-25
Servers
https://integrate.api.nvidia.com
http://localhost:8000
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

NVIDIA NIM Health API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (nvapi-...) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Health 3

Liveness, readiness, and metrics probes

GET
/v1/health/live
Liveness Probe
getLiveness → 200503
GET
/v1/health/ready
Readiness Probe
getReadiness → 200503
GET
/v1/metrics
Prometheus Metrics
getMetrics → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is HealthStatus (2 properties). Each schema is shown below with its type and property counts.

HealthStatus
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nvidia-nim-health-api-openapi.yml Raw ↑

Other APIs NVIDIA NIM publishes across the network.

NVIDIA NIM Completions API
NVIDIA NIM Embeddings API
NVIDIA NIM Reranking API
NVIDIA NIM Models API
NVIDIA NIM Vision Language Models API
NVIDIA NIM Biology (BioNeMo) API
NVIDIA NIM ASR API
NVIDIA NIM Chat API
NVIDIA NIM Images API
NVIDIA NIM TTS API