Start from the endpoint and intended result, then choose only documented fields that describe target, output, responsive state, readiness, cleanup, and advanced preparation. Preserve the final specification with the artifact.
POST /api/v1, /api/v2, or /api/v3SNAPSHOT_SITE_API_KEY
Do not assume every field works on every version. Basic capture, advanced preparation, analysis, and comparison expose different operations and response shapes.
URL and format describe the source and artifact.
Width, height, and fullSize select layout and visible or full-document output.
Delay, cookie handling, DOM waiting, and approved selectors shape the captured state.
JavaScript preparation, analysis fields, and before-after comparison require their documented endpoints.
Choose the endpoint from the intended result
Start with required target and output fields
Add only measured viewport, readiness, and cleanup options
Validate the response and store the complete request context
Every field corresponds to a visual requirement that should be tested and retained with the result.
{
"url": "https://example.com",
"format": "webp",
"width": 1440,
"height": 900,
"fullSize": true,
"hideCookie": true,
"delay": 2
}
A capture endpoint returns an artifact. Analyze returns documented structured insight. Compare accepts two states and returns before, after, diff, and metrics. Selecting an endpoint by version number without naming the result leads to copied fields and unclear behavior.
Read the current contract and create a typed application model that exposes only what the product needs.
URL identifies the target but does not make it authorized. Validate destination at your server boundary. Format selects the artifact. Width and height define responsive viewport, while fullSize chooses visible frame or scrollable document.
Readiness and cleanup require evidence. Add delay only when a measured wait solves a known page state. Use cookie cleanup or selectors only when those elements fall outside the artifact's purpose.
Custom JavaScript changes the rendered page and therefore belongs to a reviewed advanced workflow. Store the script revision with the output. Analysis and comparison fields have separate response contracts; do not mix them into a generic capture object.
Reject or surface unknown fields rather than assuming the provider ignores them. This catches spelling errors and stale client code.
Keep the final request, endpoint operation, response status, artifact reference, and capture time together. Use response formats for output selection and best practices for the production boundary.
The target URL is fundamental, while exact requirements depend on the selected endpoint. Verify the current contract in API documentation.
It sets the browser viewport width and therefore selects responsive breakpoints and image sources.
It defines the visible viewport height. Full-page mode can extend output beyond that visible frame.
It requests the complete scrollable document rather than only the current viewport, while width still determines responsive layout.
Use a measured fixed delay for predictable page settling. Prefer an application or DOM condition when completion varies.
It supports cleanup of common cookie or consent UI. Verify the actual page because custom banners may require an approved targeted strategy.
Use only the advanced endpoint and fields documented for JavaScript preparation. Do not assume cross-version support.
Fail validation or remove them deliberately. Silently forwarding undocumented fields makes behavior difficult to reason about.
Start from the result you need, document every field, and preserve the specification with the generated artifact.