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

# Who is calling

> The person or key, the workspace this request acts in (a key's own; for a person, the one in the `ab_workspace` cookie if they can open it), the scope there and on its organization, every workspace they can switch to, and how one signs in here.

Any caller; the scope needed is checked on what it acts on.



## OpenAPI

````yaml /openapi.json get /api/v1/me
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/me:
    get:
      summary: Who is calling
      description: >-
        The person or key, the workspace this request acts in (a key's own; for
        a person, the one in the `ab_workspace` cookie if they can open it), the
        scope there and on its organization, every workspace they can switch to,
        and how one signs in here.


        Any caller; the scope needed is checked on what it acts on.
      responses:
        '200':
          description: You
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      user:
                        anyOf:
                          - type: object
                            properties:
                              id:
                                type: string
                              name:
                                type: string
                              email:
                                type: string
                            required:
                              - id
                              - name
                              - email
                            additionalProperties: false
                          - type: 'null'
                        description: Signed in as; null for a key or nobody
                      key:
                        type: boolean
                        description: Calling with an API key
                      actor:
                        type: string
                        description: How history names you
                      workspace:
                        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
                          organization:
                            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
                        required:
                          - id
                          - slug
                          - name
                          - organization
                        additionalProperties: false
                        description: >-
                          Where this request acts: a key's workspace, or the one
                          picked in the app
                      scope:
                        anyOf:
                          - type: string
                            enum:
                              - read
                              - propose
                              - write
                              - admin
                          - type: 'null'
                        description: On the whole workspace
                      orgScope:
                        anyOf:
                          - type: string
                            enum:
                              - read
                              - propose
                              - write
                              - admin
                          - type: 'null'
                        description: >-
                          On its organization; admin there manages people and
                          workspaces
                      readOnly:
                        type: boolean
                        description: >-
                          The organization is read-only: whatever the grants
                          say, the scope is read at most
                      narrowed:
                        type: boolean
                        description: >-
                          No scope on the workspace, but grants on some
                          collections or assets in it
                      email:
                        type: boolean
                        description: >-
                          The organization can send email now: invitations and
                          links go out by mail
                      narrow:
                        type: object
                        properties:
                          collections:
                            type: object
                            propertyNames:
                              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:
                              type: string
                              enum:
                                - read
                                - propose
                                - write
                                - admin
                          assets:
                            type: object
                            propertyNames:
                              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:
                              type: string
                              enum:
                                - read
                                - propose
                                - write
                                - admin
                        required:
                          - collections
                          - assets
                        additionalProperties: false
                        description: >-
                          Grants on single collections and assets here, by id:
                          what reaches past the workspace scope
                      'off':
                        type: object
                        properties:
                          workspace:
                            type: array
                            items:
                              type: string
                              enum:
                                - delete
                                - share
                                - approve
                                - setup
                          collections:
                            type: object
                            propertyNames:
                              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:
                              type: array
                              items:
                                type: string
                                enum:
                                  - delete
                                  - share
                                  - approve
                                  - setup
                          assets:
                            type: object
                            propertyNames:
                              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:
                              type: array
                              items:
                                type: string
                                enum:
                                  - delete
                                  - share
                                  - approve
                                  - setup
                        required:
                          - workspace
                          - collections
                          - assets
                        additionalProperties: false
                        description: >-
                          Abilities your grants have switched off, on the
                          workspace and on single collections and assets
                      hidden:
                        type: array
                        items:
                          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)$
                        description: >-
                          The workspace's private collections: only a grant on
                          one, or admin, reaches it
                      workspaces:
                        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)$
                            slug:
                              type: string
                            name:
                              type: string
                            organization:
                              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
                          required:
                            - id
                            - slug
                            - name
                            - organization
                          additionalProperties: false
                        description: Every workspace you can switch to
                      auth:
                        type: object
                        properties:
                          signUp:
                            type: boolean
                            description: >-
                              Nobody has an account yet: the first one made is
                              the admin of everything
                          open:
                            type: boolean
                            description: >-
                              Anyone may make an account, and gets an
                              organization of their own (SIGNUP=open)
                          oidc:
                            anyOf:
                              - type: object
                                properties:
                                  name:
                                    type: string
                                required:
                                  - name
                                additionalProperties: false
                              - type: 'null'
                            description: Single sign-on, when configured
                          anonymous:
                            anyOf:
                              - type: string
                                enum:
                                  - read
                                  - propose
                                  - write
                                  - admin
                              - type: 'null'
                            description: What a request without a key or a session may do
                          passwordReset:
                            type: boolean
                            description: A forgotten password can be reset by email
                        required:
                          - signUp
                          - open
                          - oidc
                          - anonymous
                          - passwordReset
                        additionalProperties: false
                    required:
                      - user
                      - key
                      - actor
                      - workspace
                      - scope
                      - orgScope
                      - readOnly
                      - narrowed
                      - email
                      - narrow
                      - 'off'
                      - hidden
                      - workspaces
                      - auth
                    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

````