Extract

POST1 credit + 3 if AI used

https://api.crawlkit.sh/extract

Extract validated structured JSON with a schema or instruction.

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.
`instruction`	string	Request field.

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
13const response = await fetch('https://api.crawlkit.sh/extract', {
  method: 'POST',
  headers: {
    Authorization: 'ck_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "url": "https://example.com",
    "instruction": "Extract the title and description"
  })
});

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

Response

This example uses AI and costs 4 credits. 1 credit per successful page, plus 3 when AI is used. Deterministic extraction has no AI surcharge. Unused reservations are refunded.

Success response (200 OK)

1
2
3
4
5
6
7
8
9
10
11
12
13{
  "success": true,
  "requestId": "example-request-id",
  "data": {
    "url": "https://example.com",
    "finalUrl": "https://example.com/",
    "json": {
      "title": "Example Domain",
      "description": "A domain for documentation examples."
    },
    "creditsUsed": 4
  }
}