Capture

Capture a page, inspect its DOM, and optionally automate it

Browser capture availability depends on your account capabilities and platform restrictions. Check GET /credits before starting browser work. A platform refusal returns HTTP 403 without upgrade_url: BROWSER_ISOLATION_REQUIRED when browser execution is unavailable, or BROWSER_EXECUTION_DENIED with reason public_capture_not_enabled when public capture is unavailable for your account. Upgrading or immediately retrying does not clear these refusals. Returns a direct result when it fits within the synchronous response budget; explicit async requests and rich results that exceed it return 202 with a durable job ID instead. Set responseType to json whenever semantic analysis, diagnostics, extraction, cleanup reporting, or action results are needed. A binary response is raw image/PDF bytes; binary delivery does not depend on the ordering of values in Accept.

post/screenshot

Request

  • Base URL: https://api.domscout.io
  • URL: https://api.domscout.io/screenshot
  • Auth: API key in header x-api-key

Headers

Idempotency-Keystring

Optional caller-generated key for POST submission. Reusing a key with an identical body for the same owner returns the original job; reusing it with a different body returns 409.

Request body

OR
OR

Response

Synchronous capture result.

status'success' required
screenshotBase64string byte
pdfBase64string byte
mobileBase64string byte
tabletBase64string byte
desktopBase64string byte
skeletonBase64string byte
hydratedBase64string byte
timelineBase64string[]
markdownstring
simplifiedDomstring
tabsstring[]

IDs of tabs that remain open after the action sequence.

probeboolean
loadTimeMsinteger
bodyTextLengthinteger

Changes

No recorded changes to this operation across all 1 revision of this API.