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

# Invite someone

> A grant waiting for whoever holds the link: they make an account or sign in, and have it. The `url` is in this response only. It works once, for seven days. Same rules as giving a grant.

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



## OpenAPI

````yaml /openapi.json post /api/v1/invitations
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/invitations:
    post:
      summary: Invite someone
      description: >-
        A grant waiting for whoever holds the link: they make an account or sign
        in, and have it. The `url` is in this response only. It works once, for
        seven days. Same rules as giving a grant.


        Any caller; the scope needed is checked on what it acts on.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  maxLength: 320
                  format: email
                  pattern: >-
                    ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
                resource:
                  type: string
                  enum:
                    - organization
                    - workspace
                    - collection
                    - asset
                  description: What the grant is on; it reaches everything inside it
                resourceId:
                  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 organization's, workspace's, collection's or asset's id
                scope:
                  type: string
                  enum:
                    - read
                    - propose
                    - write
                    - admin
                limits:
                  description: >-
                    What the scope would allow but this grant doesn't: delete,
                    share (links and upload requests), approve (review), setup
                    (fields and brand)
                  maxItems: 4
                  type: array
                  items:
                    type: string
                    enum:
                      - delete
                      - share
                      - approve
                      - setup
              required:
                - email
                - resource
                - resourceId
                - scope
              additionalProperties: false
      responses:
        '201':
          description: The invitation, with its link
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    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)$
                      email:
                        type: string
                      resource:
                        type: string
                        enum:
                          - organization
                          - workspace
                          - collection
                          - asset
                      resourceId:
                        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)$
                      label:
                        type:
                          - string
                          - 'null'
                      scope:
                        type: string
                        enum:
                          - read
                          - propose
                          - write
                          - admin
                      limits:
                        type: array
                        items:
                          type: string
                          enum:
                            - delete
                            - share
                            - approve
                            - setup
                      invitedBy:
                        type: string
                      expiresAt:
                        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)))$
                      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)))$
                      url:
                        type: string
                        format: uri
                        description: >-
                          Emailed to them when the organization can send email;
                          send it yourself otherwise
                      emailed:
                        type: boolean
                    required:
                      - id
                      - email
                      - resource
                      - resourceId
                      - label
                      - scope
                      - limits
                      - invitedBy
                      - expiresAt
                      - createdAt
                      - url
                      - emailed
                    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

````