Immersive Commons Prints API

openapi: 3.2.0
info:
  title: Immersive Commons — Agent REST Prints API
  version: '2026-09-15'
  summary: The REST surface an AI agent uses to act at Immersive Commons.
  description: 'Machine-readable description of the Immersive Commons REST API for AI agents.


    **Authentication.** Most operations take a Bearer agent token (`Authorization: Bearer agt_...`). Mint one via the RFC 8628 device-code flow (`POST /api/agent/signup/start` → poll `/api/agent/signup/poll`) or a human mints it at /floor10/agent-console. Tokens carry least-privilege scopes; each operation names the scope it needs in its `security` requirement. Public reads allow anonymous access (empty security requirement). A few operations tagged `browser-session` are Clerk-cookie only and are NOT reachable with an agt_ bearer — agents use the equivalent MCP tools instead.


    **Error model.** Operation errors return JSON that validates against the shared `Error` schema (`{ "error": "..." }`, optionally `ok:false`/`error_kind`/`rate`/`retry_after_seconds`). Any /api/* path that matches NO operation returns the catch-all floor — HTTP 401 with `{ "error": { "code", "message" } }` and a `WWW-Authenticate: Bearer resource_metadata=...` header pointing at /.well-known/oauth-protected-resource.


    **Idempotency.** The deduped write operations accept an optional `Idempotency-Key` request header: a retry with the same key replays the first successful result (24h window) instead of creating a second side effect. This layers on top of each endpoint''s own semantic dedupe (e.g. RSVP''s 7-day window).


    **Versioning & deprecation policy.** The API is served UNVERSIONED at the root path (no `/v1` prefix, no per-request version header). The dated `info.version` (CalVer) is the change marker to pin against. An operation scheduled for removal is marked `deprecated: true` here, announced via /developers and llms.txt, and kept at least one release. Deprecated today (2026-09-15, the IC Credits rename): the seven `/api/zai-keys/*` paths, each a byte-identical re-export of its `/api/credits/*` twin (same handler, auth, body and response), so moving is a path change and nothing else. Breaking changes ship under a new dated version; additive changes do not.


    **Rate limits.** Agent tokens are limited per-token per endpoint family (e.g. 3 highlight submissions/day, 60 research queries/hour). 429 responses carry a `Retry-After` header. Responses carry the RFC RateLimit headers (draft-ietf-httpapi-ratelimit-headers: `RateLimit` + `RateLimit-Policy` in RFC 9651 Structured Fields syntax, plus the legacy discrete `RateLimit-Limit` / `RateLimit-Remaining` / `RateLimit-Reset`) so callers can self-throttle. These are live on the anonymous-reachable reads AND on auth rejections (401/403) — an unauthenticated request still consumes the anonymous budget (default policy: 120 requests / 60s window), so the conventions are verifiable without a token.'
  contact:
    name: Immersive Commons
    email: admin@immersivecommons.com
    url: https://www.immersivecommons.com/developers
  license:
    name: Proprietary
    url: https://www.immersivecommons.com/privacy
servers:
- url: https://www.immersivecommons.com
  description: Production
- url: https://www.immersivecommons.com
  description: Sandbox (test mode) — same base URL; mint a sandbox token via `sandbox:true` on /api/agent/signup/start. Writes return simulated receipts, reads serve real data.
  x-sandbox: token-flag
security:
- {}
tags:
- name: prints
  description: The Floor 10 3D-print farm queue.
paths:
  /api/prints/list:
    get:
      operationId: listPrintRequests
      tags:
      - prints
      summary: List the caller's print requests
      description: Clerk session or agt_ token with `prints:read` (ft-member+). Newest first. Farm managers (operator tier or the farm-crew allowlist) may pass `queue=1` for the whole farm queue — open requests only unless `include_closed=1`. The response always carries `is_manager`.
      security:
      - agentBearer:
        - prints:read
      parameters:
      - name: queue
        in: query
        required: false
        schema:
          type: string
          enum:
          - '1'
        description: 'Manager-only: return the farm queue instead of the caller''s own requests.'
      - name: include_closed
        in: query
        required: false
        schema:
          type: string
          enum:
          - '1'
        description: With queue=1, also include finished/rejected requests.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
      responses:
        '200':
          description: Print requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintsListResponse'
        '401':
          description: No auth.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Scope/tier not authorized, or queue=1 from a non-manager.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Read failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/prints/list/route.ts
        method: GET
  /api/prints/request:
    post:
      operationId: submitPrintRequest
      x-sandbox: simulated
      tags:
      - prints
      summary: File a 3D-print request with the Floor 10 farm
      description: 'Clerk session or agt_ token with `prints:submit` (live tier re-checked, ft-member+). Supply the model exactly one way: an existing vault `file_id`, inline `content_base64` + `filename`, or a `link_url`. The browser form posts the same fields as `multipart/form-data` with a `file` part (that variant is not described by this schema). `open_ahead` is how many open requests are queued in front of this one.'
      security:
      - agentBearer:
        - prints:submit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrintSubmitRequest'
      responses:
        '200':
          description: Request filed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintSubmitResponse'
        '400':
          description: Unreadable body, missing title, or not exactly one model source.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: No auth.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Scope/tier not authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: Model file too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Per-member rate limit or open-request quota reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Write failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/prints/request/route.ts
        method: POST
  /api/prints/{id}:
    get:
      operationId: getPrintRequest
      tags:
      - prints
      summary: Read one print request and its full history
      description: Clerk session or agt_ token with `prints:read` (ft-member+). Readable by the submitter or a farm manager — anyone else gets 403 even though the request exists.
      security:
      - agentBearer:
        - prints:read
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Print-request id.
      responses:
        '200':
          description: The request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintRequestResponse'
        '401':
          description: No auth.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Neither the submitter nor a farm manager.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/prints/[id]/route.ts
        method: GET
    patch:
      operationId: updatePrintRequestStatus
      x-sandbox: simulated
      tags:
      - prints
      summary: Advance a print request through the farm lifecycle
      description: Clerk session or agt_ token with `prints:manage` (live tier re-checked, ic-member+) PLUS farm-manager identity — operator tier or the farm-crew allowlist. The scope alone NEVER authorizes a queue write. The requester is notified of the move. A submitter cancelling their own request uses POST /api/prints/{id}/cancel instead.
      security:
      - agentBearer:
        - prints:manage
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Print-request id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrintStatusPatchRequest'
      responses:
        '200':
          description: The moved request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintRequestResponse'
        '400':
          description: Invalid JSON, unknown target status, or an illegal transition from the current state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: No auth.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Scope/tier not authorized, or the caller is not farm crew.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/prints/[id]/route.ts
        method: PATCH
  /api/prints/{id}/cancel:
    post:
      operationId: cancelPrintRequest
      x-sandbox: simulated
      tags:
      - prints
      summary: Cancel your own print request
      description: Clerk session or agt_ token with `prints:submit` (ft-member+). SUBMITTER ONLY, and only while the request is still pending or accepted — once it is printing the transition is refused (400) and you talk to the farm. The managers are notified. An empty body is fine.
      security:
      - agentBearer:
        - prints:submit
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Print-request id.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrintCancelRequest'
      responses:
        '200':
          description: The cancelled request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintRequestResponse'
        '400':
          description: Cancel is not a legal move from the current status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: No auth.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Not the submitter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/prints/[id]/cancel/route.ts
        method: POST
components:
  schemas:
    PrintStatusPatchRequest:
      type: object
      required:
      - status
      properties:
        status:
          type: string
          enum:
          - accepted
          - printing
          - ready
          - collected
          - rejected
          description: The target state. The transition table refuses moves that are illegal from the current status.
        note:
          type: string
          description: Shown to the requester in the notification and kept on the history entry.
    PrintRequestPublic:
      type: object
      description: A print request with the submitting token's sha256 stripped (lib/prints.ts::redactRequest). `history` is the full audit trail of moves.
      required:
      - id
      - status
      - title
      - submitted_by
      - created_at
      - updated_at
      - history
      additionalProperties: true
      properties:
        id:
          type: string
          description: pj_*
        status:
          type: string
          enum:
          - pending
          - accepted
          - printing
          - ready
          - collected
          - rejected
          - canceled
        title:
          type: string
        details:
          type: string
        material:
          type: string
        color:
          type: string
        quantity:
          type: integer
        file:
          type:
          - object
          - 'null'
          additionalProperties: true
          description: Vault file holding the model, or null for a link-only ask.
        link_url:
          type:
          - string
          - 'null'
          description: Hosted-model URL, or null.
        submitted_by:
          type: string
          description: Clerk user id.
        submitted_by_name:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        history:
          type: array
          items:
            type: object
            additionalProperties: true
        slice_status:
          type: string
          description: Auto-slice outcome. Absent means slicing was never attempted.
    PrintsListResponse:
      type: object
      required:
      - ok
      - count
      - requests
      - is_manager
      properties:
        ok:
          type: boolean
        count:
          type: integer
        requests:
          type: array
          items:
            $ref: '#/components/schemas/PrintRequestPublic'
        is_manager:
          type: boolean
          description: True iff the caller may drive the farm queue (operator or farm crew).
    PrintSubmitRequest:
      type: object
      required:
      - title
      description: 'The JSON variant. Name the model EXACTLY ONE way: `file_id` (an existing vault file), `filename` + `content_base64` (inline bytes), or `link_url`.'
      properties:
        title:
          type: string
        details:
          type: string
          description: What it's for, dimensions, tolerances, infill wishes…
        material:
          type: string
        color:
          type: string
        quantity:
          type: integer
        file_id:
          type: string
          description: An existing vault file id.
        filename:
          type: string
          description: With content_base64.
        content_base64:
          type: string
          description: The model bytes, base64-encoded.
        content_type:
          type: string
        link_url:
          type: string
          description: https link to a hosted model.
    PrintRequestResponse:
      type: object
      required:
      - ok
      - request
      properties:
        ok:
          type: boolean
        request:
          $ref: '#/components/schemas/PrintRequestPublic'
    PrintSubmitResponse:
      type: object
      required:
      - ok
      - id
      - status
      properties:
        ok:
          type: boolean
        id:
          type: string
          description: pj_* — use it with /api/prints/{id}.
        status:
          type: string
          description: Always the opening state for a new request.
        open_ahead:
          type: integer
          description: How many open requests are queued in front of this one.
        file_id:
          type: string
          description: Present when the model was stored in the vault as part of this call.
        via:
          type: string
          enum:
          - clerk
          - agent
    Error:
      type: object
      required:
      - error
      additionalProperties: true
      description: Structured JSON error. `error` (string) is always present — an error code or a human-readable message. `ok:false` is present on bearer auth-gate rejections. Endpoints may attach additional context keys to aid recovery (tier, current_tier, limit, window_seconds, valid_kinds, recovery_hint, detail, example, ...); the reusable ones are named below.
      properties:
        error:
          type: string
          description: Error code or human-readable message (always present).
        ok:
          type: boolean
          enum:
          - false
          description: Present (false) on auth-gate rejections.
        error_kind:
          type: string
          description: Machine-readable failure class (rate_limit, validation, not_found, ...).
        message:
          type: string
          description: Longer human-readable detail (feedback + some rate-limit errors).
        rate:
          $ref: '#/components/schemas/RateInfo'
        retry_after_seconds:
          type: integer
          description: Seconds to wait before retrying (on 429).
        tier:
          type: string
          description: The caller's current tier — present on a tier/scope authorization (403) rejection.
        current_tier:
          type: string
          description: The caller's current tier — present on a tier/request validation (400) rejection.
        detail:
          type: string
          description: Extra failure detail — present on some 500 responses (e.g. the agent event-log read).
    PrintCancelRequest:
      type: object
      description: Optional — an empty body is accepted.
      properties:
        note:
          type: string
          description: Why you're cancelling; kept on the history entry.
    RateInfo:
      type: object
      description: Per-token rate-limit snapshot returned by write endpoints.
      properties:
        current:
          type: integer
        remaining:
          type: integer
        limit:
          type: integer
  securitySchemes:
    agentBearer:
      type: http
      scheme: bearer
      bearerFormat: agt_<base64url>
      description: 'Per-member, individually-revocable agent token minted via the device-code flow. Send as `Authorization: Bearer agt_...`. The scope array in each operation''s security requirement names the IC scope the handler enforces.'
    clerkSession:
      type: apiKey
      in: cookie
      name: __session
      description: Browser Clerk session cookie. Operations under this scheme are reachable ONLY from a signed-in browser session, NOT with an agt_ bearer token. Agents use the equivalent MCP tools (e.g. ic_get_my_membership, ic_request_tier).
    workshopCode:
      type: http
      scheme: bearer
      bearerFormat: 6-char enrollment code
      description: 'The workshop''s own enrollment code, minted by POST /api/workshop/enroll and presented as a bearer. It is NOT an agt_ token: it carries no scopes, is not revocable per-token, and reaches only the /api/workshop/* routes.'
    sliceServiceSecret:
      type: http
      scheme: bearer
      bearerFormat: shared secret
      description: SLICE_SERVICE_SECRET — the machine-to-machine bearer the print-slicing service presents. A distinct trust boundary (an external machine on the tailnet), which is why it has its own secret rather than reusing the cron one. No member holds it and no member-facing flow can reach these routes.
    floorcastOnboarding:
      type: http
      scheme: bearer
      bearerFormat: fco_<...>
      description: 'A single-use Floorcast onboarding token. It exists because tenant provisioning has a chicken-and-egg problem: no operator exists yet for a floor that does not exist yet, so neither a Clerk session nor an agt_ token can authorize the call. Minting one is a concierge step with no live route, and the token is consumed by the provision it authorizes.'
x-payment-info:
  protocol: x402
  discovery: https://www.immersivecommons.com/discovery/resources
  donor_wall: https://www.immersivecommons.com/api/floor10/donations
  note: Payable resources are advertised at /discovery/resources; a bare request to a payable resource returns HTTP 402 with the PAYMENT-REQUIRED challenge.
x-api-lifecycle:
  versioning: unversioned-root (info.version is a dated CalVer change marker)
  deprecation: 'deprecated operations are flagged `deprecated: true` here and kept at least one release; the /api/zai-keys/* aliases (2026-09-15) are the current set'
x-sandbox:
  summary: 'A sandbox token (mint by adding "sandbox": true to POST /api/agent/signup/start) is a real token with real scopes whose WRITE operations return a simulated receipt instead of mutating; reads serve real data. Same base URL + bearer auth. Immutable after mint.'
  obtain:
    endpoint: POST /api/agent/signup/start
    body:
      sandbox: true
  write_response_shape:
    ok: true
    sandbox: true
    simulated: true
    would_have:
      action: string
      scope: string
      args: object
    note: string — scope was checked; deeper business rules (tier/role/ownership/signature) are NOT evaluated in sandbox, and no production state changed. A green receipt means well-formed + scoped, NOT guaranteed to pass in production.
  real_exceptions:
  - POST /api/agent/feedback (bug-report channel must be heard)
  - POST /api/agent/token/revoke (token lifecycle; genuinely revokes)
  not_sandbox_eligible:
  - ic_donate (x402 payment rail — never faked; not a REST operation in this spec)
  - floor-admin toggles + tools with no concrete scope to check — denied fail-closed, never silently simulated