> This page is for version 1.0.0 (Latest) (default).
> For other versions, use one of these documentation indexes:
> - 1.0.0 (Latest) (default): https://docs.nvidia.com/nim/metadata-api/1.0.0/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nim/metadata-api/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nim/metadata-api/_mcp/server.

# About Getting Started with NIM Metadata API

> Choose your path through the NIM Metadata API documentation, whether you are evaluating hardware fit by hand or building an automated integration.

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](/nim/metadata-api/get-started/prerequisites) to confirm what you
need, then make your first request from the [Quickstart](/nim/metadata-api/get-started/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](/nim/metadata-api/get-started/quickstart)                          | [Response Fields](/nim/metadata-api/reference/response-fields)  |
| Decide whether a NIM microservice fits your GPUs | [Choose a Profile for Your Hardware](/nim/metadata-api/guides/choose-a-profile) | [Core Concepts Overview](/nim/metadata-api/about/core-concepts) |
| Build a client or agent against the API          | [Notes for Automated Agents](/nim/metadata-api/guides/automated-agents)         | [Current Limitations](/nim/metadata-api/reference/limitations)  |
| Look up an endpoint or a field                   | [Reference Overview](/nim/metadata-api/reference/reference-overview)            | [Endpoints](/nim/metadata-api/reference/endpoints)              |
| Resolve an unexpected response                   | [Troubleshooting](/nim/metadata-api/troubleshooting)                            | [Endpoints](/nim/metadata-api/reference/endpoints)              |

## Choose Your Path

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

#### [Prerequisites](/nim/metadata-api/1.0.0/get-started/prerequisites)

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

get-started

#### [Quickstart](/nim/metadata-api/1.0.0/get-started/quickstart)

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

tutorial

#### [Choose a Profile for Your Hardware](/nim/metadata-api/1.0.0/guides/choose-a-profile)

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

tutorial

#### [Core Concepts Overview](/nim/metadata-api/1.0.0/about/core-concepts)

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

concepts