Search documentation
POST
/
v1
/
search
/
Search documentation
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>",
"tag": "<string>",
"groups": [
"<string>"
]
}
}
'[
{
"content": "<string>",
"path": "<string>",
"metadata": {}
}
]Rate limits
Section titled “Rate limits”- 10,000 requests per Mintlify organization per hour
Authorizations
Section titled “Authorizations”Authorization
string
header
required
The Authorization header expects a Bearer token. Use an assistant API key. Generate one on the API keys page in your dashboard. In production, proxy requests through your backend rather than embedding the key in client-side code.
Path Parameters
Section titled “Path Parameters”domain
string
required
The domain identifier from your domain.mintlify.site URL. Can be found at the end of your dashboard URL. For example, app.mintlify.com/organization/domain has a domain identifier of domain.
application/json
query
string
required
The search query to execute against your documentation content.
pageSize
integer
default:10
Number of search results to return. Must be between 1 and 50. Defaults to 10 if not specified.
Required range: 1 <= x <= 50
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
Section titled “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.
⌘I