API ReferenceScreenshots

Get screenshot status

GET
/v1/screenshots/{id}

Authorization

AuthorizationRequiredBearer <token>

API key. Obtain from POST /v1/account/api-keys.

In: header

Path Parameters

idRequiredstring
Pattern: "^ss_"
curl -X GET "https://api.bytekit.com/v1/screenshots/string" \
  -H "Authorization: Bearer <token>"

Screenshot completed or failed.

{
  "id": "ss_01j9abc123",
  "status": "pending",
  "url": "string",
  "image_url": "string",
  "page_title": "string",
  "image_width": 0,
  "image_height": 0,
  "file_size_bytes": 0,
  "credits_charged": 0,
  "error_code": "string",
  "error_message": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "poll_url": "string"
}

Capture a screenshot

Sync by default (holds up to 28s). Pass `?async=true` to return 202 immediately. Poll via GET /v1/screenshots/{id}.

Create a scrolling recording

Always async — returns 202. Poll via GET /v1/recordings/{id}.