WorldForge Studio

Docs / API reference

API reference

One page per route group — every mount the server exposes, with auth and scope notes. A CI drift test fails when a route has no page here.

  1. 00

    00 — Authentication & API keys

    Session exchange (/auth) and scoped API-key management (/api-keys).

  2. 01

    01 — Health, settings & ops

    Liveness probes, user settings, the AI pixel analyzer, and test-only audit fixtures.

  3. 02

    02 — Worlds

    World CRUD, the world document and its overlays, branches/versions, and world-level operations.

  4. 03

    03 — Collaboration & realtime

    Memberships, the activity feed, the SSE live view, presence, and realm tickets for the Yjs WebSocket.

  5. 04

    04 — Atlas & regions

    The map graph (/atlas: nodes, edges, layers, visibility) and fog-of-war regions (/worlds/:id/regions).

  6. 05

    05 — Wiki & notes

    The world wiki (shared markdown pages) and private per-user notes.

  7. 06

    06 — Packs & assets

    Pack Studio CRUD, asset blobs, import/export, and the asset library.

  8. 07

    07 — Proposals & auto-accept

    The agent-proposal review queue: inbox, commit/reject, changesets, and auto-accept policies.

  9. 08

    08 — Print

    PDF compilation, artifacts, the print-shop directory, orders, reviews, and claim/verify.

  10. 09

    09 — Gameplay

    Campaigns, quests, encounters and their play sessions, plus in-world gameplay routes (dialogue, inventory, spawns, items, POIs, renown).

  11. 10

    10 — AI Studio

    The /api/ai chat surface: sessions, streaming responses, and conversation history.

  12. 11

    11 — MCP

    The Model Context Protocol endpoint — stateless streamable HTTP at /mcp.

  13. 12

    12 — Play (AI-DM playthroughs and characters)

    Characters, and playthroughs: a table that plays through a world's story as an append-only event log (ADR-0010). Identity and permissions are ADR-0011; what a response may contain is