dOCR
API ReferenceCaptures

Retrieve a capture

Fetch a single capture by id, looked up across screenshots and uploaded documents.

GET
/captures/{id}

Authorization

AuthorizationBearer <token>

API key as a Bearer token: Authorization: Bearer docr_sk_…

In: header

Path Parameters

idstring

The capture id.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://app.docr.dev/api/v1/captures/string"
{
  "capture": {
    "id": "string",
    "orgId": "string",
    "kind": "screenshot",
    "status": "pending",
    "format": "string",
    "url": "string",
    "sourceUrl": "string",
    "width": 0,
    "height": 0,
    "pageCount": 0,
    "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"
}
{
  "error": "string"
}

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`.

List captures

Returns a unified, newest-first list of everything your organization has captured — both rendered screenshots and uploaded documents — up to 100 items. Use the `kind` field to tell them apart.