v1

latestOpenAPI 3.1.02026-07-223261135.0 KB

brand-kits

Add Brand Kit Image

Attach an uploaded image to a brand kit (ENG-2466).

Multipart-upload flow: the caller first POST /v1/uploads their file and receives a file_* id (the response's id field), then calls this endpoint with that id as file_id to associate the image with the brand kit (logo / reference / asset). A bare UUID is also accepted for back-compat with older integrations.

post/brand-kits/{brand_kit_id}/images

Path parameters

brand_kit_idstring required

Prefixed bk_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working). Both are permanent, supported inputs.

Example:bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV

Headers

Moda-Version'2026-04-12' | '2026-05-01'

Example:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Request body

file_idstring required

The file_ ID returned as id by a prior POST /v1/uploads response. A bare UUID (the form older integrations stored) is also accepted for back-compat.

role'logo' | 'reference' | 'asset' required

How the image is used. 'logo' gets special downstream treatment; 'reference' is a style hint visible to the design agent; 'asset' is includable in designs.

labelstring nullable

Optional human-readable label.

Example request

{
  "file_id": "file_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "role": "logo",
  "label": "Dark mode logo"
}

Response

Successful Response

object required