Sign in
Fetch

Highlights

Use Highlights to search a previous Fetch by snapshotId without starting a new browser capture.

post/v1/fetch/search

Request body

snapshotIdstring required

Snapshot ID returned by a previous Fetch response.

Example request

{
  "search": {
    "query": "pricing plans",
    "maxResults": 5,
    "minScore": 0.6
  },
  "include": {
    "html": true,
    "markdown": true,
    "screenshot": true,
    "links": true,
    "meta": true,
    "json": true,
    "appendix": true
  }
}

Response

FetchSnapshotSearchResult

snapshotIdstring required

Snapshot ID searched.

durationMsnumber required

Duration of the search operation in milliseconds.

playgroundstring required

Public playground URL for the searched snapshot. Use its origin to build citation links for the snippets below.

Example response

{
  "response": {
    "url": "https://stripe.com/docs/api",
    "originStatusCode": 200,
    "redirectStatusCode": 301,
    "headers": {
      "content-type": "text/html; charset=utf-8"
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.