Skip to main content
POST
Ask Vumasign to name a template’s fields: a naming run, produced in the background.

Authorizations

Authorization
string
header
required

Authorization: Bearer vsk_live_…. Chosen over a bespoke X-API-KEY header because every client, proxy and log-redaction rule already knows this one. What a key may DO is its scopes — see x-scopes at the root of this document and x-required-scope on each operation. The scope list is not written here because OpenAPI reserves a requirement’s scope array for oauth2 and openIdConnect and requires it to be empty for an http scheme.

Headers

Idempotency-Key
string
required

Any string that identifies this request, at most 255 characters. ⚠️ REQUIRED: retrying with the same key returns the same run rather than starting a second one. The caller’s own request identifier.

Example:

"01960000-0000-4000-8000-00000000ffff"

Path Parameters

templateId
string<uuid>
required

The template’s id, as returned by the list endpoint. A template id.

Example:

"01960000-0000-4000-8000-0000000007e1"

Body

application/json

Whether to use a model, and the blank-form confirmation that needs. Optional.

How to name it.

use_ai
boolean

Ask for Stage 2, a model naming what the vocabulary cannot. Default false: Stage 1 only, which matches printed labels against the core vocabulary and your organisation’s keys. Stage 2 is not yet available, so a run asked for it is Stage 1 only, and its preview says ai_refused: "stage2_unavailable".

blank_form
boolean

Required, as true, whenever use_ai is: you confirm the template is a blank form, with nobody’s details filled in, before its printed text is sent to a model.

Response

The run, queued: read it with GET …/naming-runs/{runId}, or wait for template.named.

The queued run.

id
string<uuid>
required

The run’s id.

status
enum<string>
required

Always queued here.

Available options:
queued
template_etag
string
required

The template’s ETag when the run was requested.