Inboxy Attachments API

openapi: 3.2.0
info:
  title: inboxy Attachments API
  version: 0.3.0
  summary: Read + manage your inboxy.net inbox programmatically.
  description: 'REST surface over the inboxy alias inbox. Mint aliases, list/search/read

    messages, fetch attachments, manage your API keys, and emit user-initiated

    mail under one of your aliases.


    Mail-emitting paths (`POST /v1/messages/{id}/reply`, `POST /v1/mail/send`,

    `POST /v1/mail/invite`) are recipient-locked and alias-locked server-side:

    the `From:` is always one of the caller''s `@inboxy.net` aliases, the

    recipient is validated against per-user caps and the abuse rules in

    `packages/reply`, and every external message carries the mandatory

    inboxy attribution footer. There is no arbitrary-`From:` send path.


    All endpoints require a bearer API key created from the inboxy.net web UI

    at `/account/keys` (mint is gated by step-up and lives only on the web — there

    is no API-channel mint). Pass it as `Authorization: Bearer ik_…`.


    The signed-token attachment download URLs (`/v1/attachments/{token}/download`,

    `/v1/messages/raw/{token}/download`) are public-by-token — they intentionally

    bypass bearer auth and are not listed here. Obtain them via the JSON

    endpoints below.'
  contact:
    name: inboxy
    url: https://inboxy.net
  license:
    name: Proprietary
servers:
- url: https://api.inboxy.net
  description: Production
security:
- bearerAuth: []
tags:
- name: Attachments
  description: Signed download URLs.
paths:
  /v1/attachments/{id}:
    get:
      tags:
      - Attachments
      summary: Issue a signed download URL for one attachment
      description: 'The returned `url` is publicly fetchable until `expires_at` — the signed token is the auth. Images are served `Content-Disposition: inline` so they render in `` contexts.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Signed URL + metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignedUrl'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: getV1AttachmentsById
      x-operation-id-source: derived
  /v1/outbox-attachments:
    post:
      tags:
      - Attachments
      summary: Upload one attachment for use in a future reply
      description: 'Body is the raw file bytes. Returns an `id` to pass in `ReplyRequest.attachment_ids`. Caps: 20 MB per file; per-user limits on unsent uploads. Use `X-Filename` to set the filename the recipient sees.'
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      parameters:
      - name: X-Filename
        in: header
        schema:
          type: string
          maxLength: 200
        description: Original filename. Sanitised before being placed in the outbound MIME part.
      responses:
        '200':
          description: Upload accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutboxAttachmentUploadResult'
        '400':
          description: Empty body or missing Content-Type.
        '413':
          description: Attachment exceeds the 20 MB cap.
        '429':
          description: Per-user unsent-uploads cap reached.
      operationId: postV1OutboxAttachments
      x-operation-id-source: derived
  /v1/outbox-attachments/{id}:
    delete:
      tags:
      - Attachments
      summary: Release an unsent attachment
      description: Deletes the R2 object and the D1 row. Refused once the sender has consumed the attachment in a sent reply.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Deleted.
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Attachment was already consumed in a sent reply.
      operationId: deleteV1OutboxAttachmentsById
      x-operation-id-source: derived
components:
  schemas:
    OutboxAttachmentUploadResult:
      type: object
      required:
      - id
      - size_bytes
      - content_type
      - expires_at
      properties:
        id:
          type: string
          format: uuid
        size_bytes:
          type: integer
        content_type:
          type: string
        filename:
          type:
          - string
          - 'null'
        expires_at:
          type: integer
          description: Unix seconds after which the upload may be purged if unsent.
    SignedUrl:
      type: object
      required:
      - url
      - expires_at
      properties:
        url:
          type: string
          format: uri
        expires_at:
          type: integer
          description: Unix seconds.
        filename:
          type:
          - string
          - 'null'
        content_type:
          type:
          - string
          - 'null'
        size_bytes:
          type: integer
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - bad_request
          - unauthorized
          - forbidden
          - not_found
          - gone
          - rate_limited
          - internal
          - invalid_token
          - blocked
        message:
          type: string
  responses:
    NotFound:
      description: No matching resource owned by the caller.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ik_…
      description: Static API key. Three scopes — `read` (everything except mutations), `manage` (mutations other than sending) and `send` (`/v1/mail/send`, replies, invites). Mint at https://inboxy.net/account/keys (the web UI gates mint with step-up; there is no API-channel mint).