Get screenshot status

Authorization

AuthorizationRequiredBearer <token>

API key. Manage keys from the dashboard at app.bytekit.com.

In: header

Path Parameters

idRequiredstring

Pattern: "^ss_"

curl https://api.bytekit.com/v1/screenshots/{id} \
  -H "Authorization: Bearer sk_live_your_api_key_here"

Screenshot completed or failed. A completed screenshot returns the full ScreenshotResponse resource (signed image_url, dimensions, etc.). A terminal-failed screenshot is a successfully retrieved terminal state (like a failed async scrape) and instead returns the unified failed envelope (Error schema) populated from the screenshot's own error_code/error_message (issue #2027).

{
  "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,
  "billing": {
    "raw_bytes": 1024,
    "factors": [
      {
        "name": "endpoint",
        "value": 1.5,
        "reason": "scrape_md"
      }
    ],
    "multiplier": 0.75,
    "billed_bytes": 768
  },
  "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"
}