List screenshots
Returns your organization's most recent screenshots (up to 100), newest first.
API key as a Bearer token: Authorization: Bearer docr_sk_…
In: header
Response Body
application/json
application/json
application/json
curl -X GET "https://app.docr.dev/api/v1/screenshots"{
"screenshots": [
{
"id": "6a382443304f240b189f228a",
"orgId": "string",
"kind": "screenshot",
"status": "pending",
"format": "png",
"url": "https://res.cloudinary.com/docr/image/upload/screenshot-6a382443.png",
"width": 1280,
"height": 3840,
"fullPage": true,
"cacheHit": true,
"creditsUsed": 1,
"externalIdentifier": "string",
"metadata": {},
"error": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}{
"error": "Invalid or revoked API key"
}{
"error": "IP 203.0.113.4 is not whitelisted"
}Retrieve a screenshot
Fetch a single screenshot by id. Useful for polling the `status` of an `async` render until it becomes `ready` (or `failed`).
Render a screenshot from a signed URL
A signed, embeddable variant of `POST /screenshots` that returns the raw image bytes directly — so a signed URL can be dropped straight into an `<img src>` with **no API key**. PDF output is not supported here; use `POST /screenshots` for PDFs. Authentication is by **signature**, not a Bearer token. The `signature` query parameter is an HMAC-SHA256 of the canonical query string (every parameter except `signature`, sorted by key and joined with `&`), keyed by your organization's signing secret. See [Signed URLs](/docs/guides/screenshots#signed-urls) for how to generate one. Every rendering option from `POST /screenshots` (for example `format`, `fullPage`, `device`, `darkMode`, `cache`) may be passed as a query parameter. Responses set `X-docr-Cache: hit` or `miss` and a one-hour `Cache-Control`.