Immersive Commons Leaderboard API

openapi: 3.2.0
info:
  title: Immersive Commons — Agent REST Leaderboard 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: Leaderboard
  description: The public commit leaderboard.
paths:
  /api/leaderboard/me:
    get:
      operationId: getMyLeaderboardStatus
      tags:
      - Leaderboard
      summary: Read the caller's commit-leaderboard state
      description: Clerk session or agt_ token with `leaderboard:manage`. Returns opt-in flag, linked GitHub username, and current weekly rank if rendered.
      security:
      - agentBearer:
        - leaderboard:manage
      responses:
        '200':
          description: Leaderboard state for the caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeaderboardMeResponse'
        '401':
          description: No auth.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Scope not authorized.
          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/leaderboard/me/route.ts
        method: GET
  /api/leaderboard/optin:
    post:
      operationId: setLeaderboardOptIn
      x-sandbox: simulated
      tags:
      - Leaderboard
      summary: Toggle commit-leaderboard opt-in
      description: Clerk session or agt_ token with `leaderboard:manage`. Opting IN requires a linked GitHub identity (409 otherwise). Opting OUT is unconditional.
      security:
      - agentBearer:
        - leaderboard:manage
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeaderboardOptInRequest'
      responses:
        '200':
          description: New opt-in state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeaderboardOptInResponse'
        '400':
          description: Bad body.
          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'
        '409':
          description: Opt-in requested but no GitHub link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Clerk update failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/leaderboard/optin/route.ts
        method: POST
  /api/leaderboard/connect-github:
    post:
      operationId: connectGitHubIdentity
      x-sandbox: simulated
      tags:
      - Leaderboard
      summary: Link a GitHub identity with a personal access token
      description: Clerk session or agt_ token with `github:link` (live tier re-checked). The PAT is verified against GitHub /user and then DISCARDED — only the resulting identity is stored, and the weekly leaderboard cron counts public commits with its own server-side token. Linking is the precondition for opting in at POST /api/leaderboard/optin.
      security:
      - agentBearer:
        - github:link
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectGitHubRequest'
      responses:
        '200':
          description: Identity linked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectGitHubResponse'
        '400':
          description: Invalid JSON or missing pat.
          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'
        '422':
          description: GitHub rejected the PAT.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Clerk update failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: GitHub was unreachable or returned a 5xx.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/leaderboard/connect-github/route.ts
        method: POST
  /api/user-settings:
    post:
      operationId: setMyUserSettings
      tags:
      - Leaderboard
      summary: Toggle the caller's own leaderboard opt-in
      description: Clerk-session only (NOT reachable with an agt_ bearer). There is no admin check because each member owns their own metadata — the caller can only ever write their own. The write MERGES into existing publicMetadata rather than replacing it. Agents set the same flag through POST /api/leaderboard/optin.
      security:
      - clerkSession: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserSettingsRequest'
      responses:
        '200':
          description: The stored setting.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSettingsResponse'
        '400':
          description: Invalid JSON, or leaderboardOptIn was not a boolean.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Not signed in.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Clerk update failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ic-route:
        file: app/api/user-settings/route.ts
        method: POST
components:
  schemas:
    ConnectGitHubRequest:
      type: object
      required:
      - pat
      properties:
        pat:
          type: string
          description: A GitHub personal access token. Verified once against /user, then DISCARDED — it is never stored, logged, or echoed.
    LeaderboardOptInRequest:
      type: object
      required:
      - optIn
      properties:
        optIn:
          type: boolean
    LeaderboardOptInResponse:
      type: object
      required:
      - ok
      - optIn
      properties:
        ok:
          type: boolean
        optIn:
          type: boolean
        github_username:
          type: string
        via:
          type: string
          enum:
          - clerk
          - agent
    RateInfo:
      type: object
      description: Per-token rate-limit snapshot returned by write endpoints.
      properties:
        current:
          type: integer
        remaining:
          type: integer
        limit:
          type: integer
    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).
    ConnectGitHubResponse:
      type: object
      required:
      - ok
      - github
      properties:
        ok:
          type: boolean
        github:
          type: object
          required:
          - login
          - id
          additionalProperties: true
          description: The identity that was stored. This, not the PAT, is what persists.
          properties:
            login:
              type: string
            id:
              type: integer
            name:
              type: string
            avatarUrl:
              type: string
        via:
          type: string
          enum:
          - clerk
          - agent
    UserSettingsRequest:
      type: object
      required:
      - leaderboardOptIn
      properties:
        leaderboardOptIn:
          type: boolean
          description: Must be a real boolean — a string 'true' is a 400.
    LeaderboardMeResponse:
      type: object
      required:
      - ok
      properties:
        ok:
          type: boolean
        optIn:
          type: boolean
        github_username:
          type: string
        github_link_source:
          type: string
          enum:
          - oauth
          - agent_pat
        github_verified_at:
          type: string
          format: date-time
        this_week:
          type: object
          properties:
            count:
              type: integer
            rank:
              type: integer
            total:
              type: integer
            generated_at:
              type: string
              format: date-time
      additionalProperties: true
    UserSettingsResponse:
      type: object
      required:
      - ok
      - leaderboardOptIn
      properties:
        ok:
          type: boolean
        leaderboardOptIn:
          type: boolean
          description: The value now stored on the caller's publicMetadata.
  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