# domscout

> A browser API for agents: screenshots, PDFs, clean Markdown, structured
> extraction, DOM and accessibility snapshots, page automation, durable jobs,
> batches and bounded crawls. Authenticate with `x-api-key`; base URL
> `https://api.domscout.io`.

Browser captures require renderer isolation and the deployment public-capture gate.
A 403 `BROWSER_ISOLATION_REQUIRED` or `BROWSER_EXECUTION_DENIED` is terminal for
that request; upgrading or retrying will not clear either platform gate.

Requests are weighted: a viewport PNG costs 1 credit, no request costs more
than 10, and every GET, every DELETE, and `POST /feedback` are free.

## Documentation

- [Full API reference](https://www.domscout.io/llms-full.txt): every endpoint and parameter, in one file
- [OpenAPI 3.1 specification](https://www.domscout.io/openapi.json): the canonical wire contract
- [Documentation site](https://www.domscout.io/docs): guides and a live playground
- [Pricing](https://www.domscout.io/pricing): plans, credits, and limits

## Endpoints

- [POST /screenshot](https://www.domscout.io/llms-full.txt): Capture a page, inspect its DOM, and optionally automate it
- [POST /scrape](https://www.domscout.io/llms-full.txt): Read a page as Markdown, with or without a browser
- [GET /captures](https://www.domscout.io/llms-full.txt): List retained saved-capture metadata
- [GET /jobs](https://www.domscout.io/llms-full.txt): List durable jobs for this account
- [GET /capture/{captureId}](https://www.domscout.io/llms-full.txt): Get a saved capture and short-lived artifact download URLs
- [GET /job/{jobId}](https://www.domscout.io/llms-full.txt): Get a durable job and its result when complete
- [DELETE /job/{jobId}](https://www.domscout.io/llms-full.txt): Request cancellation of a durable job
- [GET /job/{jobId}/metadata](https://www.domscout.io/llms-full.txt): Get safe job metadata without loading rich result content
- [POST /batch](https://www.domscout.io/llms-full.txt): Submit up to 100 independent capture requests
- [GET /batch/{jobId}](https://www.domscout.io/llms-full.txt): Get aggregate batch status and completed child results
- [DELETE /batch/{jobId}](https://www.domscout.io/llms-full.txt): Cancel a batch and its unstarted child jobs
- [POST /crawl](https://www.domscout.io/llms-full.txt): Submit a bounded allowlisted site crawl
- [GET /crawl/{jobId}](https://www.domscout.io/llms-full.txt): Get crawl frontier, aggregate status, and completed page results
- [DELETE /crawl/{jobId}](https://www.domscout.io/llms-full.txt): Cancel a crawl and stop scheduling unstarted pages
- [POST /map](https://www.domscout.io/llms-full.txt): Discover URLs from sitemaps and page links
- [POST /extract](https://www.domscout.io/llms-full.txt): Extract structured JSON with an LLM
- [POST /search](https://www.domscout.io/llms-full.txt): Search the web and optionally scrape result pages (WITHHELD)
- [POST /index](https://www.domscout.io/llms-full.txt): Chunk, embed, and store content in the account vector index
- [POST /semantic-search](https://www.domscout.io/llms-full.txt): Search indexed content by semantic similarity
- [POST /webhooks/deliveries/{deliveryId}/replay](https://www.domscout.io/llms-full.txt): Queue a signed replay of a stored webhook delivery
- [GET /credits](https://www.domscout.io/llms-full.txt): Credit balance, quota, capabilities, and the credit price list
- [POST /feedback](https://www.domscout.io/llms-full.txt): Report a problem, a documentation gap, or an idea
- [POST /monitors](https://www.domscout.io/llms-full.txt): Create a monitor
- [GET /monitors](https://www.domscout.io/llms-full.txt): List this account's monitors
- [GET /monitors/{monitorId}](https://www.domscout.io/llms-full.txt): Read one monitor
- [PATCH /monitors/{monitorId}](https://www.domscout.io/llms-full.txt): Update, pause, or resume a monitor
- [DELETE /monitors/{monitorId}](https://www.domscout.io/llms-full.txt): Delete a monitor
- [POST /monitors/{monitorId}/rotate-secret](https://www.domscout.io/llms-full.txt): Rotate a monitor webhook signing secret
- [POST /monitors/{monitorId}/run](https://www.domscout.io/llms-full.txt): Run a monitor now, once
- [GET /monitors/{monitorId}/runs](https://www.domscout.io/llms-full.txt): Read a monitor's run history
- [GET /webhooks/deliveries](https://www.domscout.io/llms-full.txt): List this account's webhook deliveries
- [GET /webhooks/deliveries/{deliveryId}](https://www.domscout.io/llms-full.txt): Read one delivery and its attempt history

## Optional

- [MCP server](https://www.domscout.io/docs/mcp): use domscout as tools in an agent platform
- [Changelog](https://www.domscout.io/changelog)

## Not in this API

- Web search (`POST /search`) is withheld: no provider is configured, so it answers 503 SEARCH_NOT_CONFIGURED on every plan.