---
title: "Creates a brand guide"
method: POST
path: "/brand-guides"
tags: ["Brand guides"]
---

# Creates a brand guide

`POST /brand-guides`

## Request

- Base URL: `https://api.kontainer.com/jsonapi/v2`
- URL: `https://api.kontainer.com/jsonapi/v2/brand-guides`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kontainer/apis/kontainer-api-documentation/docs/brand-guides/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a brand with its brand guide. brand is required; every other section starts empty when left out. Client admins only.

## Request body

- BrandGuideCreateRequest
  - `data` object, required
    - `type` 'brand_guides', required
    - `attributes` BrandGuideSections, required
      - `brand` object
        - `name` string, required
        - `description` string, required
        - `defaultLanguage` string, required
        - `industry` string, nullable, required
        - `geographicFocus` string, nullable, required
        - `coverImage` object, nullable, required
          - `fileId` integer, required
          - `name` string, nullable
          - `extension` string, nullable
          - `previewUrl` string, nullable
          - `cdnUrl` string, nullable
          - `width` integer, nullable
          - `height` integer, nullable
      - `identity` object
        - `vision` string, nullable, required
        - `mission` string, nullable, required
        - `purpose` string, nullable, required
        - `positioning` string, nullable, required
        - `values` object[], required
          - `id` string, required
          - `name` string, required
          - `description` string, required
        - `keyMessages` object[], required
          - `id` string, required
          - `title` string, required
          - `message` string, required
        - `audiences` object[], required
          - `id` string, required
          - `name` string, required
          - `description` string, required
          - `needs` string[], required
      - `voice` object
        - `summary` string, nullable, required
        - `traits` object[], required
          - `id` string, required
          - `name` string, required
          - `meaning` string, required
          - `do` string, required
          - `avoid` string, required
        - `formality` integer, nullable, required
        - `sentenceStyle` string, nullable, required
        - `examples` object[], required
          - `id` string, required
          - `type` 'sounds_like_us' | 'not_like_us', required
          - `text` string, required
          - `explanation` string, required
      - `writing` object
        - `preferredTerms` object[], required
          - `id` string, required
          - `term` string, required
          - `note` string, required
        - `avoidTerms` object[], required
          - `id` string, required
          - `term` string, required
          - `alternative` string, required
          - `reason` string, required
        - `forbiddenTerms` object[], required
          - `id` string, required
          - `term` string, required
          - `reason` string, required
        - `namingRules` object[], required
          - `id` string, required
          - `rule` string, required
          - `example` string, required
        - `formattingRules` object[], required
          - `id` string, required
          - `rule` string, required
          - `example` string, nullable, required
        - `prohibitedClaims` string[], required
      - `visual_identity` object
        - `colors` object[]
          - `id` string, required
          - `name` string, required
          - `role` string, required
          - `description` string, nullable, required
          - `usage` string, nullable, required
          - `avoid` string, nullable, required
          - `values` object, required
            - `hex` string, required
            - `rgb` integer[], required
            - `cmyk` integer[], nullable, required
            - `pantone` string, nullable, required
          - `token` object, nullable, required
            - `id` string, required
            - `cssVariable` string, required
        - `typography` object
          - `usage` string, nullable, required
          - `families` object[], required
            - `id` string, required
            - `name` string, required
            - `role` string, required
            - `fallback` string, required
            - `description` string, nullable, required
            - `usage` string, nullable, required
            - `avoid` string, nullable, required
            - `source` 'google' | 'adobe' | 'system' | 'self_hosted', required
            - `cssUrl` string, nullable, required
            - `styles` object[], required
              - …
            - `files` object[], required
              - …
            - `token` object, nullable, required
              - …
        - `logos` object[]
          - `id` string, required
          - `name` string, required
          - `role` string, required
          - `theme` 'light' | 'dark' | 'any', required
          - `description` string, nullable, required
          - `asset` object, required
            - `fileId` integer, required
            - `name` string, nullable
            - `extension` string, nullable
            - `previewUrl` string, nullable
            - `cdnUrl` string, nullable
            - `width` integer, nullable
            - `height` integer, nullable
          - `minSize` object, required
            - `digital` object, nullable, required
              - …
            - `print` object, nullable, required
              - …
          - `clearSpace` object, nullable, required
            - `value` number, nullable, required
            - `unit` 'logo_height' | 'logo_width' | 'element_height' | 'element_width' | 'px' | 'mm', required
            - `description` string, nullable, required
            - `element` object, nullable
              - …
          - `approvedBackgroundColorIds` string[], required
          - `rules` object[], required
            - `id` string, required
            - `type` 'do' | 'dont', required
            - `text` string, required
            - `asset` object, nullable
              - …
        - `icons` object
          - `summary` string, nullable, required
          - `rules` object[], required
            - `id` string, required
            - `type` 'do' | 'dont', required
            - `text` string, required
            - `asset` object, nullable
              - …
          - `items` object[], required
            - `id` string, required
            - `name` string, required
            - `meaning` string, required
            - `category` string, required
            - `style` string, nullable, required
            - `keywords` string[], required
            - `asset` object, required
              - …
        - `imagery` object
          - `summary` string, nullable, required
          - `keywords` string[], required
          - `rules` object[], required
            - `id` string, required
            - `type` 'do' | 'dont', required
            - `text` string, required
            - `asset` object, nullable
              - …
          - `goodExamples` object[], required
            - `note` string, required
            - `asset` object, required
              - …
          - `avoidExamples` object[], required
            - `note` string, required
            - `asset` object, required
              - …
        - `customSections` object[]
          - `id` string, required
          - `name` string, required
          - `icon` string, nullable, required
          - `summary` string, nullable, required
          - `items` object[], required
            - `id` string, required
            - `name` string, required
            - `role` string, nullable, required
            - `description` string, nullable, required
            - `specs` object[], required
              - …
            - `asset` object, nullable, required
              - …
          - `rules` object[], required
            - `id` string, required
            - `type` 'do' | 'dont', required
            - `text` string, required
            - `asset` object, nullable
              - …
      - `rules` object[]
        - `id` string, required
        - `type` 'do' | 'dont' | 'rule', required
        - `category` string, required
        - `title` string, required
        - `description` string, required
      - `ai_instructions` object
        - `systemGuidance` string, nullable, required
        - `uncertainty` 'ask' | 'safest_default' | 'return_unknown', required
        - `uncertaintyNote` string, nullable, required
        - `assetSelection` string, nullable, required
        - `isBrandIsolated` boolean, required
        - `brandIsolationNote` string, nullable, required
        - `sourceReference` 'never' | 'when_requested' | 'always', required

## Response `201`

created

- BrandGuideResponse
  - `data` BrandGuide
    - `id` string
    - `type` 'brand_guides'
    - `attributes` BrandGuideAttributes: The attributes named in fields[brand_guides]; every attribute but markdown when it is left out.
      - `schema_version` string
      - `governance` object
        - `updatedAt` string
        - `updatedBy` string, nullable
        - `sectionVersions` object
      - `brand` object
        - `name` string, required
        - `description` string, required
        - `defaultLanguage` string, required
        - `industry` string, nullable, required
        - `geographicFocus` string, nullable, required
        - `coverImage` object, nullable, required
          - `fileId` integer, required
          - `name` string, nullable
          - `extension` string, nullable
          - `previewUrl` string, nullable
          - `cdnUrl` string, nullable
          - `width` integer, nullable
          - `height` integer, nullable
      - `identity` object
        - `vision` string, nullable, required
        - `mission` string, nullable, required
        - `purpose` string, nullable, required
        - `positioning` string, nullable, required
        - `values` object[], required
          - `id` string, required
          - `name` string, required
          - `description` string, required
        - `keyMessages` object[], required
          - `id` string, required
          - `title` string, required
          - `message` string, required
        - `audiences` object[], required
          - `id` string, required
          - `name` string, required
          - `description` string, required
          - `needs` string[], required
      - `voice` object
        - `summary` string, nullable, required
        - `traits` object[], required
          - `id` string, required
          - `name` string, required
          - `meaning` string, required
          - `do` string, required
          - `avoid` string, required
        - `formality` integer, nullable, required
        - `sentenceStyle` string, nullable, required
        - `examples` object[], required
          - `id` string, required
          - `type` 'sounds_like_us' | 'not_like_us', required
          - `text` string, required
          - `explanation` string, required
      - `writing` object
        - `preferredTerms` object[], required
          - `id` string, required
          - `term` string, required
          - `note` string, required
        - `avoidTerms` object[], required
          - `id` string, required
          - `term` string, required
          - `alternative` string, required
          - `reason` string, required
        - `forbiddenTerms` object[], required
          - `id` string, required
          - `term` string, required
          - `reason` string, required
        - `namingRules` object[], required
          - `id` string, required
          - `rule` string, required
          - `example` string, required
        - `formattingRules` object[], required
          - `id` string, required
          - `rule` string, required
          - `example` string, nullable, required
        - `prohibitedClaims` string[], required
      - `visual_identity` object
        - `colors` object[], required
          - `id` string, required
          - `name` string, required
          - `role` string, required
          - `description` string, nullable, required
          - `usage` string, nullable, required
          - `avoid` string, nullable, required
          - `values` object, required
            - `hex` string, required
            - `rgb` integer[], required
            - `cmyk` integer[], nullable, required
            - `pantone` string, nullable, required
          - `token` object, nullable, required
            - `id` string, required
            - `cssVariable` string, required
        - `typography` object, required
          - `usage` string, nullable, required
          - `families` object[], required
            - `id` string, required
            - `name` string, required
            - `role` string, required
            - `fallback` string, required
            - `description` string, nullable, required
            - `usage` string, nullable, required
            - `avoid` string, nullable, required
            - `source` 'google' | 'adobe' | 'system' | 'self_hosted', required
            - `cssUrl` string, nullable, required
            - `styles` object[], required
              - …
            - `files` object[], required
              - …
            - `token` object, nullable, required
              - …
        - `logos` object[], required
          - `id` string, required
          - `name` string, required
          - `role` string, required
          - `theme` 'light' | 'dark' | 'any', required
          - `description` string, nullable, required
          - `asset` object, required
            - `fileId` integer, required
            - `name` string, nullable
            - `extension` string, nullable
            - `previewUrl` string, nullable
            - `cdnUrl` string, nullable
            - `width` integer, nullable
            - `height` integer, nullable
          - `minSize` object, required
            - `digital` object, nullable, required
              - …
            - `print` object, nullable, required
              - …
          - `clearSpace` object, nullable, required
            - `value` number, nullable, required
            - `unit` 'logo_height' | 'logo_width' | 'element_height' | 'element_width' | 'px' | 'mm', required
            - `description` string, nullable, required
            - `element` object, nullable
              - …
          - `approvedBackgroundColorIds` string[], required
          - `rules` object[], required
            - `id` string, required
            - `type` 'do' | 'dont', required
            - `text` string, required
            - `asset` object, nullable
              - …
        - `icons` object, required
          - `summary` string, nullable, required
          - `rules` object[], required
            - `id` string, required
            - `type` 'do' | 'dont', required
            - `text` string, required
            - `asset` object, nullable
              - …
          - `items` object[], required
            - `id` string, required
            - `name` string, required
            - `meaning` string, required
            - `category` string, required
            - `style` string, nullable, required
            - `keywords` string[], required
            - `asset` object, required
              - …
        - `imagery` object, required
          - `summary` string, nullable, required
          - `keywords` string[], required
          - `rules` object[], required
            - `id` string, required
            - `type` 'do' | 'dont', required
            - `text` string, required
            - `asset` object, nullable
              - …
          - `goodExamples` object[], required
            - `note` string, required
            - `asset` object, required
              - …
          - `avoidExamples` object[], required
            - `note` string, required
            - `asset` object, required
              - …
        - `customSections` object[], required
          - `id` string, required
          - `name` string, required
          - `icon` string, nullable, required
          - `summary` string, nullable, required
          - `items` object[], required
            - `id` string, required
            - `name` string, required
            - `role` string, nullable, required
            - `description` string, nullable, required
            - `specs` object[], required
              - …
            - `asset` object, nullable, required
              - …
          - `rules` object[], required
            - `id` string, required
            - `type` 'do' | 'dont', required
            - `text` string, required
            - `asset` object, nullable
              - …
      - `rules` object[]
        - `id` string, required
        - `type` 'do' | 'dont' | 'rule', required
        - `category` string, required
        - `title` string, required
        - `description` string, required
      - `ai_instructions` object
        - `systemGuidance` string, nullable, required
        - `uncertainty` 'ask' | 'safest_default' | 'return_unknown', required
        - `uncertaintyNote` string, nullable, required
        - `assetSelection` string, nullable, required
        - `isBrandIsolated` boolean, required
        - `brandIsolationNote` string, nullable, required
        - `sourceReference` 'never' | 'when_requested' | 'always', required
      - `markdown` string
    - `links` object
      - `self` string

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid section, or a file the caller may not see

---

[API](https://skmtc.dev/kontainer/apis/kontainer-api-documentation.md) - [All operations](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/revisions/b80a5167e09a?raw)