curl -X POST https://api.mintlify.com/discovery/v1/search/your-domain \
-H "Authorization: Bearer mint_dsc_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"query": "how to install",
"pageSize": 10,
"filter": {
"version": "v2"
}
}'
const response = await fetch(
'https://api.mintlify.com/discovery/v1/search/your-domain',
{
method: 'POST',
headers: {
'Authorization': 'Bearer mint_dsc_your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
query: 'how to install',
pageSize: 10,
filter: {
version: 'v2'
}
}),
}
);
const results = await response.json();
console.log(results);
import requests
response = requests.post(
'https://api.mintlify.com/discovery/v1/search/your-domain',
headers={
'Authorization': 'Bearer mint_dsc_your_api_key_here',
'Content-Type': 'application/json'
},
json={
'query': 'how to install',
'pageSize': 10,
'filter': {
'version': 'v2'
}
}
)
results = response.json()
print(results)
[
{
"content": "To install Mintlify, run npm install -g mintlify...",
"path": "/quickstart/installation",
"metadata": {
"title": "Installation Guide",
"version": "v2"
}
},
{
"content": "Installation steps: 1. Install Node.js 2. Run npm install...",
"path": "/getting-started",
"metadata": {
"title": "Getting Started",
"version": "v2"
}
}
]
Assistant
Search Documentation
Perform semantic and keyword searches across your documentation
POST
/
discovery
/
v1
/
search
/
{domain}
curl -X POST https://api.mintlify.com/discovery/v1/search/your-domain \
-H "Authorization: Bearer mint_dsc_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"query": "how to install",
"pageSize": 10,
"filter": {
"version": "v2"
}
}'
const response = await fetch(
'https://api.mintlify.com/discovery/v1/search/your-domain',
{
method: 'POST',
headers: {
'Authorization': 'Bearer mint_dsc_your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
query: 'how to install',
pageSize: 10,
filter: {
version: 'v2'
}
}),
}
);
const results = await response.json();
console.log(results);
import requests
response = requests.post(
'https://api.mintlify.com/discovery/v1/search/your-domain',
headers={
'Authorization': 'Bearer mint_dsc_your_api_key_here',
'Content-Type': 'application/json'
},
json={
'query': 'how to install',
'pageSize': 10,
'filter': {
'version': 'v2'
}
}
)
results = response.json()
print(results)
[
{
"content": "To install Mintlify, run npm install -g mintlify...",
"path": "/quickstart/installation",
"metadata": {
"title": "Installation Guide",
"version": "v2"
}
},
{
"content": "Installation steps: 1. Install Node.js 2. Run npm install...",
"path": "/getting-started",
"metadata": {
"title": "Getting Started",
"version": "v2"
}
}
]
Perform semantic and keyword searches across your documentation with configurable filtering and pagination.
Authentication
Requires an assistant API key (prefixed withmint_dsc_). Generate one on the API keys page in your dashboard.
The assistant API key is a public token that you can reference in frontend code.
Path Parameters
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 Parameters
string
required
The search query to execute against your documentation content.
number
default:10
Number of search results to return. Defaults to 10 if not specified.
object
Response
Returns an array of search results.string
The matching content from your documentation.
string
The path or URL to the source document.
object
Additional metadata about the search result.
curl -X POST https://api.mintlify.com/discovery/v1/search/your-domain \
-H "Authorization: Bearer mint_dsc_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"query": "how to install",
"pageSize": 10,
"filter": {
"version": "v2"
}
}'
const response = await fetch(
'https://api.mintlify.com/discovery/v1/search/your-domain',
{
method: 'POST',
headers: {
'Authorization': 'Bearer mint_dsc_your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
query: 'how to install',
pageSize: 10,
filter: {
version: 'v2'
}
}),
}
);
const results = await response.json();
console.log(results);
import requests
response = requests.post(
'https://api.mintlify.com/discovery/v1/search/your-domain',
headers={
'Authorization': 'Bearer mint_dsc_your_api_key_here',
'Content-Type': 'application/json'
},
json={
'query': 'how to install',
'pageSize': 10,
'filter': {
'version': 'v2'
}
}
)
results = response.json()
print(results)
[
{
"content": "To install Mintlify, run npm install -g mintlify...",
"path": "/quickstart/installation",
"metadata": {
"title": "Installation Guide",
"version": "v2"
}
},
{
"content": "Installation steps: 1. Install Node.js 2. Run npm install...",
"path": "/getting-started",
"metadata": {
"title": "Getting Started",
"version": "v2"
}
}
]