Search documentation

Search your documentation programmatically and retrieve relevant pages matching the query.

POST /v1/search/{domain}

Search documentation

cURL

curl --request POST \
  --url https://api.mintlify.com/discovery/v1/search/{domain} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "pageSize": 10,
  "scoreThreshold": 0.5,
  "filter": {
    "version": "<string>",
    "language": "<string>"
  }
}
'

200

[
  {
    "content": "<string>",
    "path": "<string>",
    "metadata": {}
  }
]

Authorizations

Authorization · string · header · required

The Authorization header expects a Bearer token. Use 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.

Path Parameters

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.

Body

application/json

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.

scoreThreshold · number

Minimum relevance score for results. Only results with a score at or above this threshold are returned. Must be between 0 and 1.

Required range: 0 <= x <= 1

filter · object

Optional filtering parameters to narrow search results.

Show child attributes

Response

200 - application/json

Search results

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.