v1 · API reference

Brand kits

Read-only Brand Kit profiles (voice, labeled colors, pinned library graphics, core pages) for on-brand template authoring. Writes and URL import stay in the dashboard (Settings → Brand).

Base URL: https://www.unitpost.com/api/v1/api/v1

Brand kits

List brand kits

GET/api/v1/api/v1/brand-kits

GET /brand-kits

curl -X GET 'https://www.unitpost.com/api/v1/api/v1/brand-kits' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response · 200

{
  "object": "list",
  "data": [
    {
      "object": "brand_kit",
      "id": "id_123",
      "name": "Example",
      "is_default": false,
      "website_url": "https://example.com",
      "description": "string",
      "tone": "NEUTRAL",
      "voice_notes": "string",
      "industry": "string",
      "core_pages": [
        {
          "url": "https://example.com",
          "title": "string"
        }
      ],
      "extracted": {
        "colors": [
          {
            "hex": "string",
            "label": "string"
          }
        ],
        "logo_urls": [
          "string"
        ],
        "background_urls": [
          "string"
        ],
        "fonts": [
          "string"
        ]
      },
      "graphics": [
        {
          "library_image_id": "library_image_123",
          "role": "logo",
          "label": "string"
        }
      ],
      "source": "string",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "default_id": "default_123"
}

Retrieve every Brand Kit profile in the workspace (up to five named profiles). Each profile holds tone, about, voice notes, labeled colors, pinned logo/background library images, and core pages — the primary brand context for on-brand template authoring. Pass ?name= to filter to one profile by display name (case-insensitive). The response includes default_id for the Default profile. Fetch one by id with Retrieve a brand kit. Writes and URL import stay in the dashboard (Settings → Brand). Requires the templates:read capability.

Parameters1 field

Field	Type	Description
`name`	string · query	Filter to a single profile by display name (case-insensitive).

Response · 200 fields14 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`is_default`required	boolean	—
`website_url`required	object	—
`description`required	object	—
`tone`required	object	—
`voice_notes`required	object	—
`industry`required	object	—
`core_pages`required	object[]	—
`extracted`required	object	—
`graphics`required	object[]	—
`source`required	object	—
`updated_at`required	object	—

200401403

Retrieve a brand kit

GET/api/v1/api/v1/brand-kits/{id}

GET /brand-kits/{id}

curl -X GET 'https://www.unitpost.com/api/v1/api/v1/brand-kits/123' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response · 200

{
  "object": "brand_kit",
  "id": "id_123",
  "name": "Example",
  "is_default": false,
  "website_url": "https://example.com",
  "description": "string",
  "tone": "NEUTRAL",
  "voice_notes": "string",
  "industry": "string",
  "core_pages": [
    {
      "url": "https://example.com",
      "title": "string"
    }
  ],
  "extracted": {
    "colors": [
      {
        "hex": "string",
        "label": "string"
      }
    ],
    "logo_urls": [
      "string"
    ],
    "background_urls": [
      "string"
    ],
    "fonts": [
      "string"
    ]
  },
  "graphics": [
    {
      "library_image_id": "library_image_123",
      "role": "logo",
      "label": "string"
    }
  ],
  "source": "string",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Retrieve one Brand Kit profile by id (bk_…), including voice, labeled colors, pinned graphics (library_image_id for /img/{id} in design TSX), and core pages. List every profile with List brand kits. Requires the templates:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields14 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`is_default`required	boolean	—
`website_url`required	object	—
`description`required	object	—
`tone`required	object	—
`voice_notes`required	object	—
`industry`required	object	—
`core_pages`required	object[]	—
`extracted`required	object	—
`graphics`required	object[]	—
`source`required	object	—
`updated_at`required	object	—

200401403404