Skip to main content
POST
Use this endpoint after Search across documentation and the web when you want the full stitched Markdown for specific pages without repeating the query. Pass the id returned from a previous search, the canonical URL of a Mintlify-hosted page, or a mix of both. A single request can reference at most 20 items across urls and ids combined. When you provide maxCharacters, each page is truncated to that length while keeping the Markdown valid (open code fences are closed).

Partial success

The response always returns 200 when the request body is well-formed. Inspect the statuses array to see which inputs resolved successfully and which failed. results only contains the pages whose status is success. Error tag values:
  • not_found: The URL or ID did not match any indexed page.
  • not_synced: The source deployment has not been indexed for universal search.
  • invalid_id: The ID was malformed.
  • fetch_error: The lookup failed unexpectedly. Retry the request or contact support with the requestId.

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

At least one of urls or ids is required. A single request can reference at most 20 items across both fields combined.

urls
string<uri>[]

Canonical URLs of Mintlify-hosted pages to fetch. www and non-www variants are both matched.

Required array length: 1 - 20 elements
ids
string[]

Page IDs to fetch. Use the id returned by Search across documentation and the web.

Required array length: 1 - 20 elements
maxCharacters
integer

Maximum number of characters of page content to return per result. Truncation preserves valid Markdown by closing open code fences.

Required range: x >= 1

Response

Content lookup completed. Check statuses for per-input outcomes; the response can include partial results.

requestId
string
required

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

results
object[]
required

Successfully resolved pages, in the same shape as search results. Only inputs whose corresponding entry in statuses reports success appear here.

statuses
object[]
required

One entry per input in the request, in the order the inputs were provided. Each entry reports whether the input resolved successfully or, if not, an error tag.