dOCR
API ReferenceScreenshots

Retrieve a screenshot

Fetch a single screenshot by id. Useful for polling the `status` of an `async` render until it becomes `ready` (or `failed`).

GET
/screenshots/{id}

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

idstring

The screenshot id.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://app.docr.dev/api/v1/screenshots/string"
{
  "screenshot": {
    "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"
}
{
  "error": "string"
}

Render a screenshot

Render a web page (`url`) or a raw HTML string (`html`) to a PNG, JPEG, WebP image, or a PDF. Provide **exactly one** of `url` or `html`. By default the request is **synchronous**: dOCR renders the page and returns the finished screenshot record (with a hosted `url`) in the response. Set `async: true` to return immediately with a `pending` record and receive a [`screenshot.completed`](/docs/guides/webhooks) webhook when the render finishes. Each successful render costs **1 credit**. Cache hits and failed renders cost nothing. See the [Screenshots guide](/docs/guides/screenshots) for a full walkthrough of formats, devices, caching, and signed URLs.

List screenshots

Returns your organization's most recent screenshots (up to 100), newest first.