Crawl

POST1 credit / page (+3 if AI used)

https://api.crawlkit.sh/crawl

Discover and fetch website pages with depth, scope and page limits.

Try on Playground

Authentication

Send your Crawlkit API key directly in the Authorization header.

Authorization: ck_your_api_key

Request Parameters

Send these JSON body fields in your request payload.

Name	Type	Description
`url`	string	Public target URL.
`limit`	number	Maximum items to return.
`maxDepth`	number	Maximum crawl depth.

Example Request

Use direct HTTP requests against the public API base URL.

Example request

1
2
3
4
5
6
7
8
9
10
11
12
13
14const response = await fetch('https://api.crawlkit.sh/crawl', {
  method: 'POST',
  headers: {
    Authorization: 'ck_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "url": "https://example.com",
    "limit": 100,
    "maxDepth": 2
  })
});

console.log(await response.json());

Response

Accepted (202): The job is queued, so creditsUsed is 0 before settlement. Reserved credits are not final usage. Poll GET /crawl/:id for results. 1 credit per successful page, plus 3 when AI is used on that page. Screenshots included. Only completed pages are charged; unused reservations are refunded.

Accepted response (202)

1
2
3
4
5
6
7
8
9
10{
  "success": true,
  "requestId": "example-request-id",
  "data": {
    "id": "job-id",
    "type": "crawl",
    "status": "queued",
    "creditsUsed": 0
  }
}