Skip to main content
GET
Read a naming run: its status, its proposals with reasons, and the preview.

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.

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"

runId
string<uuid>
required

The naming run’s id, from POST …/naming-runs, from name_fields on create, or from template.named. A naming run id.

Response

The run: its status and, once it has succeeded, its proposals and preview.

The run.

id
string<uuid>
required

The run’s id.

template_id
string<uuid>
required

The template it names.

status
enum<string>
required

queued and running have no proposals yet; failed has an error and none.

Available options:
queued,
running,
succeeded,
failed
error
enum<string> | null
required

Why a failed run failed. Null otherwise. Request a new run.

Available options:
template_unavailable,
internal_error,
null
template_etag
string
required

The ETag of the template the proposals describe. Accepting is refused once the template’s ETag is another; send this as If-Match to …/accept.

use_ai
boolean
required

Whether Stage 2 was asked for.

created_at
string<date-time>
required

When it was requested.

finished_at
string<date-time> | null
required

When it succeeded or failed.

proposals
object | null
required

What the run proposes, by field, question and person. Null until the run has succeeded. Every proposal has passed the same naming rules as a rename, so a run holds no collision.

preview
object | null
required

What accepting every proposal would produce. Null until the run has succeeded.