Skip to main content
POST
Get brand kit

Headers

x-project-id
string<uuid>
required

Project ID for tenant scoping

X-Workspace-Id
string<uuid> | null

Overrides the key's workspace

X-API-Key
string | null

User API key

Body

application/json
view
enum<string>
required

catalog lists available brand-kit sections; compose builds a prompt

Available options:
catalog,
compose,
compose_by_section,
compose_image_prompt
sections
string[] | null

Section keys to narrow compose/compose_by_section to (e.g. business, audience, objectives, content_type, authors, voice, design) — omit for the full kit. view=catalog does NOT list these keys (it lists approved VALUES for the content_type/author/audience/voice args below); to see this project's actual resolvable section keys, call compose_by_section with no sections filter first and read the keys of its response.

content_type
string | null

Content type to tailor the composition to

author
string | null

Author persona to compose for

audience
string | null

Target audience to compose for

voice
string | null

Brand voice to compose with

subject
string | null

Image subject (compose_image_prompt view); omit for the brand's style-only block

aspect_ratio
string | null

Aspect ratio for the image prompt (compose_image_prompt view)

smart
boolean
default:false

Let the service expand a thin subject (compose_image_prompt view)

Response

Successful Response