DocumentationHow Captures Work
How Captures Work
A mental model of the rendering pipeline.
Lifecycle overview
Every capture follows the same pipeline:
- Validate and normalize the request.
- Apply SSRF protection and access checks.
- Acquire a browser context from the pool.
- Render the page using your settings.
- Store, cache, or return the output.
Sync vs async
- Sync:
POST /v1/capturereturns immediately when the render finishes. - Async:
POST /v1/jobsqueues the render and returns a job id.
Response types
json: metadata + storage URL.binary: raw bytes withContent-Type.empty: status only (use with storage).
Determinism
Consistency comes from controlling:
- Viewport and device settings.
- Wait conditions and timeouts.
- Resource blocking and reduced motion.
- Custom CSS or scripts.
Storage and caching
Storage and cache are separate layers:
- Storage is your durable destination.
- Cache accelerates repeated renders and saves usage.
Tip
Start with defaults, then tune only the options that improve consistency for your use case.
Updated 1 day ago