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

# Describe a catalog object

> Scope: `read`.



## OpenAPI

````yaml /openapi.json get /api/v1/catalog/{ref}
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 project 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 project, or single collections and assets. A scope shown
    as needed on the project 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/catalog/{ref}:
    parameters:
      - name: ref
        in: path
        required: true
        schema:
          type: string
        description: An id, or an address
    get:
      summary: Describe a catalog object
      description: 'Scope: `read`.'
      responses:
        '200':
          description: The object
          content:
            application/json:
              schema:
                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)$
                  type:
                    type: string
                    enum:
                      - brand
                      - collection
                      - asset
                      - portal
                      - rule
                      - page
                  slug:
                    type: string
                  name:
                    type: string
                  address:
                    type: string
                    description: >-
                      {org}/{project}/{type}/{slug}[@release]; a part after its
                      object
                  description:
                    type:
                      - string
                      - 'null'
                  status:
                    type: string
                    enum:
                      - draft
                      - in_review
                      - current
                      - replaced
                      - archived
                  release:
                    anyOf:
                      - type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      - type: 'null'
                  expires:
                    type:
                      - string
                      - 'null'
                  expiring:
                    type: boolean
                  private:
                    type: boolean
                  tags:
                    type: array
                    items:
                      type: string
                  project:
                    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)$
                      slug:
                        type: string
                      name:
                        type: string
                    required:
                      - id
                      - slug
                      - name
                    additionalProperties: false
                  parent:
                    anyOf:
                      - 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)$
                          type:
                            type: string
                            enum:
                              - brand
                              - collection
                              - asset
                              - portal
                              - rule
                              - page
                          slug:
                            type: string
                          name:
                            type: string
                        required:
                          - id
                          - type
                          - slug
                          - name
                        additionalProperties: false
                      - type: 'null'
                  createdAt:
                    type: string
                  updatedAt:
                    type: string
                  usedBy:
                    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)$
                        type:
                          type: string
                          enum:
                            - brand
                            - collection
                            - asset
                            - portal
                            - rule
                            - page
                        slug:
                          type: string
                        name:
                          type: string
                        address:
                          type: string
                          description: >-
                            {org}/{project}/{type}/{slug}[@release]; a part
                            after its object
                        description:
                          type:
                            - string
                            - 'null'
                        status:
                          type: string
                          enum:
                            - draft
                            - in_review
                            - current
                            - replaced
                            - archived
                        release:
                          anyOf:
                            - type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            - type: 'null'
                        expires:
                          type:
                            - string
                            - 'null'
                        expiring:
                          type: boolean
                        private:
                          type: boolean
                        tags:
                          type: array
                          items:
                            type: string
                        project:
                          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)$
                            slug:
                              type: string
                            name:
                              type: string
                          required:
                            - id
                            - slug
                            - name
                          additionalProperties: false
                        parent:
                          anyOf:
                            - 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)$
                                type:
                                  type: string
                                  enum:
                                    - brand
                                    - collection
                                    - asset
                                    - portal
                                    - rule
                                    - page
                                slug:
                                  type: string
                                name:
                                  type: string
                              required:
                                - id
                                - type
                                - slug
                                - name
                              additionalProperties: false
                            - type: 'null'
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                      required:
                        - id
                        - type
                        - slug
                        - name
                        - address
                        - description
                        - status
                        - release
                        - expires
                        - expiring
                        - private
                        - tags
                        - project
                        - parent
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                  usedByCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  lineage:
                    type: object
                    properties:
                      up:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      down:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                    required:
                      - up
                      - down
                    additionalProperties: false
                  sharedWith:
                    type: array
                    items:
                      type: object
                      properties:
                        grant:
                          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)$
                        project:
                          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)$
                            slug:
                              type: string
                            name:
                              type: string
                          required:
                            - id
                            - slug
                            - name
                          additionalProperties: false
                        role:
                          type: string
                      required:
                        - grant
                        - project
                        - role
                      additionalProperties: false
                  open:
                    type: string
                    description: Where the app shows it
                required:
                  - id
                  - type
                  - slug
                  - name
                  - address
                  - description
                  - status
                  - release
                  - expires
                  - expiring
                  - private
                  - tags
                  - project
                  - parent
                  - createdAt
                  - updatedAt
                  - usedBy
                  - usedByCount
                  - lineage
                  - sharedWith
                  - open
                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

````

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