Browse documentation

Quickstart

Read your first page with the CrawlKit API.

Create an API key

Open API Keys in your dashboard and create a key. Copy it when it is shown; the full key is only displayed once.

Send a request

Run this from your terminal with your key in CRAWLKIT_API_KEY.

Scrape a page
curl https://api.crawlkit.sh/scrape \
  -H "Authorization: $CRAWLKIT_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com","formats":["markdown"]}'

Read the response

A successful response contains success, requestId and data. If the API returns 202, use data.id to fetch the job result from GET /jobs/:id. Keep requestId when investigating an error.

Choose the next operation

Search discovers public source URLs. Extract returns structured JSON. Crawl collects pages across a site. Watch checks a page on a schedule.