Capture

Read a page as Markdown, with or without a browser

The same capture engine POST /screenshot runs, addressed as a content endpoint. It defaults extractMarkdown:true and forces responseType:json, and it drops the base64 image from the response unless screenshot:true asks for it — which is what keeps a text answer inside the synchronous response budget on pages whose PNG would not fit.

Every field, plan gate, entitlement, credit weight and error contract is POST /screenshot's. The only differences are the three defaults above and the response shape.

Send renderJs:false (or fast:true) to answer from one guarded HTTP GET instead of a browser. That path is roughly an order of magnitude faster, costs the same credits, and returns the identical document shape — but it does not execute JavaScript, so check metadata.renderJs and metadata.contentQuality before concluding a page is empty. renderJs:false is also accepted on POST /screenshot, where it returns this document shape because there is no image to return.

post/scrape

Request

  • Base URL: https://api.domscout.io
  • URL: https://api.domscout.io/scrape
  • 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

The page as a document.

status'success' required
urlstring required

The canonical URL of the page, falling back to the URL requested.

titlestring required
markdownstring required

Empty string when the page yielded no extractable text.

screenshotBase64string

Present only when screenshot:true was sent.

Changes

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