Skip to content

Get the curated generation vocabulary

GET
/v1/spec-vocabulary
curl --request GET \
--url https://example.com/v1/spec-vocabulary \
--header 'Authorization: Bearer <token>'

Return the curated, free-text-capable suggestion vocabulary per generation field — one list per field (ethnicities, body_types, age_ranges, scene_types, moods, materials, patterns, lengths), each entry {value, description}. Global reference data (no tenant scoping); static config served read-through from studio. Colours are excluded — the SPA owns its palette.

X-Shopify-Hmac-Sha256
Any of:
string

Successful Response

Media type application/json
SpecVocabularyResponse

GET /v1/spec-vocabulary — one curated list per generation field.

Each list is ordered as curated by studio (e.g. ethnicities grouped by region) and is free-text-capable on the SPA side. Colours are excluded — the SPA owns its palette.

object
ethnicities
required
Ethnicities

Model ethnicity / heritage suggestions.

Array<object>
VocabularyEntryResponse

One curated generation-vocabulary suggestion — a value + its description.

object
value
required
Value

The terse attribute value the workflow request + catalog store.

string
description
required
Description

The one-line grounding string for the value (for moods, exactly the UI meaning).

string
body_types
required
Body Types

Model body-type / build suggestions.

Array<object>
VocabularyEntryResponse

One curated generation-vocabulary suggestion — a value + its description.

object
value
required
Value

The terse attribute value the workflow request + catalog store.

string
description
required
Description

The one-line grounding string for the value (for moods, exactly the UI meaning).

string
age_ranges
required
Age Ranges

Model age-range bracket suggestions.

Array<object>
VocabularyEntryResponse

One curated generation-vocabulary suggestion — a value + its description.

object
value
required
Value

The terse attribute value the workflow request + catalog store.

string
description
required
Description

The one-line grounding string for the value (for moods, exactly the UI meaning).

string
scene_types
required
Scene Types

Background scene-type suggestions.

Array<object>
VocabularyEntryResponse

One curated generation-vocabulary suggestion — a value + its description.

object
value
required
Value

The terse attribute value the workflow request + catalog store.

string
description
required
Description

The one-line grounding string for the value (for moods, exactly the UI meaning).

string
moods
required
Moods

Background mood suggestions (description = meaning).

Array<object>
VocabularyEntryResponse

One curated generation-vocabulary suggestion — a value + its description.

object
value
required
Value

The terse attribute value the workflow request + catalog store.

string
description
required
Description

The one-line grounding string for the value (for moods, exactly the UI meaning).

string
materials
required
Materials

Garment material suggestions.

Array<object>
VocabularyEntryResponse

One curated generation-vocabulary suggestion — a value + its description.

object
value
required
Value

The terse attribute value the workflow request + catalog store.

string
description
required
Description

The one-line grounding string for the value (for moods, exactly the UI meaning).

string
patterns
required
Patterns

Garment pattern suggestions.

Array<object>
VocabularyEntryResponse

One curated generation-vocabulary suggestion — a value + its description.

object
value
required
Value

The terse attribute value the workflow request + catalog store.

string
description
required
Description

The one-line grounding string for the value (for moods, exactly the UI meaning).

string
lengths
required
Lengths

Garment length suggestions.

Array<object>
VocabularyEntryResponse

One curated generation-vocabulary suggestion — a value + its description.

object
value
required
Value

The terse attribute value the workflow request + catalog store.

string
description
required
Description

The one-line grounding string for the value (for moods, exactly the UI meaning).

string
Example generated
{
"ethnicities": [
{
"value": "example",
"description": "example"
}
],
"body_types": [
{
"value": "example",
"description": "example"
}
],
"age_ranges": [
{
"value": "example",
"description": "example"
}
],
"scene_types": [
{
"value": "example",
"description": "example"
}
],
"moods": [
{
"value": "example",
"description": "example"
}
],
"materials": [
{
"value": "example",
"description": "example"
}
],
"patterns": [
{
"value": "example",
"description": "example"
}
],
"lengths": [
{
"value": "example",
"description": "example"
}
]
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}