---
title: "List brand kits (read-only)"
method: GET
path: "/v1/brand-kits"
tags: ["brand-kits"]
---

# List brand kits (read-only)

`GET /v1/brand-kits`

## Request

- Base URL: `https://api.cueframe.ai`
- URL: `https://api.cueframe.ai/v1/brand-kits`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.cueframe.ai/api/auth/mcp/authorize`, token URL `https://api.cueframe.ai/api/auth/mcp/token`, scopes: `projects:read`)
  - API key in header `PAYMENT-SIGNATURE`

Required permission: projects:read

## Query parameters

- `limit` integer
- `after` string

## Response `200`

Paginated brand kits.

- BrandKitListResponse
  - `data` BrandKitResponse[], required
    - `id` string, required
    - `name` string, required
    - `description` string, nullable, required
    - `tagline` string, nullable, required
    - `colors` object, required
    - `extraColors` object[]
      - `name` string, required
      - `value` string, required
    - `fonts` object, required
      - `heading` object, nullable, required
        - `family` string, required
        - `weight` union
          - number
          - string
      - `body` object, nullable, required
        - `family` string, required
        - `weight` union
          - number
          - string
    - `voiceGuidelines` string, nullable, required
    - `captions` object, required
      - `sync` boolean, required
      - `profile` object, nullable, required
    - `motion` object
      - `duration` number
      - `easing` union
        - 'linear' | 'ease' | 'ease-in' | 'ease-out' | 'ease-in-out'
        - object
          - `kind` 'cubic-bezier', required
          - `x1` number, required
          - `y1` number, required
          - `x2` number, required
          - `y2` number, required
      - `entrance` 'none' | 'fade' | 'word-pop' | 'stagger-up'
      - `staggerMs` number
      - `exitMs` number
    - `logo` object
      - `src` string, required
      - `alt` string
      - `placement` 'tl' | 'tr' | 'bl' | 'br'
      - `sizePct` number
    - `intro` object
      - `kind` 'card' | 'video', required
      - `src` string
      - `title` string
      - `subtitle` string
      - `durationMs` number
    - `outro` object
      - `kind` 'card' | 'video', required
      - `src` string
      - `title` string
      - `subtitle` string
      - `durationMs` number
    - `watermark` object
      - `src` string, required
      - `opacity` number
      - `placement` 'tl' | 'tr' | 'bl' | 'br'
    - `spacing` object
      - `base` number
      - `lg` number
      - `sm` number
    - `sizing` object
      - `fontSizeHeading` number
      - `fontSizeBody` number
      - `fontSizeLabel` number
      - `borderRadius` number
    - `audio` object
      - `sfxIntensity` 'off' | 'light' | 'standard' | 'dense'
      - `musicEnabled` boolean
      - `musicMood` string
      - `sonicLogo` object: A brand sound signature bound to the intro/outro bookend. `ref` = a palette reference; bound only when the kit carries the matching bumper (intro/outro), else a non-blocking advisory.
        - `ref` string, required
        - `placement` 'intro' | 'outro' | 'both', required
        - `offsetMs` integer
      - `uiSoundSet` object: Per-family SFX overrides (the brand's own tick/pop/…). Highest-priority tier over the org palette + pack default in the compose SFX draw.
        - `tick` string
        - `pop` string
        - `impact` string
        - `confirm` string
        - `error` string
        - `whoosh` string
        - `riser` string
      - `bedStyle` object: Preferred music bed (`bedId`) or a style hint (`genre` / `bpmRange`). Surfaced for driving agents; compose does not auto-select a pack bed.
        - `bedId` string
        - `genre` string
        - `bpmRange` object
          - `min` number, required
          - `max` number, required
      - `ambiencePreference` object, nullable: Preferred ambience bed (`{ref}`) or explicit null (opt-out). Surfaced for driving agents; compose has no ambience auto-placement.
        - `ref` string, required
    - `exemplarKeys` string[]
    - `contactSheetKey` string
    - `motifs` object[]
      - `id` string, required
      - `observed` string, required
      - `body` union, required
        - object
          - `kind` 'card', required
          - `html` string, required
          - `tokens` object
        - object
          - `kind` 'overlay', required
          - `primitiveId` string, required
          - `params` object
        - object
          - `kind` 'component', required
          - `componentId` string, required
          - `props` object
      - `motion` object
        - `preset` 'fade-up' | 'slide-in-left' | 'slide-in-right' | 'scale-pop' | 'stagger-reveal', required
        - `enterMs` integer
        - `exitMs` integer
        - `staggerMs` integer
        - `confidence` 'high' | 'low'
      - `role` 'title-card' | 'stat' | 'lower-third' | 'pull-quote' | 'hero' | 'logo-tag' | 'enumeration' | 'sequence' | 'comparison', required
      - `zone` object
        - `x` number, required
        - `y` number, required
        - `w` number, required
        - `h` number, required
      - `evidence` integer[]
      - `diffScore` number
      - `coverage` 'reproduced' | 'approximated' | 'skipped', required
      - `skipReason` string
    - `styleRubric` string
    - `density` object
      - `graphicsPerMin` number, required
      - `maxSimultaneous` integer, required
    - `inspiration` object
      - `sources` string[], required
      - `extractedAt` number, required
      - `extractionVersion` string, required
    - `createdAt` string, required
    - `updatedAt` string, required
  - `pagination` PaginationMeta, required: Cursor pagination metadata.
    - `hasMore` boolean, required
    - `nextCursor` string, nullable, required
    - `prevCursor` string, nullable, required

## Other responses

- `400`: Bad request — validation_error / invalid_cursor / invalid_query.
- `401`: Missing or invalid Authorization header.
- `402`: Payment required. Returned when the caller presents no API key on a priced operation: the body AND the `Payment-Required` header carry the x402 v2 challenge (accepted scheme, network, USDC asset, amount, payTo). Sign the EIP-3009 authorization and retry with a `PAYMENT-SIGNATURE` header. A KEYED caller sees this status instead when their plan lacks or has exhausted the feature (`billing_required`).
- `403`: Forbidden — permission insufficient.
- `404`: Resource not found.
- `422`: Unprocessable — invalid_composition / media_in_use / session_in_use / render_not_cancellable.
- `429`: Rate limited. Retry-After header present.
- `500`: Internal error.

---

[API](https://skmtc.dev/cueframe/apis/cueframe-api.md) · [All operations](https://skmtc.dev/cueframe/apis/cueframe-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cueframe/apis/cueframe-api/revisions/8f9bfe362b4a?raw)