POST

Try POST /extract — Firecrawl API

Firecrawl playground

Extract structured data from pages using LLMs

Credentials

Firecrawl API key · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.firecrawl.dev; the proxy stores and logs nothing about them.

Body application/json

{
  "urls": [
    "https://example.com"
  ],
  "prompt": "example-prompt",
  "schema": {},
  "enableWebSearch": false,
  "ignoreSitemap": false,
  "includeSubdomains": true,
  "showSources": false,
  "scrapeOptions": {
    "formats": [
      "markdown"
    ],
    "onlyMainContent": true,
    "includeTags": [
      "example-includeTags"
    ],
    "excludeTags": [
      "example-excludeTags"
    ],
    "maxAge": 0,
    "headers": {},
    "waitFor": 0,
    "mobile": false,
    "skipTlsVerification": false,
    "timeout": 30000,
    "parsePDF": true,
    "jsonOptions": {
      "schema": {},
      "systemPrompt": "example-systemPrompt",
      "prompt": "example-prompt"
    },
    "actions": [
      {
        "type": "wait",
        "milliseconds": 0,
        "selector": "#my-element"
      }
    ],
    "location": {
      "country": "US",
      "languages": [
        "en-US"
      ]
    },
    "removeBase64Images": true,
    "blockAds": true,
    "proxy": "basic",
    "changeTrackingOptions": {
      "modes": [
        "git-diff"
      ],
      "schema": {},
      "prompt": "example-prompt",
      "tag": null
    },
    "storeInCache": true
  },
  "ignoreInvalidURLs": false
}

9 body fields

urls · required · string[] — Request body field urls.
prompt · optional · string — Prompt to guide the extraction process
schema · optional · object — Schema to define the structure of the extracted data. Must conform to [JSON Schema](https://json-schema.org/).
enableWebSearch · optional · boolean — When true, the extraction will use web search to find additional data
ignoreSitemap · optional · boolean — When true, sitemap.xml files will be ignored during website scanning
includeSubdomains · optional · boolean — When true, subdomains of the provided URLs will also be scanned
showSources · optional · boolean — When true, the sources used to extract the data will be included in the response as `sources` key
scrapeOptions · optional · object — Request body field scrapeOptions.
ignoreInvalidURLs · optional · boolean — If invalid URLs are specified in the urls array, they will be ignored. Instead of them failing the entire request, an extract using the remaining valid URLs will be performed, and the invalid URLs will be returned in the invalidURLs field of the response.