SNAPSBREW docs
Browse the docs Open

Preview

See it before you spend a credit.

Preview renders a template (optionally with variants) into a WATERMARKED, self-contained HTML document without creating a snap and without charging a credit. The response is the rendered HTML — nothing is rasterized and nothing is persisted. Use it to iterate, then call POST /v1/snaps to produce the final, un-watermarked, billed snap image with the same variants. Available to trial users (no active subscription required). Rate-limited separately from the rest of the API.

Copy as Markdown OpenAPI Postman

On this page

GET /v1/templates/{templateUuid}/preview

Preview a template

Renders a free, watermarked preview of a template using its default layer content, or with `variants` applied. Returns a self-contained HTML document (text/html).

Auth: Bearer token Ability: api_requests Gate: throttle:preview Free

Parameters

Name In Type Required Description
templateUuid path string Yes UUID of the template to preview.
variants query array No Per-layer overrides, e.g. variants[0][layer]=headline&variants[0][text]=Hello. Each item targets a layer key with one of text, image_url (public URL), background_color, qr_content, or hidden.

The preview is watermarked HTML, not a usable final asset.

No credit is charged and no snap is stored.

Example request

curl

curl 'https://snapsbrew.com/api/v1/templates/<uuid>/preview' \
  -H 'Authorization: Bearer <your-token>' \
  --output preview.html

Example responses

200 Watermarked HTML preview (text/html). 
"<!DOCTYPE html>\u2026watermarked preview\u2026</html>"
404 Template not found in your account. 
{
    "message": "Not found."
}
422 Validation failed (e.g. a non-public image_url). 
{
    "message": "The variants.0.image_url must be a public http or https URL."
}
429 Preview rate limit exceeded. 
{
    "message": "Too Many Attempts."
}
GET /v1/snaps/preview

Preview a snap

Renders a free, watermarked preview of the snap you intend to create — a template (`template_id`) plus `variants`. Returns a self-contained HTML document (text/html). Pass the same template_id and variants to POST /v1/snaps to create the final billed snap.

Auth: Bearer token Ability: api_requests Gate: throttle:preview Free

Parameters

Name In Type Required Description
template_id query string Yes UUID of the template to render.
variants query array No Per-layer overrides, e.g. variants[0][layer]=headline&variants[0][text]=Hello. Each item targets a layer key with one of text, image_url (public URL), background_color, qr_content, or hidden.

The preview is watermarked HTML, not a usable final asset.

No credit is charged and no snap is stored.

Example request

curl

curl 'https://snapsbrew.com/api/v1/snaps/preview?template_id=<uuid>&variants[0][layer]=headline&variants[0][text]=Hello' \
  -H 'Authorization: Bearer <your-token>' \
  --output preview.html

Example responses

200 Watermarked HTML preview (text/html). 
"<!DOCTYPE html>\u2026watermarked preview\u2026</html>"
404 Template not found in your account. 
{
    "message": "Not found."
}
422 Validation failed. 
{
    "message": "The template id field is required."
}
429 Preview rate limit exceeded. 
{
    "message": "Too Many Attempts."
}