Skip to main content
POST
/
brand-kits
/
{brand_kit_id}
/
images
Add Brand Kit Image
curl --request POST \
  --url https://api.moda.app/v1/brand-kits/{brand_kit_id}/images \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file_id": "file_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
  "label": "<string>"
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.moda.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

​
Moda-Version
enum<string>
default: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.

Available options:
2026-04-12,
2026-05-01
Example:

"2026-05-01"

Path Parameters

​
brand_kit_id
string
required

Prefixed bk_ wire ID (Crockford base32 body). Path parameters additionally accept a bare UUID string for back-compat; JSON body fields require the prefixed form.

Pattern: ^bk_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
Example:

"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

Body

application/json

Request body for POST /v1/brand-kits/{id}/images (ENG-2466).

​
file_id
string
required

Prefixed upl_ ID from a prior POST /v1/uploads response.

Pattern: ^file_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
Example:

"file_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

​
role
enum<string>
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.

Available options:
logo,
reference,
asset
​
label
string | null

Optional human-readable label.

Response

Successful Response

The response is of type Response Addbrandkitimage · object.