POST
/
crawl
curl --request POST \
  --url https://api.firecrawl.dev/v0/crawl \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "crawlerOptions": {
    "includes": [
      "<string>"
    ],
    "excludes": [
      "<string>"
    ],
    "generateImgAltText": false,
    "returnOnlyUrls": false,
    "maxDepth": 123,
    "mode": "default",
    "ignoreSitemap": false,
    "limit": 10000,
    "allowBackwardCrawling": false,
    "allowExternalContentLinks": false
  },
  "pageOptions": {
    "headers": {},
    "includeHtml": false,
    "includeRawHtml": false,
    "onlyIncludeTags": [
      "<string>"
    ],
    "onlyMainContent": false,
    "removeTags": [
      "<string>"
    ],
    "replaceAllPathsWithAbsolutePaths": false,
    "screenshot": false,
    "fullPageScreenshot": false,
    "waitFor": 0
  }
}'
{
  "jobId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

200
application/json

Successful response

The response is of type object.