> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List the brand standards you may use

> NX1 style first, then registry brands at their newest approved version (Global ones you may use, and your own), with the default marked.



## OpenAPI

````yaml get /api/chat/brands
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/chat/brands:
    get:
      tags:
        - Chat
      summary: List the brand standards you may use
      description: >-
        NX1 style first, then registry brands at their newest approved version
        (Global ones you may use, and your own), with the default marked.
      operationId: list_brands_api_chat_brands_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ChatBrandResponse'
                type: array
                title: Response List Brands Api Chat Brands Get
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    ChatBrandResponse:
      properties:
        id:
          type: string
          title: Id
        version:
          anyOf:
            - type: string
            - type: 'null'
          title: Version
        name:
          type: string
          title: Name
        palette:
          $ref: '#/components/schemas/BrandPalette'
        heading_font:
          type: string
          enum:
            - serif
            - sans
          title: Heading Font
        footer:
          anyOf:
            - type: string
            - type: 'null'
          title: Footer
        slide_numbers:
          type: boolean
          title: Slide Numbers
        dark_title_slides:
          type: boolean
          title: Dark Title Slides
        is_default:
          type: boolean
          title: Is Default
        built_in:
          type: boolean
          title: Built In
          default: false
        scope:
          anyOf:
            - type: string
              enum:
                - personal
                - tenant
            - type: 'null'
          title: Scope
        logo_sha256:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Sha256
      type: object
      required:
        - id
        - name
        - palette
        - heading_font
        - slide_numbers
        - dark_title_slides
        - is_default
      title: ChatBrandResponse
      description: >-
        A brand standard the chat can use. The built-in NX1 style has the id

        ``nx1``; the rest are registry artifacts at their newest approved
        version.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    BrandPalette:
      properties:
        primary:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          title: Primary
          description: Labels, rules, headers.
        dark:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          title: Dark
          description: Title and section slides.
        accent1:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          title: Accent1
        accent2:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          title: Accent2
        accent3:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          title: Accent3
        background:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          title: Background
        text:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          title: Text
      type: object
      required:
        - primary
        - dark
        - accent1
        - accent2
        - accent3
        - background
        - text
      title: BrandPalette
      description: The colours a deck or PDF uses.
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.