Get brand kit

Get the project’s brand kit: list the names of its sections, or compose the brand content into a ready-to-use prompt.

Example: “What sections does my brand kit have?”

Usage: pick what you want with view: catalog lists the section names only, compose returns one combined brand prompt, compose_by_section returns the same content split per section, and compose_image_prompt turns the brand’s design section into an image prompt (give it a subject, aspect ratio, and whether to let the service expand a thin subject). For the compose views you can tailor the result by section keys, content type, author, audience, or voice.

Response: for catalog, the section names. For the compose views, the composed brand prompt, either as one block, split per section, or as an image prompt.

POST /api/v1/business/brand-kit

Get brand kit

cURL

curl --request POST \
  --url https://api.example.com/api/v1/business/brand-kit \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "sections": [
    "<string>"
  ],
  "content_type": "<string>",
  "author": "<string>",
  "audience": "<string>",
  "voice": "<string>",
  "subject": "<string>",
  "aspect_ratio": "<string>",
  "smart": false
}
'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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

200

application/json

Successful Response