Search documentation

Perform semantic and keyword searches across your documentation

Perform semantic and keyword searches across your documentation with configurable filtering and pagination.

cURL

curl -X POST https://api.mintlify.com/discovery/v1/search/{domain} \
  -H "Authorization: Bearer YOUR_ASSISTANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "how to authenticate",
    "pageSize": 10,
    "filter": {
      "version": "v2",
      "language": "en"
    }
  }'

Endpoint

domain · string · required

The domain identifier from your domain.mintlify.app URL. Can be found at the end of your dashboard URL. For example, dashboard.mintlify.com/organization/domain has a domain identifier of domain.

Request Body

query · string · required

The search query to execute against your documentation content.

pageSize · number · default: "10"

Number of search results to return. Defaults to 10 if not specified.

filter · object

Optional filtering parameters to narrow search results.

Show properties

version · string

Filter results by documentation version.

language · string

Filter results by content language.

Response

results · array

Array of search results.

Show result object

content · string

The matching content from your documentation.

path · string

The path or URL to the source document.

metadata · object

Additional metadata about the search result.

Response

[
  {
    "content": "To authenticate with the API, include your API key in the Authorization header...",
    "path": "/api-reference/authentication",
    "metadata": {
      "title": "Authentication",
      "description": "Learn how to authenticate with our API"
    }
  },
  {
    "content": "API keys can be generated from your dashboard settings...",
    "path": "/api-reference/api-keys",
    "metadata": {
      "title": "API Keys",
      "description": "Manage your API keys"
    }
  }
]

Authentication

This endpoint requires an assistant API key (prefixed with mint_dsc_). This is a public key safe for use in client-side code. Generate one on the API keys page in your dashboard.