API ReferenceScreenshots

Capture a screenshot

Sync by default (holds up to 28s). Pass async: true in the body or ?async=true in the query string to return 202 immediately; either one is enough, and false in one never cancels true in the other. Poll via GET /v1/screenshots/{id}.

Limits: request bodies are capped at 512 KB. An oversized body returns a 400 with error code request_too_large.

For AI agents: https://bytekit.com/llms.txt — every docs page is available as markdown by appending .md

POST
/v1/screenshots

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired
urlRequiredstring
Format: "uri"
devicestring
Default: "desktop"Value in: "desktop" | "mobile"
viewportobject
Default: null
asyncboolean

When true, the request returns 202 immediately and the screenshot is captured in the background; poll GET /v1/screenshots/{id}. The ?async=true query parameter is a second spelling of this field: the request is async when either one says true, and false in one never cancels true in the other.

Default: false
full_pageboolean
Default: false
formatstring
Default: "jpeg"Value in: "jpeg" | "png"
qualityinteger
Default: 80Minimum: 1Maximum: 100
block_adsboolean
Default: true
block_cookie_bannersboolean
Default: true
wait_untilstring
Default: "load"Value in: "load" | "domcontentloaded" | "networkidle"
wait_for_selectorstring | null
Default: null
delay_msinteger
Default: 0Minimum: 0Maximum: 10000
scrollboolean
Default: true
clipobject
Default: null
dark_modeboolean
Default: false
device_scale_factorinteger | null
Default: nullValue in: 1 | 2 | null
include_htmlboolean
Default: false
countrystring
Default: "US"Pattern: "^[A-Z]{2}$"
languagestring | null
Default: null
metadataobject

Arbitrary key-value metadata. Max 4096 bytes when JSON-serialized.

Query Parameters

asyncboolean

Query-string spelling of the body async field. true returns the 202 immediately; any other value is ignored.

Default: false
curl -X POST https://api.bytekit.com/v1/screenshots \
  -H "Authorization: Bearer sk_live_your_api_key_here"

Screenshot completed (sync mode).

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

Screenshots

Screenshots API — endpoints, requests, and responses.

GET /v1/screenshots/{id}Get screenshot status

Next Page