Is this page helpful?

NIM Metadata API in the NVIDIA NIM Ecosystem#

The NIM Metadata API helps developers and automated tooling select profiles within the NVIDIA NIM ecosystem before downloading containers. For API capabilities, refer to Overview; for the publication and request flow, refer to Architecture Overview.

Understanding the NVIDIA NIM Ecosystem#

NVIDIA NIM microservices package models with inference backends and deployable profiles. The NGC Catalog identifies available containers and tags, while metadata and repository APIs expose information used to evaluate them.

The NIM Metadata API’s role is to return tag-level profiles, hardware requirements, release details, and capabilities when those values were recorded at publish time. It complements container-level catalog information and the deployment documentation for each microservice.

Choosing an Information Source#

Choose the information source that matches your question:

Source	Use When	Information Provided
NGC Catalog and registry search	Discover a NIM microservice and identify its repository and tags.	Container identity and catalog discovery, including GPU filters.
NIM Metadata API	Compare profiles for a specific microservice and tag before deployment.	Tag-level hardware requirements, precision, backend, parallelism, and capabilities, when populated.
NGC repository endpoints	Retrieve information about a microservice as a whole.	Repository-level fields such as `name`, `nim_type`, `supported_models`, and `sdk_example_url`.
NGC GPU metadata endpoint	Display a GPU name for a PCI device identifier.	Recorded subsystem variants and their `displayName` values.
Microservice documentation and support matrix	Deploy the selected profile or investigate incomplete metadata coverage.	Microservice-specific deployment instructions and supported hardware.

The metadata API and repository endpoints answer different questions. Make both calls when you need tag-level profiles and container-level details. For endpoint forms and authentication considerations, refer to Related Endpoints and Registry Search.

How the Information Sources Work Together#

Use the sources in the following order when planning a deployment:

Identify the NIM microservice and container tag in the NGC Catalog.
Query the NIM Metadata API for that repository and tag.
Compare available profiles against hardware and workload requirements.
Retrieve repository information or GPU display names when needed.
Follow the microservice’s deployment instructions with the selected profile_id.

Metadata access and container entitlement are separate. Reading metadata does not grant access to pull the container. If metadata is unavailable, consult the microservice’s documentation rather than assuming that the container is unavailable or unsupported.

Next Steps#

Continue with the resource that matches your goal:

Make Your First Request

Query a microservice and read the metadata response.

Quickstart for NIM Metadata API

Select a Profile

Apply hardware constraints and record a profile identifier.

Choose a Profile for Your Hardware

Query Complementary Endpoints

Retrieve container information and resolve GPU identifiers.

Related Endpoints and Registry Search

Handle Missing Metadata

Diagnose status codes and unrecorded requirements.

Troubleshooting NIM Metadata API