curl --request POST \
--url https://api.moda.app/v1/brand-kits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"name": "<string>",
"colors": [
{}
],
"fonts": [
{}
],
"logo_file_ids": [
"file_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
],
"idempotency_key": "<string>"
}
'import requests
url = "https://api.moda.app/v1/brand-kits"
payload = {
"url": "<string>",
"name": "<string>",
"colors": [{}],
"fonts": [{}],
"logo_file_ids": ["file_01HT9WK8N3M2J4A5Z6P7Q8R9TV"],
"idempotency_key": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
name: '<string>',
colors: [{}],
fonts: [{}],
logo_file_ids: ['file_01HT9WK8N3M2J4A5Z6P7Q8R9TV'],
idempotency_key: '<string>'
})
};
fetch('https://api.moda.app/v1/brand-kits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.moda.app/v1/brand-kits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'name' => '<string>',
'colors' => [
[
]
],
'fonts' => [
[
]
],
'logo_file_ids' => [
'file_01HT9WK8N3M2J4A5Z6P7Q8R9TV'
],
'idempotency_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.moda.app/v1/brand-kits"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"colors\": [\n {}\n ],\n \"fonts\": [\n {}\n ],\n \"logo_file_ids\": [\n \"file_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n ],\n \"idempotency_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.moda.app/v1/brand-kits")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"colors\": [\n {}\n ],\n \"fonts\": [\n {}\n ],\n \"logo_file_ids\": [\n \"file_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n ],\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.moda.app/v1/brand-kits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"colors\": [\n {}\n ],\n \"fonts\": [\n {}\n ],\n \"logo_file_ids\": [\n \"file_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n ],\n \"idempotency_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}Create Brand Kit
Create a brand kit — from a URL (extraction) or from direct fields (manual).
Pass url to run server-side extraction of brand info from a website,
OR pass the manual token fields (colors / fonts / logo_file_ids
with a name) to build a kit from what you already hold — the same write
the web app’s manual onboarding performs, for brands without a website.
Those two are mutually exclusive, enforced by the request schema.
name is NOT exclusive with url: send both to extract the brand and
title the kit with the name you supply. The extracted company_name is
left as extracted — naming a kit is not asserting what the company is
called. At least one of url or name is required.
Honors idempotency_key through the shared pipeline (a keyed retry
replays the stored result instead of minting a duplicate kit). A stored
result whose kit was DELETED since does not replay: the stale record is
invalidated and the create re-executes fresh (loud
stale_replay_invalidated marker). Brand create is NOT metered on
either path — no billing runs here — so the response carries the
zero-credit deterministic usage receipt.
curl --request POST \
--url https://api.moda.app/v1/brand-kits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"name": "<string>",
"colors": [
{}
],
"fonts": [
{}
],
"logo_file_ids": [
"file_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
],
"idempotency_key": "<string>"
}
'import requests
url = "https://api.moda.app/v1/brand-kits"
payload = {
"url": "<string>",
"name": "<string>",
"colors": [{}],
"fonts": [{}],
"logo_file_ids": ["file_01HT9WK8N3M2J4A5Z6P7Q8R9TV"],
"idempotency_key": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
name: '<string>',
colors: [{}],
fonts: [{}],
logo_file_ids: ['file_01HT9WK8N3M2J4A5Z6P7Q8R9TV'],
idempotency_key: '<string>'
})
};
fetch('https://api.moda.app/v1/brand-kits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.moda.app/v1/brand-kits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'name' => '<string>',
'colors' => [
[
]
],
'fonts' => [
[
]
],
'logo_file_ids' => [
'file_01HT9WK8N3M2J4A5Z6P7Q8R9TV'
],
'idempotency_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.moda.app/v1/brand-kits"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"colors\": [\n {}\n ],\n \"fonts\": [\n {}\n ],\n \"logo_file_ids\": [\n \"file_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n ],\n \"idempotency_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.moda.app/v1/brand-kits")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"colors\": [\n {}\n ],\n \"fonts\": [\n {}\n ],\n \"logo_file_ids\": [\n \"file_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n ],\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.moda.app/v1/brand-kits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"colors\": [\n {}\n ],\n \"fonts\": [\n {}\n ],\n \"logo_file_ids\": [\n \"file_01HT9WK8N3M2J4A5Z6P7Q8R9TV\"\n ],\n \"idempotency_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}Authorizations
API key from Settings > Developer > REST API
Headers
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.
2026-04-12, 2026-05-01 "2026-05-01"
Body
Request body for POST /v1/brand-kits — two creation paths.
Extraction (url): server-side extraction of colors, fonts, and logos
from a live website. Manual (name + optional colors / fonts /
logo_file_ids): build the kit from directly-supplied fields — for brands
with no website, or when the caller already holds the ground truth.
url is mutually exclusive with the manual TOKEN fields (colors /
fonts / logo_file_ids), which would assert a second source of truth for
fields the site already answers. name is NOT exclusive with it: passing both
extracts the brand and titles the kit with the supplied name (ENG-5415). At
least one of url or name must be provided.
Company website URL or domain (e.g. 'stripe.com') to extract brand data from. Mutually exclusive with the manual TOKEN fields (colors / fonts / logo_file_ids). name may accompany it: it titles the kit. The extracted company_name is left as extracted — naming a kit is not asserting the company's name.
Display name for the kit. On the MANUAL path it is also stored as the kit's company_name. Required there, and OPTIONAL alongside url, where it titles the kit only — extraction keeps ownership of company_name (ENG-5415).
1 - 255Manual path only: initial palette as an array of {color, label?, mode?, gradient?} objects (color is a hex string, e.g. '#0F172A'; mode is 'light' / 'dark' / 'any'). Same shape as the PATCH colors field.
Manual path only: initial fonts as an array of {family, label?, weight?} objects. Same shape as the PATCH fonts field. Each font's supported flag is derived server-side from the platform + team font catalogs; a caller-supplied value is ignored.
Manual path only: file_ IDs (from POST /v1/uploads) to attach as logos. Files must be images (image/*). Equivalent to calling addBrandKitImage with role='logo' for each after create, but atomic with the create itself.
20Prefixed file_ 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), as is the prefix over a UUID body (file_00000000-0000-4000-8000-000000000000). All three are permanent, supported inputs; only the canonical form is ever emitted.
^file_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$A retried create with the same key replays the stored result (replayed: true) instead of creating a second brand kit. Same-key reuse with a different payload is a 409 idempotency_conflict.
200Response
Successful Response
The response is of type Response Createbrandkit · object.