API Reference

Screenshots

Screenshots API — endpoints, requests, and responses.

The Screenshots API. 2 endpoints:

Capture a screenshot

POST /v1/screenshots

Get screenshot status

GET /v1/screenshots/:id

GET /v1/accountGet account details

Returns account, plan, and current API key details, including the `api_key` and `subscription` fields.

POST /v1/screenshotsCapture a screenshot

Sync by default (holds up to 28s). Pass `?async=true` to return 202 immediately. 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`.