Implementation guides

Build reliable screenshot workflows

Practical patterns using only options supported by the current Screenshot API contract.

HTTPS API api-screenshot.com/v1 Bearer auth · JSON requests · private artifacts

Private development preview The contract is documented for integration planning. Production API routes currently return HTTP 503 and no live keys are being issued. OpenAPI 3.1 →

Patterns

Choose a workflow

Capture Full-page screenshots

Capture long pages without allowing unbounded document height.

Read documentation → Responsive Mobile screenshots

Use the mobile preset or controlled custom viewports.

Read documentation → Agents Visual evidence for AI agents

Preserve URL, timing, dimensions, and hashes alongside image bytes.

Read documentation →

Shared principles

Every workflow should be bounded

Use a stable idempotency key for one logical capture.
Choose the smallest viewport and artifact format that satisfies the consumer.
Poll with a deadline instead of waiting forever.
Treat target URLs and redirect destinations as untrusted.
Store provenance metadata beside any artifact used as AI evidence.