Sign in
Fetch

Fetch JSON Mode

Fetch a URL and return a structured JSON response containing page metadata, Markdown, State JSON, and search results when requested.

post/v1/fetch/json

Query parameters

includestring

Include Options for the response. Use a comma-separated list with appendix for Appendix and statejson for State JSON. Defaults to State JSON when omitted; use include= for Markdown only. For search requests without a URL include parameter, the request body include fields define the search corpus.

Example:appendix

Include Options for the response. Use a comma-separated list with appendix for Appendix and statejson for State JSON. Defaults to State JSON when omitted; use include= for Markdown only. For search requests without a URL include parameter, the request body include fields define the search corpus.

Request body

urlstring required

The URL to fetch content from (http or https only)

Example request

{
  "url": "https://www.stripe.com/docs/api",
  "include": {
    "html": true,
    "markdown": true,
    "screenshot": true,
    "links": true,
    "meta": true,
    "json": true,
    "appendix": true
  },
  "search": {
    "query": "pricing plans",
    "maxResults": 5,
    "minScore": 0.6
  },
  "browserConfig": {
    "scrollFullPage": true
  }
}

Response

Fetch JSON Mode response for /v1/fetch/json. Mirrors the Markdown response as discrete fields for JSON-native consumers.

markdownstring required

Main content body from the text/markdown response, without front-matter or evidence sections.

Example response

{
  "data": {
    "assets": [
      {
        "id": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "placeholder": "expand-asset:data-url:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "archiveKey": "data-url:sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "mimeType": "image/svg+xml",
        "sha256": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
        "bytes": 312
      }
    ],
    "screenshot": {
      "url": "https://s3.amazonaws.com/bucket/snapshots/abcd/screenshot.jpeg?X-Amz-Signature=...",
      "fullPage": true
    }
  }
}

Changes

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