Skip to main content
POST
/
crawl
/
screenshot
Screenshot
curl --request POST \
  --url https://api.crawlkit.com/v1/crawl/screenshot \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "options": {
    "width": 1920,
    "height": 1080,
    "timeout": 30000,
    "waitForSelector": "<string>"
  }
}
'
{
  "success": true,
  "data": {
    "url": "<string>",
    "width": 123,
    "height": 123,
    "timing": {
      "total": 123
    },
    "creditsUsed": 123,
    "creditsRemaining": 123
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
url
string<uri>
required

URL to screenshot

options
object

Response

Default Response

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