---
title: "Start an async crawl job"
method: POST
path: "/v1/crawl"
tags: ["crawl"]
---

# Start an async crawl job

`POST /v1/crawl`

## Request

- Base URL: `https://api.fastcrw.com`
- URL: `https://api.fastcrw.com/v1/crawl`
- Auth: one of:
  - HTTP bearer
  - none

## Request body

- CrawlRequest
  - `url` string, uri, required
  - `maxPages` integer
  - `maxDepth` integer
  - `headers` object: Custom HTTP request headers applied to every page the crawl fetches. On a browser render they apply to every request the page makes, subresources included, so avoid cross-origin-sensitive credentials here.
  - `scrapeOptions` CrawlScrapeOptions: Per-page scrape settings. Every key here may also be sent at the top level; an explicit top-level value wins.
    - `formats` CrawlOutputFormat[]
    - `onlyMainContent` boolean
    - `jsonSchema` object: JSON Schema for structured extraction, with `formats: ["json"]`.
    - `renderJs` boolean, nullable: null = auto-detect, true = force JS, false = never use a browser tier.
    - `waitFor` integer: Milliseconds to wait after JS rendering on each page.
    - `headers` object: Custom HTTP request headers applied to every page the crawl fetches. On a browser render they apply to every request the page makes, subresources included, so avoid cross-origin-sensitive credentials here.
  - `formats` CrawlOutputFormat[]
  - `onlyMainContent` boolean
  - `jsonSchema` object
  - `renderJs` boolean, nullable
  - `waitFor` integer
  - `renderer` 'auto' | 'lightpanda' | 'chrome' | 'chrome_proxy' | 'playwright' | 'camoufox' | 'impersonated-http'
  - `country` string: 2-letter ISO 3166-1 alpha-2 proxy egress country.
  - `proxyList` string[]
  - `proxyRotation` 'round_robin' | 'random' | 'sticky_per_host'

## Response `200`

Crawl job accepted; poll with /v1/crawl/{id}

- CrawlAccepted
  - `success` boolean, required
  - `id` string, required
  - `url` string, uri: URL to poll with GET /v1/crawl/{id}

---

[API](https://skmtc.dev/fastcrw/apis/crw-rest-api.md) · [All operations](https://skmtc.dev/fastcrw/apis/crw-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/fastcrw/apis/crw-rest-api/revisions/9bc1842aa048?raw)