Raw Crawl

curl --request POST \
  --url https://api.crawlkit.com/v1/crawl/raw \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "options": {
    "mode": "html",
    "timeout": 30000,
    "headers": {},
    "followRedirects": true,
    "maxRedirects": 5,
    "waitForSelector": "<string>",
    "actions": [
      {
        "type": "wait",
        "milliseconds": 15050
      }
    ]
  }
}
'

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Crawl

Raw Crawl

Fetches the given URL via proxy and returns the response.

Modes:

html: Raw HTML content
markdown: Clean readable content (Reader Mode)
json: Structured data

Browser Rendering: Use waitForSelector or actions to force browser rendering.

If both are provided, waitForSelector runs first, then actions.

Actions (Browser Automation): Execute browser interactions before capturing content:

wait: Wait for specified milliseconds { type: "wait", milliseconds: 2000 }
click: Click an element { type: "click", selector: "#btn" }
type: Type text into an input { type: "type", selector: "#input", text: "hello" }
press: Press a keyboard key { type: "press", key: "Enter" }
scroll: Scroll up or down { type: "scroll", direction: "down" }
evaluate: Execute JavaScript { type: "evaluate", script: "document.title" }

Limits:

Max timeout: 5 minutes (300000ms)
Max actions: 50

Features:

Smart SPA detection with automatic browser fallback
Extracts embedded data from Next.js, Nuxt.js, and Notion pages

Costs 1 credit.

POST

crawl

raw

Raw Crawl

curl --request POST \
  --url https://api.crawlkit.com/v1/crawl/raw \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "options": {
    "mode": "html",
    "timeout": 30000,
    "headers": {},
    "followRedirects": true,
    "maxRedirects": 5,
    "waitForSelector": "<string>",
    "actions": [
      {
        "type": "wait",
        "milliseconds": 15050
      }
    ]
  }
}
'

{
  "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 crawl

options

object

Show child attributes

Response

Default Response

success

enum<boolean>

required

Available options:

true,

false

error

object

required

Show child attributes

Web Search

⌘I