Search across documentation and the web

POST

curl --request POST \
  --url https://api.mintlify.com/universal-search/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "How do I create a Stripe charge?",
  "numResults": 10,
  "text": {
    "maxCharacters": 4000
  }
}
'

{
  "requestId": "<string>",
  "results": [
    {
      "id": "<string>",
      "url": "<string>",
      "title": "<string>",
      "text": "<string>",
      "score": 123,
      "siteName": "<string>",
      "breadcrumbs": [
        "<string>"
      ],
      "publishedDate": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Universal search runs a single query against Mintlify-hosted documentation and the wider web, then returns a merged, ranked list of results. Use it to power in-product search experiences, agent tools, or retrieval pipelines that need to reach beyond a single deployment. Universal search requires the Universal Search entitlement. Contact sales to enable it for your organization.

Authentication

Authenticate with a universal search API key. Generate one on the API keys page in your dashboard. Universal search API keys are separate from admin and assistant API keys and are only accepted at /universal-search/v1 endpoints.

Authorizations

Authorization

string

header

required

The Authorization header expects a Bearer token. Use a universal search API key. Generate one on the API keys page in your dashboard.

Body

application/json

query

string

required

The search query to run. Must be a non-empty string.

numResults

integer

required

The maximum number of results to return. Must be between 1 and 20.

Required range: 1 <= x <= 20

text

Controls whether page content is returned with each result. Omit or set to false to return only metadata. Set to true to return the full stitched page content. Pass an object with maxCharacters to return content truncated to a character limit. Truncation preserves valid Markdown by closing open code fences.

includeDomains

string[]

Restrict web results to these domains. Mintlify-hosted results are unaffected.

Minimum array length: 1

excludeDomains

string[]

Exclude web results from these domains. Mintlify-hosted results are unaffected.

Minimum array length: 1

Response

Search results.

requestId

string

required

A unique identifier for this request. Include when contacting support.

results

object[]

required

The merged list of results, ranked by relevance. Results with source: "mintlify" come from Mintlify-hosted documentation; results with source: "web" come from the wider web.

Show child attributes

Get page content

Assemble a context payload for RAG

⌘I

curl --request POST \
  --url https://api.mintlify.com/universal-search/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "How do I create a Stripe charge?",
  "numResults": 10,
  "text": {
    "maxCharacters": 4000
  }
}
'

{
  "requestId": "<string>",
  "results": [
    {
      "id": "<string>",
      "url": "<string>",
      "title": "<string>",
      "text": "<string>",
      "score": 123,
      "siteName": "<string>",
      "breadcrumbs": [
        "<string>"
      ],
      "publishedDate": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

API reference

Admin

Agent

Assistant

Universal search

Analytics

Static export

Search across documentation and the web

Authentication

Authorizations

Body

Response

​Authentication

Authorizations

Body

Response

Authentication