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": true,
    "returnOnlyUrls": true,
    "maxDepth": 123,
    "mode": "default",
    "ignoreSitemap": true,
    "limit": 123,
    "allowBackwardCrawling": true
  },
  "pageOptions": {
    "onlyMainContent": true,
    "includeHtml": true,
    "waitFor": 123,
    "includeRawHtml": true,
    "screenshot": true,
    "headers": {},
    "removeTags": [
      "<string>"
    ],
    "replaceAllPathsWithAbsolutePaths": true,
    "parsePDF": true
  }
}'
{
  "jobId": "<string>"
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
url
string
required

The base URL to start crawling from

crawlerOptions
object
pageOptions
object

Response

200 - application/json
jobId
string