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

# Brand rules

> The canon, as structured records: `color.primary`, `logo.neverDo`, `type.scale`. Without `context`, every rule and its context variants. With one, one rule per key: the context's own where it has one, the default otherwise.

Scope: `read`.



## OpenAPI

````yaml /openapi.json get /api/v1/brand/rules
openapi: 3.1.0
info:
  title: artbucket
  version: '1'
  description: >-
    Agent-first asset management. The web UI is built on this API and nothing
    else, beside signing in at /api/auth. Send `Authorization: Bearer <key>`: a
    key works in one workspace with one scope, and scopes are a ladder: read <
    propose < write < admin. People signed in to the app carry a session cookie
    instead, and their scope is what their grants add up to: on the
    organization, the workspace, or single collections and assets. A scope shown
    as needed on the workspace is also enough on the one collection or asset a
    route acts on. Agents (MCP at POST /api/v1/mcp) usually get `propose`: what
    they add waits for a human.
servers:
  - url: http://localhost:3000
security:
  - bearer: []
  - session: []
  - {}
paths:
  /api/v1/brand/rules:
    get:
      summary: Brand rules
      description: >-
        The canon, as structured records: `color.primary`, `logo.neverDo`,
        `type.scale`. Without `context`, every rule and its context variants.
        With one, one rule per key: the context's own where it has one, the
        default otherwise.


        Scope: `read`.
      parameters:
        - name: brand
          in: query
          schema:
            type: string
          description: A brand's slug; the default brand when left out
        - name: context
          in: query
          schema:
            type: string
          description: A slug, e.g. instagram-story or dark-background
        - name: asset
          in: query
          schema:
            type: string
            format: uuid
          description: Only the rules that point at this asset
      responses:
        '200':
          description: Rules, and the contexts in use
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        brand:
                          type: string
                          description: The brand's slug
                        key:
                          type: string
                          description: Dotted, e.g. color.primary
                        context:
                          description: 'null: the default'
                          type:
                            - string
                            - 'null'
                        type:
                          type: string
                          enum:
                            - color
                            - text
                            - number
                            - list
                            - font
                        value:
                          anyOf:
                            - type: string
                            - type: number
                            - type: array
                              items:
                                type:
                                  - string
                                  - number
                            - type: object
                              properties:
                                family:
                                  type: string
                                  minLength: 1
                                  maxLength: 120
                                size:
                                  description: Pixels
                                  type: number
                                  exclusiveMinimum: 0
                                  maximum: 1000
                                weight:
                                  description: 400 regular, 700 bold
                                  type: integer
                                  minimum: 1
                                  maximum: 1000
                              required:
                                - family
                              additionalProperties: false
                        usage:
                          type:
                            - string
                            - 'null'
                        assets:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                format: uuid
                                pattern: >-
                                  ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                              rendition:
                                type:
                                  - string
                                  - 'null'
                              title:
                                type:
                                  - string
                                  - 'null'
                              filename:
                                type: string
                              mime:
                                type: string
                              width:
                                anyOf:
                                  - type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  - type: 'null'
                              height:
                                anyOf:
                                  - type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  - type: 'null'
                            required:
                              - id
                              - rendition
                              - title
                              - filename
                              - mime
                              - width
                              - height
                            additionalProperties: false
                          description: >-
                            Assets it points at, in order: /a/{id}, or
                            /a/{id}/{rendition} when it names one
                        updatedAt:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                      required:
                        - id
                        - brand
                        - key
                        - context
                        - type
                        - value
                        - usage
                        - assets
                        - updatedAt
                      additionalProperties: false
                  contexts:
                    type: array
                    items:
                      type: string
                    description: Every context some rule is scoped to
                required:
                  - data
                  - contexts
                additionalProperties: false
        default:
          description: An error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      detail: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: 'An API key: ab_...'
    session:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: Signed in, at /api/auth

````