Skip to main content
POST
/
crawl
/
extract
Extract
curl --request POST \
  --url https://api.crawlkit.com/v1/crawl/extract \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "schema": {},
  "options": {
    "timeout": 30000,
    "headers": {},
    "waitFor": "<string>",
    "actions": [
      {
        "type": "wait",
        "milliseconds": 15050
      }
    ],
    "onlyMainContent": true,
    "contentSelector": "<string>",
    "prompt": "<string>",
    "maxDepth": 0,
    "depthPrompt": "<string>",
    "excludePaths": [
      "<string>"
    ],
    "includeOnlyPaths": [
      "<string>"
    ],
    "ignoreSitemap": false
  }
}
'
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API key with 'ApiKey ' prefix (e.g., ApiKey ck_...)

Body

application/json
​
url
string<uri>
required

URL to scrape and extract data from

​
schema
object
required

JSON Schema defining the structure for LLM extraction. Required.

​
options
object

Response

Default Response

​
success
enum<boolean>
required
Available options:
true,
false
​
error
object
required