Skip to main content
POST
Synchronous capture

Synchronous capture

Send an API key in x-api-key or Authorization: Bearer …. The response is the requested binary body unless account storage delivery is requested.

Core fields

HTML and WebM cannot be combined with selector, clip, or a device mockup. The complete bounds and nested options are authoritative in /api/openapi.json and src/lib/api/screenshot-schema.ts.

Responses

  • 200: capture completed. X-Screenshot-Duration, X-Screenshot-Size, and quota headers are included.
  • 400: invalid, unsafe, or incompatible input.
  • 401: missing, expired, revoked, or invalid API key.
  • 403: the workspace owner’s plan does not include a requested feature.
  • 413: request body exceeds 64 KiB.
  • 429: monthly allowance or per-minute throughput was exceeded.
  • 503: a requested optional adapter, such as a regional proxy, is not configured.
Failed requests are recorded for diagnostics but do not consume successful-capture quota.