Skip to main content
POST
Preview a template without persisting

Authorizations

X-API-Key
string
header
required

Path Parameters

template_id
string
required

Template id (UUID or 22-char shortuuid).

Body

application/json

Request body for POST /lots/templates/{id}/preview/ — render samples without persisting or touching the counter.

count
integer
default:5

How many sample identifiers to render (from the starting value).

Required range: 1 <= x <= 20

Response

OK

Rendered sample identifiers for a template (nothing persisted).

format_string
string
required

The format that produced the samples.

count
integer
required

Number of samples returned.

sample_ids
string[]
required

Rendered identifiers, starting at the template's starting value.