Partner API Integration Guide The Brand Kit OS Partner API lets partner applications pull rich brand context to enhance AI generated content. This guide covers everything you need to integrate. Base URL: Getting Started Integration takes three steps: 1.
Link — Call with a to receive your API key and webhook secret. 2. Pull — Call before generating content to fetch the latest brand context. 3. Listen — Receive webhook pushes when a brand kit is updated or deleted.
Authentication Every request requires a token in the header: Per Partner Keys (recommended) During the step, Brand Kit OS returns a unique API key prefixed with .
This key is: Shown only once — save it securely Hashed (SHA 256) before storage — we never store the plaintext Independently revocable per partner integration Used for all subsequent API calls Global Key (deprecated) The legacy environment variable is still accepted as a fallback.
It will be removed in a future version. Migrate to per partner keys. API Reference POST /v1/integrations/partner/link Links a partner app to a Brand Kit OS brand kit. Called once during onboarding.
Request: | Field | Type | Required | Description | | | | | | | | UUID | ✅ | The Brand Kit OS brand kit to link | | | string | No | Your user's ID in your system | | | string | No | Your workspace/org ID | | | string (HTTPS) | No | URL to receive webhook deliveries | Response (201): ⚠️ Save and immediately.
They are displayed only once. GET /v1/brand kits/{brand kit id} Returns the full brand kit data for a single brand kit. Response (200): See Data Model Reference for the and schemas. GET /v1/brand kits Lists brand kits linked to a partner identity.
| Parameter | Type | Default | Description | | | | | | | | string | — | Filter by your user ID | | | string | — | Filter by your workspace ID | | | integer | 20 | Max results (1–100) | | | integer | 0 | Pagination offset | At least one of or is required.
Response (200): Data Model Reference Every brand kit response contains two data layers: — Drop in Fields Simplified fields that map directly to common partner fields (Description, Keywords, Style).
| Field | Type | Description | | | | | | | string | Combined business description and brand story | | | string | Comma separated tone descriptors, sentence style, vocabulary level | | | string[] | SEO keywords derived from products and benefits | | | string[] | Brand identity keywords from personality traits and values | | | string | Visual/image style description | — Rich Context Detailed brand data organized into 8 categories.
| Field | Type | Description | | | | | | | string[] | Tone descriptors (e.g.
"professional", "warm") | | | string[] | Brand personality trait names | | | string[] | Encouraged phrases and language patterns | | | string[] | Phrases to avoid | | | string | Target vocabulary level | | | string | Formality level (e.g.