Skip to main content

​
Endpoint

GET https://api.screenshotly.dev/v1/screenshots/{screenshotId}/status
A lightweight alternative to the full screenshot endpoint that returns only the status and image URL. Ideal for polling.

​
Headers

HeaderRequiredDescription
X-API-KeyYesYour API key

​
Path parameters

​
screenshotId
string
required
The unique ID of the screenshot.

​
Response

​
200 OK

{
  "success": true,
  "data": {
    "id": "67b8a1c2d3e4f5a6b7c8d9e0",
    "status": "completed",
    "imageUrl": "https://cdn.screenshotly.dev/screenshots/67b8a1c2d3e4f5a6b7c8d9e0.png"
  }
}

​
Processing

{
  "success": true,
  "data": {
    "id": "67b8a1c2d3e4f5a6b7c8d9e0",
    "status": "processing",
    "imageUrl": null
  }
}

​
Error responses

StatusCodeDescription
401missing_api_key / invalid_api_keyInvalid or missing API key
403forbiddenYou don’t own this screenshot
404not_foundScreenshot ID doesn’t exist

​
Example

curl https://api.screenshotly.dev/v1/screenshots/67b8a1c2d3e4f5a6b7c8d9e0/status \
  -H "X-API-Key: $SCREENSHOTLY_API_KEY"