Skip to main content
POST
Submit an embed form

Authorizations

Authorization
string
header
required

Short-lived embed session JWT minted by POST /v1/embed/sessions. Used by the iframe form-submit / upload-image endpoints and accepted (alongside a partner key) by builder template creation.

Path Parameters

sessionId
string<uuid>
required

The embed session id (must match the JWT subject).

Body

application/json
data
object
required

Flat dot-keyed or nested variable values.

datasetSelection
object

Response

Render queued.

Render shape returned by render/idempotent-replay and embed form-submit.

id
string<uuid>
required
status
enum<string>
required
Available options:
queued,
rendering,
succeeded,
failed,
cancelled
pollUrl
string<uri>
required
downloadUrl
string<uri> | null
required
errorMessage
string | null
required
createdAt
string<date-time>
required