Immersive Commons Events API

openapi: 3.2.0
info:
  title: Immersive Commons — Agent REST Events 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: Events
  description: Discover and RSVP to events; propose member events.
paths:
  /api/events/upcoming:
    get:
      operationId: listUpcomingEvents
      tags:
      - Events
      summary: List upcoming Immersive Commons events
      description: Public read of the upcoming-events KV cache. Anonymous, or authenticated with a Clerk session or an agt_ token carrying `events:read_upcoming`. Returns the events plus an `age_min` staleness gauge. Use `limit` to cap the page size (there is no cursor — the full upcoming window is small).
      security:
      - {}
      - agentBearer:
        - events:read_upcoming
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
        description: Max events to return.
      responses:
        '200':
          description: Upcoming events.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpcomingEventsResponse'
        '500':
          description: Cache read failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/events/upcoming/route.ts
        method: GET
  /api/events/get:
    get:
      operationId: getEventByLumaUrl
      tags:
      - Events
      summary: Look up a single event by its Luma URL
      description: Public. Resolves one event from the upcoming cache by its canonical Luma URL.
      security:
      - {}
      parameters:
      - name: luma
        in: query
        required: true
        schema:
          type: string
        description: Canonical Luma event URL (https://luma.com/<slug> or https://lu.ma/<slug>).
      responses:
        '200':
          description: The matching event.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventGetResponse'
        '400':
          description: Missing or non-canonical `luma` URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No matching event in the upcoming cache.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/events/get/route.ts
        method: GET
  /api/events/next:
    get:
      operationId: tailAgentEvents
      tags:
      - Events
      summary: Cursor-tail the caller's agentic event log
      description: Clerk-session only (NOT reachable with an agt_ bearer). Cursor-based tail read of the per-user agentic event log. Pass the last-seen `since` id to page forward; the response carries `cursor` + `has_more` for the next page. Headless agents use the MCP verb `ic_events_next` (bearer-auth) instead.
      security:
      - clerkSession: []
      parameters:
      - name: since
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
        description: Numeric cursor = last-seen event id. Omit for the backlog head.
      - name: types
        in: query
        required: false
        schema:
          type: string
        description: Comma-separated AgentEventType filter.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 500
          default: 50
      responses:
        '200':
          description: A page of agent events with a forward cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentEventsNextResponse'
        '401':
          description: Not signed in.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Event log read failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/events/next/route.ts
        method: GET
  /api/events/rsvp:
    post:
      operationId: rsvpToEvent
      x-sandbox: simulated
      tags:
      - Events
      summary: Queue an RSVP to a Luma event
      description: 'Clerk session or agt_ token with `events:rsvp`. Queues an RSVP envelope for life-side processing (returns `queued`, not a confirmed Luma seat). IDEMPOTENT: a repeat within 7 days is recognized (`was_dup: true`) and no second envelope is written; an `Idempotency-Key` additionally replays the first result. Agent callers MUST supply `email` (no session fallback).'
      security:
      - agentBearer:
        - events:rsvp
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          type: string
          maxLength: 255
        description: Optional. A retry carrying the same key replays the first successful result verbatim instead of creating a second side effect (honored by lib/idempotency.ts, 24h window). Complementary to each endpoint's own semantic dedupe. Absent = no replay.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RsvpRequest'
      responses:
        '200':
          description: RSVP queued (or recognized as a duplicate).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueResponse'
        '400':
          description: Bad event_url, missing email on the agent path, or validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing/invalid token or session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Token scope or live tier does not authorize events:rsvp.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: Body exceeds 8KB.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Per-token rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: KV write failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/events/rsvp/route.ts
        method: POST
  /api/events/request:
    post:
      operationId: requestEvent
      x-sandbox: simulated
      tags:
      - Events
      summary: Propose a member event (operator-approved)
      description: Clerk session or agt_ token with `events:request` (ic-member+). Enqueues a Luma-shaped 'save the date' into the pending queue for operator approval — it NEVER auto-creates a public event. Supports an `Idempotency-Key`.
      security:
      - agentBearer:
        - events:request
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          type: string
          maxLength: 255
        description: Optional. A retry carrying the same key replays the first successful result verbatim instead of creating a second side effect (honored by lib/idempotency.ts, 24h window). Complementary to each endpoint's own semantic dedupe. Absent = no replay.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventRequestRequest'
      responses:
        '200':
          description: Request enqueued as pending.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventRequestResponse'
        '400':
          description: Invalid JSON or field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: No auth.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Tier/scope does not authorize events:request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Per-member daily cap reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Queue write failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Rate limiter unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/events/request/route.ts
        method: POST
  /api/events:
    get:
      operationId: listSiteEvents
      tags:
      - Events
      summary: Read upcoming and recent floor events
      description: 'Public, no auth. The site''s own events feed: everything still ahead, plus the last 12 that have passed. Distinct from GET /api/events/upcoming, which serves the agent-facing upcoming cache with a staleness gauge; this one mirrors exactly what the /events page and the kiosk render. An event counts as past three hours after its start time.'
      security:
      - {}
      responses:
        '200':
          description: Upcoming and past events.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsCatalogResponse'
      x-ic-route:
        file: app/api/events/route.ts
        method: GET
components:
  schemas:
    AgentEventsNextResponse:
      type: object
      description: Cursor-paginated page of agentic events.
      required:
      - events
      properties:
        events:
          type: array
          items:
            type: object
            additionalProperties: true
        cursor:
          type: integer
          description: Pass as `since` to fetch the next page.
        has_more:
          type: boolean
          description: True when more events remain past this page.
        as_of:
          type: string
          format: date-time
      additionalProperties: true
    EventSummary:
      type: object
      description: One cached upcoming event. Passthrough of lib/events-ops shape; extra fields may appear.
      additionalProperties: true
      properties:
        luma_url:
          type: string
        title:
          type: string
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        location:
          type: string
        cover_url:
          type: string
    EventRequestResponse:
      type: object
      required:
      - ok
      - id
      - status
      properties:
        ok:
          type: boolean
        id:
          type: string
        status:
          type: string
          enum:
          - pending
        via:
          type: string
          enum:
          - clerk
          - agent
    EventRequestRequest:
      type: object
      required:
      - title
      - start
      description: Luma-shaped event proposal (EventRequestDetails).
      properties:
        title:
          type: string
        start:
          type: string
          format: date-time
          description: Future ISO-8601 start.
        end:
          type: string
          format: date-time
        location:
          type: string
        description:
          type: string
        cover_url:
          type: string
        capacity:
          type: integer
        visibility:
          type: string
          enum:
          - public
          - members
        host:
          type: string
        contact:
          type: string
        slideshow_url:
          type: string
    EventsCatalogResponse:
      type: object
      required:
      - count
      - upcoming
      - past
      properties:
        count:
          type: integer
          description: Upcoming events only.
        upcoming:
          type: array
          items:
            type: object
            additionalProperties: true
          description: Soonest first.
        past:
          type: array
          items:
            type: object
            additionalProperties: true
          description: The last 12, newest first. An event counts as past three hours after its start.
        generated_at:
          type: string
          format: date-time
    RateInfo:
      type: object
      description: Per-token rate-limit snapshot returned by write endpoints.
      properties:
        current:
          type: integer
        remaining:
          type: integer
        limit:
          type: integer
    EventGetResponse:
      type: object
      required:
      - ok
      - event
      properties:
        ok:
          type: boolean
        event:
          $ref: '#/components/schemas/EventSummary'
    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).
    UpcomingEventsResponse:
      type: object
      required:
      - ok
      properties:
        ok:
          type: boolean
        events:
          type: array
          items:
            $ref: '#/components/schemas/EventSummary'
        count:
          type: integer
        age_min:
          type: number
          description: Minutes since the cache was last refreshed.
      additionalProperties: true
    RsvpRequest:
      type: object
      required:
      - event_url
      properties:
        event_url:
          type: string
          description: https://luma.com/<slug>
        email:
          type: string
          description: Required for agent callers (no session fallback); optional on the Clerk path.
        name:
          type: string
    QueueResponse:
      type: object
      description: Shared shape for the queue-and-forget writes (rsvp, book).
      required:
      - ok
      - queued
      properties:
        ok:
          type: boolean
        queued:
          type: boolean
        was_dup:
          type: boolean
          description: True when semantic dedupe recognized this as a repeat within the window.
        rate:
          $ref: '#/components/schemas/RateInfo'
        via:
          type: string
          enum:
          - clerk
          - agent
        note:
          type: string
  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