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

# A brand's launch checklist and Brand Agent Score

> The steps every brand takes before it is worth sharing, in order: colors, typefaces, logo and voice in the rules, pages worth reading, a publish readers see, and a portal. `next` is the first step not done. `score` is the Brand Agent Score, 0 to 100, and each step's `points` what it adds once done.

Scope: `read`.



## OpenAPI

````yaml /openapi.json get /api/v1/brands/{slug}/status
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}/status:
    parameters:
      - name: slug
        in: path
        required: true
        description: Brand slug
        schema:
          type: string
    get:
      summary: A brand's launch checklist and Brand Agent Score
      description: >-
        The steps every brand takes before it is worth sharing, in order:
        colors, typefaces, logo and voice in the rules, pages worth reading, a
        publish readers see, and a portal. `next` is the first step not done.
        `score` is the Brand Agent Score, 0 to 100, and each step's `points`
        what it adds once done.


        Scope: `read`.
      responses:
        '200':
          description: The checklist
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      brand:
                        type: object
                        properties:
                          slug:
                            type: string
                          name:
                            type: string
                          default:
                            type: boolean
                        required:
                          - slug
                          - name
                          - default
                        additionalProperties: false
                      brands:
                        type: array
                        items:
                          type: object
                          properties:
                            slug:
                              type: string
                            name:
                              type: string
                            default:
                              type: boolean
                          required:
                            - slug
                            - name
                            - default
                          additionalProperties: false
                        description: Every brand, the default first
                      steps:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              enum:
                                - colors
                                - type
                                - logo
                                - voice
                                - pages
                                - publish
                                - portal
                            title:
                              type: string
                            done:
                              description: 'null: the caller can''t tell'
                              type:
                                - boolean
                                - 'null'
                            detail:
                              type: string
                            agent:
                              type: string
                              description: How an agent does it, with the tools by name
                            points:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                              description: >-
                                What it adds to the Brand Agent Score once done;
                                0 when the caller can't tell
                          required:
                            - id
                            - title
                            - done
                            - detail
                            - agent
                            - points
                          additionalProperties: false
                        description: In the order to take them
                      done:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      total:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      score:
                        type: integer
                        minimum: 0
                        maximum: 100
                        description: >-
                          The Brand Agent Score: the steps done, weighed by what
                          each gives an agent
                      next:
                        description: The first step not done; null when the brand is ready
                        type:
                          - string
                          - 'null'
                      publish:
                        type: string
                        enum:
                          - never
                          - behind
                          - current
                        description: >-
                          never published, changes since the last publish, or up
                          to date
                      live:
                        anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                        description: >-
                          The release readers see, by number; null before the
                          first
                      portals:
                        anyOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                slug:
                                  type: string
                                name:
                                  type: string
                                access:
                                  type: string
                                  enum:
                                    - public
                                    - password
                                    - members
                                url:
                                  type: string
                                  format: uri
                              required:
                                - slug
                                - name
                                - access
                                - url
                              additionalProperties: false
                          - type: 'null'
                        description: >-
                          The portals showing it; null without the right to
                          manage portals
                      hub:
                        anyOf:
                          - type: object
                            properties:
                              visibility:
                                type: string
                                enum:
                                  - private
                                  - public
                                description: >-
                                  private: the workspace's people see it on
                                  BrandHub, signed in; public: anyone and any
                                  agent
                              url:
                                type: string
                                format: uri
                                description: >-
                                  Its page there: BrandHub's own address when
                                  public, the app's /hub when private
                              published:
                                anyOf:
                                  - type: object
                                    properties:
                                      number:
                                        type: integer
                                        minimum: -9007199254740991
                                        maximum: 9007199254740991
                                      publishedAt:
                                        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:
                                      - number
                                      - publishedAt
                                    additionalProperties: false
                                  - type: 'null'
                                description: >-
                                  What BrandHub shows: the latest publish; null:
                                  nothing yet
                              portal:
                                anyOf:
                                  - type: object
                                    properties:
                                      slug:
                                        type: string
                                      name:
                                        type: string
                                    required:
                                      - slug
                                      - name
                                    additionalProperties: false
                                  - type: 'null'
                                description: The portal it links as its guidelines
                              chosen:
                                type: boolean
                                description: >-
                                  That portal was picked; false: it is the
                                  brand's first public portal
                              pulls:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                                description: >-
                                  Its BrandHub files (brand.json, llms.txt,
                                  tokens) read in the last 30 days, as its
                                  BrandHub card shows
                              delisted:
                                description: >-
                                  Taken off BrandHub by whoever runs the server,
                                  and why: it can't be made public until they
                                  list it again
                                type:
                                  - string
                                  - 'null'
                              movedTo:
                                description: >-
                                  Claimed by whoever proved its domain: the
                                  listing that took its place, as {org}/{brand};
                                  it can't be made public again
                                type:
                                  - string
                                  - 'null'
                              ref:
                                type: string
                                description: 'How BrandHub names it: {org}/{brand}'
                              verified:
                                description: >-
                                  What its organization proved it holds, a
                                  domain or github.com/{login}; null: a
                                  community listing
                                type:
                                  - string
                                  - 'null'
                              terms:
                                description: >-
                                  The terms of use its guidelines portal asks
                                  readers to accept, in markdown
                                type:
                                  - string
                                  - 'null'
                            required:
                              - visibility
                              - url
                              - published
                              - portal
                              - chosen
                              - pulls
                              - delisted
                              - ref
                              - verified
                              - terms
                            additionalProperties: false
                          - type: 'null'
                        description: The brand on BrandHub; null when this server has none
                      url:
                        type: string
                        format: uri
                        description: Its guidelines in the app, to read
                    required:
                      - brand
                      - brands
                      - steps
                      - done
                      - total
                      - score
                      - next
                      - publish
                      - live
                      - portals
                      - hub
                      - url
                    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

````