Result content

Read Markdown or highlights with search results and handle each page’s outcome.

Set markdownOptions.enabled to true to return each result’s page as Markdown, or highlightsOptions.enabled to return only the passages relevant to your query. A search result can remain useful even when its page content cannot be read.

Request page content

Send this body to POST /web/search. See the Quickstart for authentication and SDK setup.

{
  "query": "Stripe API authentication",
  "markdownOptions": {
    "enabled": true,
    "useMainContentOnly": true,
    "includeLinks": true
  }
}

Request highlights

Highlights use the search query and read each page with the markdownOptions settings, so you can request them without Markdown.

{
  "query": "Stripe API authentication",
  "highlightsOptions": {
    "enabled": true,
    "maxCharacters": 1500
  }
}

Each result’s highlights.highlights lists passages in page order. See Highlights for the passage format.

Read each outcome

Check the result’s markdown.code and highlights.code before using their content:

Code	Meaning
SUCCESS	Page content is available.
NOT_REQUESTED	The output was not enabled.
TIMEOUT	The page exceeded its deadline.
CONTENT_TOO_LARGE	The page exceeded the content limit.
WEBSITE_ACCESS_ERROR	The page could not be accessed.
ERROR	Another extraction failure.

finalDOMState: "still-loading" indicates an incomplete render. Highlights can succeed with an empty array when no passage is relevant.

Options

markdownOptions supports includeLinks (default true), includeImages (false), shortenBase64Images (true), useMainContentOnly (false), includeFrames (false), and maxAgeMs (15 days). Use pdf for PDF parsing and page ranges. highlightsOptions.maxCharacters (default 4,000; 100–20,000) limits the combined passage length per result.

waitForMs accepts 0–30,000 ms. Each page has a default 45-second deadline; set markdownOptions.timeoutOpts to shorten it. Top-level timeoutOpts limits the whole search.

Markdown and highlights add charges; see Credits and pricing.

Keep the URL, title, and description when a content read fails. For page-specific recovery, call Scrape with appropriate waits or filters.