> ## 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.

# Publish a brand

> Its latest version, rules, pages and theme, becomes the published one, and the next edit starts a new version. `note` says what changed, for readers, with `image` beside it. With nothing changed since the last publish, it answers `unchanged: true` and publishes nothing. Takes share on the workspace.

Scope: `write`.



## OpenAPI

````yaml /openapi.json post /api/v1/brands/{slug}/publish
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/brands/{slug}/publish:
    parameters:
      - name: slug
        in: path
        required: true
        description: Brand slug
        schema:
          type: string
    post:
      summary: Publish a brand
      description: >-
        Its latest version, rules, pages and theme, becomes the published one,
        and the next edit starts a new version. `note` says what changed, for
        readers, with `image` beside it. With nothing changed since the last
        publish, it answers `unchanged: true` and publishes nothing. Takes share
        on the workspace.


        Scope: `write`.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                note:
                  description: What changed, for readers of the history and What's new
                  type: string
                  maxLength: 2000
                image:
                  description: An asset shown beside the note
                  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)$
              additionalProperties: false
      responses:
        '200':
          description: The published version
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      number:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      kind:
                        type: string
                        enum:
                          - baseline
                          - edit
                          - restore
                      name:
                        type:
                          - string
                          - 'null'
                      actor:
                        type: string
                        description: >-
                          Who: a person's name, an API key's name, or "web" for
                          the app without an account
                      changed:
                        type: array
                        items:
                          type: string
                        description: Keys touched; a page as page:{slug}, and theme
                      restoredFrom:
                        anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                        description: 'For a restore: the version it put back'
                      summary:
                        type: string
                      rules:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      pages:
                        anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                        description: How many pages; null for a version from before pages
                      publishedAt:
                        anyOf:
                          - 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)))$
                          - type: 'null'
                        description: When it was published; null for a draft
                      publishedBy:
                        type:
                          - string
                          - 'null'
                      note:
                        description: What changed, for readers, given when it was published
                        type:
                          - string
                          - 'null'
                      noteImage:
                        anyOf:
                          - 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)$
                          - type: 'null'
                        description: An asset shown beside the note
                      createdAt:
                        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)))$
                      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)))$
                        description: >-
                          Edits close together extend a version; this is its
                          last
                      brand:
                        type: string
                      unchanged:
                        type: boolean
                        description: Nothing changed since the last publish, which stands
                      portals:
                        description: The portals showing it, where visitors now read it
                        type: array
                        items:
                          type: object
                          properties:
                            slug:
                              type: string
                            name:
                              type: string
                            url:
                              type: string
                              format: uri
                          required:
                            - slug
                            - name
                            - url
                          additionalProperties: false
                    required:
                      - number
                      - kind
                      - name
                      - actor
                      - changed
                      - restoredFrom
                      - summary
                      - rules
                      - pages
                      - publishedAt
                      - publishedBy
                      - note
                      - noteImage
                      - createdAt
                      - updatedAt
                      - brand
                      - unchanged
                    additionalProperties: false
                required:
                  - data
                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

````