Skip to main content
Use the Mintlify Index REST API to retrieve technical knowledge for applications and agents. The API supports three retrieval patterns:
  • context assembles source-cited content within a token budget.
  • search returns ranked documentation and web results.
  • contents retrieves content for selected Mintlify result IDs or result URLs.
The REST API requires an API key for your organization. The public Index MCP server does not require an API key.

Base URL

Send REST API requests to:
Append an endpoint path to this base URL, for example /context, /search, or /contents.

Authentication

Authenticate each request with an Index API key in the Authorization header:
Index API keys begin with mint_us_.
1

Create an Index API key

Open the API keys page in your dashboard and create an Index API key.If this key type is unavailable, your organization does not have access to the Index REST API.
2

Store the key securely

Save the key in a server-side environment variable. Mintlify only displays the complete key when you first create it. Store it securely.
Do not expose an Index API key in client-side code or commit it to version control.
3

Build context

Send your first request to the context endpoint:
A successful response includes assembled context with source URLs, the number of results used, and the output token count.

Rate limits

REST API limits apply per Mintlify organization. All API keys in an organization share the same limit: Requests exceeding either limit return 429 Too Many Requests. Use exponential backoff before retrying.

Errors