About Getting Started with NIM Metadata API#

The NIM Metadata API requires no installation and no credentials. You need an HTTP client and the repository path and tag of the NIM microservice you want to inspect. Review the Prerequisites to confirm what you need, then make your first request from the Quickstart.

The following table describes the paths through this documentation by what you are trying to accomplish:

Your Goal

Start Here

Then Read

Make one request and read the response

Quickstart

Response Fields

Decide whether a NIM microservice fits your GPUs

Choose a Profile for Your Hardware

Core Concepts Overview

Build a client or agent against the API

Notes for Automated Agents

Current Limitations

Look up an endpoint or a field

Reference Overview

Endpoints

Resolve an unexpected response

Troubleshooting

Endpoints

Choose Your Path#

Explore the following resources to get started with the NIM Metadata API.

Prerequisites

Confirm what you need before your first request, including the base URL and the identifiers for a NIM microservice.

get-started

NIM Metadata API Prerequisites
Quickstart

Make your first request, read the response, and understand the two shapes a profile can take.

tutorial

Quickstart for NIM Metadata API
Choose a Profile for Your Hardware

Follow a deterministic procedure for selecting a profile that fits the GPUs you have.

tutorial

Choose a Profile for Your Hardware
Core Concepts Overview

Understand profiles, GPU targeting, and why an absent field means unknown.

concepts

Core Concepts Overview for NIM Metadata API