craaft Attachments API

openapi: 3.2.0
info:
  title: Craaft Attachments API
  version: 1.0.0
  description: 'Personal-access-token API for Craaft. See `docs/api.md` for the

    narrative guide, rate limits, and worked examples.'
  contact:
    name: Craaft
servers:
- url: https://craaft.io/api/v1
  description: Production
- url: http://localhost:8080/api/v1
  description: Local
security:
- bearerAuth: []
tags:
- name: Attachments
paths:
  /attachments/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    get:
      summary: Download attachment bytes
      parameters:
      - name: inline
        in: query
        required: false
        schema:
          type: string
          enum:
          - '1'
        description: 'Request inline rendering rather than download. Honoured only for

          playable audio/video content types (audio/webm, audio/ogg,

          audio/mpeg, audio/mp4, audio/wav, video/webm, video/mp4); every

          other type is served as an attachment regardless, so this can

          never be used to render an uploaded document in the app''s origin.

          '
      description: 'Streams the file with its stored `Content-Type` and a

        `Content-Disposition: attachment` header (or `inline` - see the

        `inline` parameter). Returns bare `404` (no JSON body) when the

        attachment or its bytes are missing.'
      responses:
        '200':
          description: File bytes
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          description: Attachment not found or bytes unavailable
      tags:
      - Attachments
      operationId: getAttachmentsById
      x-operation-id-source: derived
    delete:
      summary: Delete an attachment
      description: Removes metadata and storage bytes (best-effort on storage).
      responses:
        '204':
          description: Deleted
        '404':
          $ref: '#/components/responses/NotFound'
      tags:
      - Attachments
      operationId: deleteAttachmentsById
      x-operation-id-source: derived
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
  responses:
    NotFound:
      description: Resource doesn't exist or caller isn't a member of its workspace
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    sessionAuth:
      type: apiKey
      in: cookie
      name: craaft_session
      description: 'Browser session cookie (`__Host-craaft_session` in production,

        `craaft_session` in dev), set at sign-in. Not obtainable through

        this API - it''s here only so the handful of session-only routes

        below (the OAuth consent screen''s own endpoints, connected-apps

        management) can be marked accurately. They reject both bearer

        schemes with a 403.

        '
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cra_<24 base64url chars>
      description: 'Two token schemes, same permissions. `cra_<24 base64url chars>` is a

        personal access token minted in Settings, doesn''t expire on its own,

        and is revoked from the same page. `cro_<32 base64url chars>` is an

        OAuth access token issued to an OAuth client (an MCP client such as

        Claude) via the authorization-code-with-PKCE flow; it expires after

        1 hour and the client refreshes it. Either token authenticates as

        the user who authorized it, with that user''s exact permissions.


        A token can be read-only: a personal access token created with

        access `read`, or an OAuth grant with scope `craaft:read`. A

        read-only token can send GET, HEAD and OPTIONS; any other method

        gets `403` with "this token is read-only; this request needs a

        token with read and write access", before the request is handled.


        A token can also be limited to chosen boards. Other boards then

        behave as if they don''t exist (`404`, or left out of lists), and

        `POST /projects`, `/imports`, `/members` and `/invitations` answer

        `403` with "this token is limited to some boards; this request

        needs a token for all boards".


        OAuth clients discover every endpoint they need - authorization,

        token, dynamic client registration, revocation - at

        `/.well-known/oauth-authorization-server` (RFC 8414); they don''t

        need to be told the URLs out of band.

        '