dOCR
API ReferenceScreenshots

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

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

GET
/take

Query Parameters

tstring

Your organization id (the signing tenant).

signaturestring

HMAC-SHA256 of the canonical query string (hex).

url?string

URL to render. Provide exactly one of url or html.

Formaturi
html?string

Raw HTML to render. Provide exactly one of url or html.

format?string

Image format. pdf is not available on this endpoint.

Default"png"
Value in"png" | "jpeg" | "webp"
fullPage?boolean

Capture the full scrollable height of the page.

Defaultfalse
cache?boolean

Reuse a stored render for identical options (0 credits on a hit).

Defaultfalse

Response Body

application/json

application/json

application/json

curl -X GET "https://app.docr.dev/api/v1/take?t=string&signature=string"
"string"
{
  "error": "Invalid signature"
}
{
  "error": "Credit limit reached (100/100). Upgrade your plan."
}
{
  "error": "string"
}