Skip to main content
POST
generate_domain

Authorizations

X-API-Key
string
header
required

Body

application/json

Ask the model for an unsaved taxonomy draft.

Nothing is persisted: the caller edits the draft, then posts it to POST /v1/domains. Optional display_name / slug seed the suggested identity fields returned alongside the taxonomy. Exactly one input is required: a written description, or a succeeded Parse job.

description
string | null

What kinds of files belong in this domain — the classifier-facing brief.

Required string length: 1 - 4000
display_name
string | null

Optional name hint used when suggesting a display name and slug.

Required string length: 1 - 200
sheet_name
string | null

Workbook worksheet to extract. Required when the Parse result contains multiple sheets.

Required string length: 1 - 200
slug
string | null

Optional slug hint. When omitted, the model derives one from the input.

Maximum string length: 64
Pattern: ^[a-z0-9]+(?:_[a-z0-9]+)*$
source
ParseResultSource · object | null

Succeeded Parse job whose content contains the taxonomy to extract.

Response

Successful Response

An unsaved draft ready for the authoring UI to edit and then create.

suggested_display_name
string
required
Required string length: 1 - 200
suggested_slug
string
required
Maximum string length: 64
Pattern: ^[a-z0-9]+(?:_[a-z0-9]+)*$
taxonomy
Taxonomy · object
required

The classification vocabulary.

validation
DomainValidation · object
required

Publish-gate check on the normalized draft — always run so the UI knows it can create cleanly.