Skip to main content
POST
Extract a brand kit from a URL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

POST /v1/brand-kits — extract a kit from a website.

url
string<uri>
required

Public website URL to extract brand tokens from.

Required string length: 1 - 2083
name
string | null

Optional label; defaults to the site's domain.

Maximum string length: 255

Response

Successful Response

id
string
required

Unique brand kit id.

Example:

"bk_01J8QR2K5VKDGN2T4FBM3CZYX7"

workspace_id
string
required
name
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
source_url
string | null

URL the kit was extracted from.

palette
Palette · object

Brand colors. Missing values mean 'not confidently extracted'.

fonts
Fonts · object

Typography — Google-family names (unvalidated; renderer resolves them).

logo_url
string | null
corner_feel
enum<string> | null
Available options:
sharp,
soft,
pill
confidence
Confidence · object

Per-field extraction confidence 0–1 (e.g. {'palette.primary': 0.8}).