{ "openapi": "3.1.0", "info": { "title": "world.page testing API", "version": "0.24.0", "description": "Verified email/password accounts and Google OIDC sign-in, server sessions, typed Community/Studio Worlds, channel grants, framed Protobuf chat and animation workflows on Workers Free + D1 Free. The test deployment opens directly to first-party login/registration; private resources require a world.page session. Browser mutations require exact Origin. IDs are opaque decimal strings. Private raster-image uploads use R2 with server-side authorization and quotas. Test memberships and Studio-owner-sponsored collaborative writes are server-enforced. First-party y2kanimator identity uses a fixed-callback S256 handoff and revocable native sessions. Native tokens only access native identity endpoints, not browser or project APIs. Payments, general third-party OAuth, native project sync, production-capacity guarantees and native media editing remain unimplemented." }, "servers": [ { "url": "https://world.page" } ], "components": { "securitySchemes": { "worldNative": { "type": "http", "scheme": "bearer", "description": "First-party native identity session only. Seven-day expiry, revocable through browser Sessions or native revoke. Not accepted by browser/project endpoints." }, "worldSession": { "type": "apiKey", "in": "cookie", "name": "__Host-world-session", "description": "Secure, HttpOnly, SameSite=Strict opaque session. The database stores only its SHA-256 hash. Mutations also require the session CSRF token." } } }, "paths": { "/api/v1/communities/{studioId}/studio-projects/{projectId}/native-imports": { "get": { "operationId": "listNativeProjectImports", "description": "Published immutable native project snapshots only, newest insertion first, 48 per page. Project membership required; unfinished transfers are never listed.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "before", "in": "query", "schema": { "type": "string" } } ] }, "post": { "operationId": "prepareNativeProjectImport", "description": "Explicit native Animation/Storyboard transfer. Requires a normal web session, exact Origin, CSRF and project artist/manager authority. The UUID Idempotency-Key is bound to this account, destination and exact manifest bytes. A schema-version-2 protobuf manifest describes original files and every dependency; no local synchronization or existing-document replacement occurs. Current caps: 2 MiB manifest, 4096 assets, 8 GiB/asset, 16 GiB/transfer and per-project admitted bytes, 4 pending uploads/account, 200 retained snapshots/project. Pending transfers expire in seven days.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Existing completed or closed transfer.", "content": { "application/json": { "schema": { "type": "object" } } } }, "201": { "description": "Prepared or resumed transfer, 4 MiB upload chunks and 256 KiB verification steps.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/x-protobuf": { "schema": { "type": "string", "format": "binary" } } } } } }, "/api/v1/communities/{studioId}/studio-projects/{projectId}/native-imports/{importId}": { "get": { "operationId": "nativeProjectImportStatus", "description": "Transfer status and up to 64 started assets. Pending transfers are private to their creator. Use after digest cursor for remaining progress; omitted manifest assets have not started.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "after", "in": "query", "schema": { "type": "string" } } ] }, "delete": { "operationId": "cancelNativeProjectImport", "description": "Cancel only the creator’s unpublished transfer. Published originals are immutable and cannot be cancelled. Private staged objects/checksum state are removed by bounded maintenance, with repeat sweeps for late writes; idempotency tombstones remain.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/communities/{studioId}/studio-projects/{projectId}/native-imports/{importId}/files": { "get": { "operationId": "nativeProjectOriginalFiles", "description": "Completed snapshots only. Lists up to 48 dependency references with original relative paths and byte lengths. Optional after cursor; no source bytes. Current project membership required.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/api/v1/communities/{studioId}/studio-projects/{projectId}/native-imports/{importId}/assets/{digest}/source": { "get": { "operationId": "nativeProjectOriginalSource", "description": "Completed verified original, streamed one storage chunk at a time with access rechecks. One byte range supported; each response is at most 32 MiB to bound Worker subrequests. Larger clients use bounded ranges or the native chunk API. Optional name must be an original filename for this asset in the verified manifest. No public URL or browser blob buffering.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Private original bytes." }, "206": { "description": "Private single byte range." }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "416": { "description": "Invalid range." }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "digest", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Range", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/api/v1/communities/{studioId}/studio-projects/{projectId}/native-imports/{importId}/manifest": { "get": { "operationId": "nativeProjectImportManifest", "description": "Original verified protobuf metadata. Completed files require current project membership; pending files require creator access. Download bytes never grant authority or imply codec support.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Original manifest.", "content": { "application/x-protobuf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/communities/{studioId}/studio-projects/{projectId}/native-imports/{importId}/assets/{digest}/chunks/{index}": { "put": { "operationId": "uploadNativeProjectChunk", "description": "Upload the next ordered 4 MiB chunk (short final chunk allowed). Length and SHA-256 must match the admitted manifest. Identical retries are safe; gaps and changed bytes fail. R2 is written before the conditional progress commit, which rechecks current permissions.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "digest", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "get": { "operationId": "downloadNativeProjectChunk", "description": "Bounded original bytes. Revalidates current project access; pending data is creator-only. Reconstruct and validate originals/dependencies with their native codec before editing.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Original asset chunk.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "digest", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "index", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/communities/{studioId}/studio-projects/{projectId}/native-imports/{importId}/assets/{digest}/verify": { "post": { "operationId": "verifyNativeProjectAsset", "description": "Advance server-owned whole-file SHA-256 by at most 256 KiB from stored bytes. Persisted private state and compare-and-swap make restart and concurrent retry safe. Clients repeat until verified; progress never exposes internal hash state. This bounds each verification call rather than hashing an entire movie in one request.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "digest", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/communities/{studioId}/studio-projects/{projectId}/native-imports/{importId}/commit": { "post": { "operationId": "commitNativeProjectImport", "description": "Publish one immutable snapshot only after every source/dependency passes its complete SHA-256. One conditional database write rechecks current account, membership and sponsorship. Replay returns the same import; no document is exposed before this point. Published snapshots appear in the Studio catalogue, directory references and immutable medium resolver. Original-file exports preserve source bytes; native whole-project install/Open and the WebGPU editor remain separate work.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ] } }, "/connect/y2kanimator": { "get": { "operationId": "authorizeNativeIdentity", "description": "Browser account confirmation for y2kanimator only. Fixed redirect page.world.y2kanimator:/signin; client_id=y2kanimator; S256 code_challenge and random state required. Unauthenticated users continue through existing web login. POST requires matching Origin and form CSRF, then returns a 90-second one-use authorization code.", "parameters": [ { "name": "client_id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "redirect_uri", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "code_challenge_method", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "code_challenge", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "HTML account confirmation." }, "303": { "description": "Web login or app callback." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/native/token": { "post": { "operationId": "exchangeNativeIdentity", "security": [], "description": "Form-encoded client_id, redirect_uri, code and code_verifier. Atomic one-use S256 exchange, source browser session must remain active. No Cookie, Origin or Sec-Fetch-Site. Returns application/x-plist token and expiresAt; never a browser cookie.", "responses": { "200": { "description": "Property-list native credential." }, "400": { "description": "Expired, invalid or reused grant." }, "403": { "description": "Browser request denied." }, "429": { "description": "Rate limited." } } } }, "/api/v1/native/account": { "get": { "operationId": "readNativeIdentity", "security": [ { "worldNative": [] } ], "description": "application/x-plist: id (opaque decimal public ID), username, displayName, expiresAt. No email, private account UUID or project data. No Cookie or Origin.", "responses": { "200": { "description": "Own public identity." }, "401": { "description": "Expired or revoked session." } } } }, "/api/v1/native/revoke": { "post": { "operationId": "revokeNativeIdentity", "security": [ { "worldNative": [] } ], "description": "Revoke only this native session. No Cookie or Origin. Existing browser logout-all/password reset/session revocation also invalidate native credentials.", "responses": { "200": { "description": "application/x-plist status=signed_out." }, "401": { "description": "Session already invalid." } } } }, "/api/v1/client-issues": { "post": { "operationId": "submitClientIssue", "description": "All active accounts can explicitly submit an issue description and optional sanitized client performance recording. Requires exact Origin, CSRF and an idempotency key. Description up to 4000 characters; body up to 512 KiB; server retains only approved diagnostic fields up to 256 KiB. Ten submissions per account per day, bounded global inbox. User-started performance recordings upload automatically on stop using the same authenticated endpoint and an immutable retry key.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Idempotent repeat: {id}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "201": { "description": "Created report: {id}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 4000 }, "recording": { "type": [ "object", "null" ] } }, "required": [ "description" ] } } } } } }, "/api/v1/admin/client-issues": { "get": { "operationId": "listClientIssues", "description": "Site administrators only. Newest first, 50 reports per page; use before cursor. Excludes recording bodies.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "before", "in": "query", "schema": { "type": "integer" } } ] } }, "/api/v1/admin/client-issues/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "readClientIssue", "description": "Site administrators only. Description and optional sanitized diagnostic recording.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "patch": { "operationId": "updateClientIssue", "description": "Site administrators only. Mark a report open or resolved.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "enum": [ "open", "resolved" ] } }, "required": [ "status" ] } } } } } }, "/api/v1/me/activity/snapshot": { "get": { "operationId": "readChatActivity", "description": "Initial or explicitly refreshed activity snapshot, limited to six per account per minute. Up to 200 visible channel cursors and 50 unread mentions/replies. Channel unread is a 0/1 activity flag, not a message count. Rechecks current channel visibility; the retired /me/activity returns 410 without database access.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/channels/{channelId}/read": { "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "markChannelRead", "description": "Monotonic read position bounded by the channel last message number. Current visibility required.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "number": { "type": "integer", "minimum": 0 } }, "required": [ "number" ] } } } } } }, "/api/v1/channels/{channelId}/toys": { "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "createChatToy", "description": "Trusted two-player Shared puck or Standoff invitation. Ten seconds for an open invitation; optional target principal ID reserves a 15-second challenge. One active toy per channel, two-minute maximum session. Current posting rights and a 16–128-character idempotency key required. Returns 201 on creation, 200 on repeat, 409 while another toy is active. This bounded JSON prototype is not a generic medium-code runtime.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "enum": [ "puck", "standoff" ] }, "target": { "type": "string" } }, "required": [] } } } } } }, "/api/v1/channels/{channelId}/toys/respond": { "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "respondToToyChallenge", "description": "Accept or decline an ephemeral invitation. Targeted invitations are recipient-only; current posting access is required. Expired invitations return 409. Accepted response includes the community and channel to open.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "action": { "enum": [ "join", "decline" ] } }, "required": [ "id", "action" ] } } } } } }, "/api/v1/me/toys/socket": { "get": { "operationId": "connectToyChallenges", "description": "Same-origin authenticated receive-only WebSocket. Delivers transient, recipient-scoped challenge notices across app views; no durable queue, history or gameplay payload.", "security": [ { "worldSession": [] } ], "responses": { "101": { "description": "Authenticated account challenge socket." }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/channels/{channelId}/toys/socket": { "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "connectChatToys", "description": "WebSocket Upgrade with current session, channel visibility and exact application Origin. Server sends state snapshots and update deltas; clients send bounded join/decline/grab/move/release/end/fire/duel-move commands, with connection identity and monotonically increasing seq. Acks reconcile local predictions; ping/pong estimates clock offset. Permission leases last at most one second. Only current posting participants may control a live toy. See docs/architecture/chat-toys.md.", "security": [ { "worldSession": [] } ], "responses": { "101": { "description": "Authenticated WebSocket upgrade." }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/me/entitlements": { "get": { "operationId": "readMyEntitlements", "description": "Effective Free/Indie/Studio plan, test-grant expiry, site role and personal capabilities. No payments.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/me/user": { "get": { "operationId": "readUserDescriptor", "description": "Versioned public fields for the signed-in user. Not a downloadable .user codec or importable authority.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/worlds/{worldId}": { "parameters": [ { "name": "worldId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "readWorldDescriptor", "description": "Typed World descriptor, navigation and active Studio sponsorship; member access required. Not a downloadable .world codec.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/applications/y2kanimator/access": { "get": { "operationId": "readAnimatorAccess", "description": "Personal capabilities and joined Studios. Optional project query returns current scoped read/edit/full-tool permissions. A sponsored Free artist receives full project tools; personal entitlements do not change. Native token exchange is not implemented.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "project", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/api/v1/admin/users": { "get": { "operationId": "adminFindUsers", "description": "Site admins only. Up to 50 users, with q substring search and after username cursor.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/admin/users/{principalId}/access": { "parameters": [ { "name": "principalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "operationId": "adminSetAccess", "description": "Site admins assign test plans and site roles with optimistic version, expiry and audited reason. Reject self-demotion and removal of the last active admin.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer" }, "plan": { "enum": [ "free", "indie", "studio" ] }, "siteRole": { "enum": [ "user", "moderator", "admin" ] }, "expiresAt": { "type": [ "integer", "null" ] }, "reason": { "type": "string" } }, "required": [ "version", "plan", "siteRole", "reason" ] } } } } } }, "/api/v1/admin/audit": { "get": { "operationId": "adminAccessAudit", "description": "Site admins only. Latest 50 access changes; before sequence cursor.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/communities/{communityId}/studio-projects/{projectId}/mediums": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "listProjectMediums", "description": "Project readers list up to 200 document summaries.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "operationId": "createProjectMedium", "description": "Artists and managers create project-owned Script, Notebook, Scrapbook or Storyboard documents. Paper defaults are resolved once. Creation is idempotent.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Created document as framed Protobuf.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "page.script", "page.notebook", "page.scrapbook", "page.storyboard" ] }, "title": { "type": "string" }, "paper": { "type": "object" } }, "required": [ "type", "title" ] } } } } } }, "/api/v1/communities/{communityId}/studio-projects/{projectId}/mediums/{mediumId}": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mediumId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "readProjectMedium", "description": "Read the current document with current project authorization.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Current document.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "patch": { "operationId": "saveProjectMedium", "description": "Artists and managers save using the expected document revision and idempotency key. The update and immutable snapshot commit together. Stale edits and receipts superseded by another edit return 409.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Saved document.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "document": { "type": "object" } }, "required": [ "document" ] } } } } } }, "/api/v1/communities/{communityId}/studio-projects/{projectId}/mediums/{mediumId}/export": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mediumId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "exportProjectMedium", "description": "Download exact stored .page bytes for a saved revision. References remain references; this does not bundle external media or grant access to targets.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Attachment with .page filename.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "revision", "in": "query", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/mediums/head": { "get": { "operationId": "mediumHead", "description": "Explicitly discover a newer saved reference. Both the pinned target and latest target require current authorization; reading never silently updates an embed.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "reference", "in": "query", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/communities/{communityId}/studio-projects/{projectId}/medium-imports": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "importMediumPackage", "description": "Import a Script, Notebook, Scrapbook or Storyboard into a fresh project-owned identity. Accepts .page or PAGEPK01 .pagepack; maximum 32 MiB and 64 resources, 128 MiB imports per project. Original bytes are retained; included references are remapped, external links remain explicit. Current artist/manager permissions and idempotency apply.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Existing idempotent import.", "content": { "application/json": { "schema": { "type": "object" } } } }, "201": { "description": "New document id and external dependencies.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/vnd.world.page-package": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } } } } } }, "/api/v1/communities/{communityId}/studio-projects/{projectId}/medium-sources": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "projectMediumSources", "description": "Current project readers discover installed recovered native storyboard/audio sources. These are references to original bytes, not a new timeline codec.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/medium-imports/{importId}/files/{key}": { "parameters": [ { "name": "importId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "importedMediumSource", "description": "Read an exact checksum-verified packaged source under current destination project authorization.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Original source bytes with their validated MIME type." }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/mediums/resolve": { "get": { "operationId": "resolveMediumReference", "description": "Resolve a pinned MediumReference through installed application adapters. Project documents, Development, project/episode containers and individual chat messages return framed Protobuf; existing y2k asset identities return presentation metadata. Target permissions are independent of the referring document. Document revisions use immutable snapshots; chat revisions use existing events, with deletion erasing history. Unknown or unavailable revisions return 409, never newer content. Unsupported address adapters return 422.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Authorized document or ReferencedPost bytes, or {reference,asset}.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "reader_unavailable: this address adapter is not installed.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "reference", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 2048 }, "description": "JSON-encoded {family,type,id,revision,scope?,localNumber?}. Project document scope is project:{projectId}. Social entries use type page.message with scope channel:{channelId}; id and localNumber both equal the post number, with an explicit revision. Generic y2k.asset addresses resolve metadata before reader selection. Asset IDs retain y2k:item:{packId}:{itemId} or y2k:pack:{packId}." } ] } }, "/api/v1/communities/{communityId}/studio-projects/{projectId}/ideas": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "listDevelopmentIdeas", "description": "Project readers receive bounded idea summaries. Development/Approved/Shelved are independent of episode stages.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "operationId": "createDevelopmentIdea", "description": "Project artists and managers create loose ideas. Does not create an episode. Idempotent; up to 200 ideas per project.", "security": [ { "worldSession": [] } ], "responses": { "201": { "description": "Idea and viewer capabilities.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "document": { "type": "object" } }, "required": [ "title" ] } } } } } }, "/api/v1/communities/{communityId}/studio-projects/{projectId}/ideas/{ideaId}": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ideaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "developmentIdea", "description": "Read an outline and reusable post-it note documents; current project access required.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "patch": { "operationId": "updateDevelopmentIdea", "description": "Explicit versioned save, 512 KiB maximum. Artists edit; managers approve/shelve/restore. Notes retain schemaVersion=1, UUID, text and native brush sample data. Pinning belongs to this host. Media references require sharing authority. No automatic episode conversion.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer" }, "title": { "type": "string" }, "status": { "enum": [ "development", "approved", "shelved" ] }, "document": { "type": "object" } }, "required": [ "version", "title", "document" ] } } } } } }, "/api/v1/communities/{communityId}/animation-projects/{episodeId}/import": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "episodeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "readImportedEpisode", "description": "Read the derived presentation manifest for an operator-imported native episode. Requires current project membership. Includes a flat shot list, new-format storyboard sheets and beats, animation recipes and private content-hash media references. Native editing is not implemented.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/communities/{communityId}/animation-projects/{episodeId}/import/{fileId}": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "episodeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "readImportedEpisodeFile", "description": "Stream an indexed private file by SHA-256; rechecks project membership before serving cached or ranged content. Native files are explicit gzip downloads.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "File bytes; MIME type comes from the verified import index." }, "206": { "description": "Single byte range with Content-Range." }, "304": { "description": "Unchanged file, after authorization." }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "416": { "description": "Invalid or unsatisfiable byte range." }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "Range", "in": "header", "required": false, "schema": { "type": "string" } } ] }, "head": { "operationId": "headImportedEpisodeFile", "description": "Authorized file metadata without a response body.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/feed": { "get": { "operationId": "followingFeed", "description": "Read-only chronological curated publications by followed active users. Excludes draft/withdrawn content. Up to 20 posts, byte-bounded keyset pages; before is the previous nextCursor. Publishing writer/editor is not implemented.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "FeedPage framed Protobuf.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "before", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/api/v1/users/{principalId}": { "parameters": [ { "name": "principalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "publicProfileSummary", "description": "Signed-in access to public ID, username and displayName only; no email/private UUID.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/users/{principalId}/follow": { "parameters": [ { "name": "principalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "followState", "description": "Current caller follow state.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "put": { "operationId": "followUser", "description": "Idempotent follow, maximum 5000, rejects self-follow.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ] }, "delete": { "operationId": "unfollowUser", "description": "Remove caller follow relationship only.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/channels/{channelId}/reactions": { "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "readChatReactions", "description": "Read up to 50 comma-separated post IDs. Rechecks content access.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "ReactionPage binary counts and caller selection, excluding inaccessible posts.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "ids", "in": "query", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/channels/{channelId}/reactions/{postId}": { "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "operationId": "addChatReaction", "description": "Idempotent emoji reaction from the shared inventory allowlist; maximum 8 per caller/post and 20 distinct per post.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "ReactionPage binary counts and caller selection, excluding inaccessible posts.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "emoji": { "type": "string" } }, "required": [ "emoji" ] } } } } }, "delete": { "operationId": "removeChatReaction", "description": "Remove only the caller reaction for this emoji.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "ReactionPage binary counts and caller selection, excluding inaccessible posts.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "emoji": { "type": "string" } }, "required": [ "emoji" ] } } } } } }, "/api/v1/publications/reactions": { "parameters": [], "get": { "operationId": "readPublicationReactions", "description": "Read up to 50 comma-separated post IDs. Rechecks content access.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "ReactionPage binary counts and caller selection, excluding inaccessible posts.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "ids", "in": "query", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/publications/reactions/{postId}": { "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "operationId": "addPublicationReaction", "description": "Idempotent emoji reaction from the shared inventory allowlist; maximum 8 per caller/post and 20 distinct per post.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "ReactionPage binary counts and caller selection, excluding inaccessible posts.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "emoji": { "type": "string" } }, "required": [ "emoji" ] } } } } }, "delete": { "operationId": "removePublicationReaction", "description": "Remove only the caller reaction for this emoji.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "ReactionPage binary counts and caller selection, excluding inaccessible posts.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "emoji": { "type": "string" } }, "required": [ "emoji" ] } } } } } }, "/api/v1/communities/{communityId}/assigned-work": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "assignedStudioWork", "description": "Current caller’s unfinished assigned episode deliverables and shot tasks, filtered by current Studio and project access. Compact summaries only, 50 items per page; nextOffset is null at the end. Completed, locked and retired work is excluded.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 } } ] } }, "/health/live": { "get": { "operationId": "liveness", "description": "Worker liveness only.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/health/ready": { "get": { "operationId": "readiness", "description": "D1 check, private storage binding and scheduled maintenance heartbeat. 503 if missing, failed or over one hour old.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/media": { "get": { "operationId": "mediaUsage", "description": "Owner storage usage, limits and accepted formats.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "operationId": "reserveUpload", "description": "Reserve space atomically: 8 MiB/file, 100 MiB/account, 512 MiB/test service, 500 items/account; preview reservation counts toward quota. Idempotent per account. Upload originals within one hour.", "security": [ { "worldSession": [] } ], "responses": { "201": { "description": "Upload id and state.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "mime": { "enum": [ "image/png", "image/jpeg", "image/gif", "image/webp", "application/vnd.world.y2k-object" ] }, "bytes": { "type": "integer", "minimum": 1, "maximum": 8388608 } }, "required": [ "name", "mime", "bytes" ] } } } } } }, "/api/v1/media/trash": { "get": { "operationId": "mediaTrash", "description": "Owner uploads recoverable within seven days.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/media/{mediaId}": { "parameters": [ { "name": "mediaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "operationId": "uploadOriginal", "description": "Owner supplies original raster or registered .y2k object bytes. Object signature, SHA-256 envelope, version, bounded Protobuf graph, type/filename and native model references are structurally validated. Native renderer execution is not supported. Pinned SHA-256 revision, private R2 object and saved inventory reference.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "delete": { "operationId": "trashUpload", "description": "Owner revokes media access immediately; bytes retained for seven-day restore and still count against quota.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [] } } } } } }, "/api/v1/media/{mediaId}/source": { "parameters": [ { "name": "mediaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "readOriginal", "description": "Current authorization is checked on every request. Original image bytes, private/no-store; no bearer URL or public bucket. GIF bytes remain unchanged.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "head": { "operationId": "headOriginal", "description": "Same authorization as GET; no response body.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/media/{mediaId}/preview": { "parameters": [ { "name": "mediaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "readPreview", "description": "Authorized preview; GIF always returns original animation.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "put": { "operationId": "uploadPreview", "description": "Owner supplies optional WebP up to 512 pixels per side and 128 KiB; GIFs skip static thumbnails.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "image/webp": { "schema": { "type": "string", "format": "binary" } } } } } }, "/api/v1/media/{mediaId}/restore": { "parameters": [ { "name": "mediaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "restoreUpload", "description": "Owner restores a trashed upload before expiry; same id/revision and existing authorized references.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [] } } } } } }, "/api/v1/auth/sessions": { "get": { "operationId": "listSessions", "description": "Current account sessions with non-secret ids, expiry and current-session flag.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/auth/sessions/{sessionId}": { "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "delete": { "operationId": "revokeSession", "description": "Revoke another session owned by this account. Use logout for the current session.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [] } } } } } }, "/api/v1/communities/{communityId}/moderation": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "moderationState", "description": "Owner/admin lists active timeouts and bans.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "operationId": "moderateMember", "description": "Owner/admin moderation with reason and hierarchy checks. Timeout blocks posting, ban revokes membership/grants and prevents rejoining. Unban does not restore membership. Changes audited.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "principalId": { "type": "string" }, "action": { "enum": [ "timeout", "clear-timeout", "ban", "unban" ] }, "seconds": { "type": "integer", "minimum": 60, "maximum": 604800 }, "reason": { "type": "string", "maxLength": 300 } }, "required": [ "principalId", "action", "reason" ] } } } } } }, "/api/v1/communities/{communityId}/invitations/{invitationId}": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "delete": { "operationId": "revokeInvitation", "description": "Owner/admin revokes an invitation by its non-bearer list identifier; audited.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [] } } } } } }, "/api/v1/community-entry": { "get": { "operationId": "communityEntry", "description": "Public join-page metadata by community handle, id or invitation. Private Communities require membership or a valid invitation; no channel data is returned to nonmembers. Handle lookup and short invitation codes are case-insensitive.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "community", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "invite", "in": "query", "schema": { "type": "string" } }, { "name": "destination", "in": "query", "schema": { "type": "string" } } ] } }, "/api/v1/communities/{communityId}/addresses": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "communityAddresses", "description": "Member-only canonical community and visible channel/Board addresses.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "patch": { "operationId": "renameCommunityAddress", "description": "Owner/admin rename with case-insensitive uniqueness and retained aliases. Body: handle, optional kind (community/channel/board) and destination id.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [] } } } } } }, "/api/v1/discovery": { "get": { "operationId": "discoverServers", "description": "Signed-in directory of discoverable, publicly joinable servers, newest first. Only id/name/tags, member count and viewer role are returned. Banned destinations are omitted. Up to 48 items plus nextCursor; pass after for the next page.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "after", "in": "query", "schema": { "type": "string" } } ] } }, "/api/v1/communities/{communityId}/join": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "joinDiscoverableServer", "description": "Join a publicly joinable server without an invitation as a contributor. Idempotent for existing members, preserving their role. Bans and the 100-server join limit remain enforced. Rejoining a revoked membership clears old restricted-channel grants and elevated roles. Joining is audited.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [] } } } } } }, "/api/v1/config": { "get": { "operationId": "configuration", "description": "Public-to-testers environment and sign-in configuration.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/test-content": { "get": { "operationId": "testContent", "description": "Public, read-only iPad test catalogue. Global snapshot, native pack identities and content-addressed detail/original URLs; no ownership transfer, upload or editing. Temporary asset storage, separate from private Studio data.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/me/inventory/studio-resources": { "get": { "operationId": "studioInventoryResources", "description": "Browse currently authorized project resources without copying content or granting access. Without project, lists accessible projects. upload=1 narrows that list to current upload authority and makes the selected-project response a bounded identity/capability lookup. Otherwise, project returns a filtered 80-item page of documents, Development, notes, native episode files and prepared shot/track/actor/symbol entries.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "project", "in": "query", "schema": { "type": "string" } }, { "name": "upload", "in": "query", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "kind", "in": "query", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0 } } ] } }, "/api/v1/studio-resources/{resourceId}/source": { "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "studioNativeSource", "description": "Stream exact immutable native object bytes from a private R2 bundle under current project authorization. Inventory saving and chat sharing never grant target access.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Native Y2KOBJ01 bytes with a download filename." }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/me/inventory": { "get": { "operationId": "inventory", "description": "Personal saved test-pack and individual content references, favourites and collections. Always scoped to the authenticated account; does not grant copyright or paid entitlements. Accept application/vnd.world.page returns a principal-scoped envelope and up to 100 entries. Continue with nextCursor; 409 inventory_changed requires restarting the snapshot.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Personal inventory snapshot page; principalId is a decimal string, including existing 128-bit IDs.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" } } ] } }, "/api/v1/content/resolve": { "get": { "operationId": "resolveContent", "description": "Resolve a stable content identity at an exact immutable revision. Private uploads require a signed-in owner or currently authorized conversation recipient. Unknown identities return 404; unavailable revisions return 409, never silently the latest. This endpoint does not grant ownership.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "packId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "schema": { "type": "string" } }, { "name": "revision", "in": "query", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/me/inventory/references": { "post": { "operationId": "saveContentReference", "description": "Idempotently save a server-resolved reference to personal inventory. Shared MediumReferences, published test content and currently accessible private uploads are supported; saving is not a purchase, license transfer or permanent access grant.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ref": { "type": "object", "description": "Legacy AssetReference or shared MediumReference." } }, "required": [ "ref" ] } } } } } }, "/api/v1/me/inventory/references/{key}": { "patch": { "operationId": "organizeContentReference", "description": "Set favourite/collection, or explicitly update a shared saved reference with updateRevision and expectedRevision. Current target permissions and a compare-and-swap check apply.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "favourite": { "type": "boolean" }, "collectionId": { "type": [ "string", "null" ] }, "updateRevision": { "type": "boolean" }, "expectedRevision": { "type": "string" } }, "required": [] } } } } }, "delete": { "operationId": "removeSavedMedium", "description": "Remove a shared reference from this inventory only; never delete the target.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/me/inventory/test-items": { "post": { "operationId": "acquireTestPack", "description": "Idempotently add a server-validated public test pack. Paid acquisitions are not implemented.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "packId": { "type": "string" } }, "required": [ "packId" ] } } } } } }, "/api/v1/me/inventory/collections": { "post": { "operationId": "createInventoryCollection", "description": "Create a personal collection; duplicate names return the existing collection. Maximum 100.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } } } } }, "/api/v1/me/inventory/items/{packId}": { "patch": { "operationId": "organizeInventoryItem", "description": "Set favourite and/or collection. Both item and collection must belong to this account.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "packId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "favourite": { "type": "boolean" }, "collectionId": { "type": [ "string", "null" ] } }, "required": [] } } } } } }, "/api/v1/me/inventory/collections/{collectionId}": { "delete": { "operationId": "removeInventoryCollection", "description": "Remove only the organization container; retain items in All items. Send an empty JSON object.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [] } } } } } }, "/api/v1/communities/{studioId}/mentions": { "get": { "operationId": "mentionMembers", "description": "Search up to twenty active Community members by username/display-name prefix. Membership required; no notifications are sent.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "studioId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string", "maxLength": 32 } } ] } }, "/api/v1/link-preview": { "post": { "operationId": "linkPreview", "description": "Bounded public HTTPS title/description preview. Requires a session and CSRF token; unavailable or disallowed pages return preview:null. No remote scripts or images are loaded.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "maxLength": 2048 } } } } } } } }, "/api/v1/content-types": { "get": { "operationId": "contentTypes", "description": "Versioned content registry: .y2kshot, .y2kactor, .y2ksymbol and .y2ktrack use the experimental Y2KOBJ01 Protobuf profile. The native .y2kmovie/.y2kboards codecs and ZIP .y2k distribution profile remain distinct.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/session": { "get": { "operationId": "session", "description": "Current account presentation + CSRF token, or account:null. Never returns the private account UUID.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/me": { "get": { "operationId": "me", "description": "Current individual principal.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/auth/email/start": { "post": { "operationId": "emailStart", "description": "Send a ten-minute, single-use six-digit code. Generic responses for ineligible addresses; cookie bound, rate limited, maximum five guesses.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "purpose": { "enum": [ "signup", "reset" ] } }, "required": [ "email" ] } } } } } }, "/api/v1/auth/email/verify": { "post": { "operationId": "emailVerify", "description": "Verify the code for the browser-bound email challenge. Does not create an account.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "pattern": "^[0-9]{6}$" } }, "required": [ "code" ] } } } } } }, "/api/v1/auth/verification": { "get": { "operationId": "verification", "description": "Current browser verification status.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/auth/register": { "post": { "operationId": "register", "description": "Consume a verified email challenge and create a password account. Username does not allocate a public DNS namespace. Password: 8–128 characters, common-pattern/username rejection, scrypt N=16384/r=8/p=5.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "displayName": { "type": "string" } }, "required": [ "username", "password" ] } } } } } }, "/api/v1/auth/login": { "post": { "operationId": "login", "description": "Email or username and password; generic failure and rate limits.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "login": { "type": "string" }, "password": { "type": "string" } }, "required": [ "login", "password" ] } } } } } }, "/api/v1/auth/username/available": { "post": { "operationId": "usernameAvailable", "description": "Check a normalized username without reserving it. Returns username and available only. Origin checked; 60 requests/minute per IP. Registration remains authoritative for concurrent claims.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string" } }, "required": [ "username" ] } } } } } }, "/api/v1/auth/register/username": { "post": { "operationId": "registerUsername", "description": "Create a username/password account without email. Email remains null and recovery unavailable until an optional address is verified. Same password policy and scrypt as verified-email signup. Origin checked, limited to 10 attempts/hour and 30/day per IP. Username does not allocate a public DNS namespace.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ] } } } } } }, "/api/v1/auth/recovery/start": { "post": { "operationId": "startRecoveryEmail", "description": "Current account with no email: prove current password and send a verification code. Does not attach an address yet or link existing accounts. Bounded account/IP/address delivery limits; ten-minute challenge bound to account and session.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } }, "required": [ "email", "password" ] } } } } } }, "/api/v1/auth/recovery/verify": { "post": { "operationId": "verifyRecoveryEmail", "description": "Consume the session-bound recovery code and atomically attach a verified email to an account that still has no email. Five-attempt limit; unique addresses; no change-email or account linking.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ] } } } } } }, "/api/v1/auth/security": { "get": { "operationId": "accountSecurity", "description": "Current account only: password-set status, Google connection and own email (null for username-only accounts). Never returns hashes or provider credentials.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/auth/password/reset": { "post": { "operationId": "passwordReset", "description": "Consume a verified reset challenge, change password and revoke every session. Sign in again afterwards.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string" } }, "required": [ "password" ] } } } } } }, "/api/v1/auth/google/start": { "post": { "operationId": "googleStart", "description": "Return Google authorization URL with browser-bound state, nonce and PKCE. Only openid/email/profile scopes.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "invitation": { "type": "string" } }, "required": [] } } } } } }, "/api/v1/auth/google/callback": { "get": { "operationId": "googleCallback", "description": "Validate state, exchange code server-side and verify signed ID token. Existing Google identities sign in; new identities choose a username. Matching email never silently merges accounts.", "security": [], "responses": { "303": { "description": "Redirect to homepage or pending invitation." }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/auth/google/complete": { "post": { "operationId": "googleComplete", "description": "Consume verified Google profile and create a first-party account with a username. No world.page password is required; it can be added later through email-verified recovery. Existing Google sign-in remains available.", "security": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "displayName": { "type": "string" } }, "required": [ "username" ] } } } } } }, "/api/v1/auth/logout": { "post": { "operationId": "logout", "description": "Revoke this server session.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [] } } } } } }, "/api/v1/auth/logout-all": { "post": { "operationId": "logoutAll", "description": "Revoke all sessions belonging to this account.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [] } } } } } }, "/api/v1/communities": { "get": { "operationId": "listStudios", "description": "Owned and active-member Studios only; capped at 100 for testing.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "operationId": "createStudio", "description": "Create a Studio with exactly one owner and two default channels. Per-account idempotency; ten owned Studios maximum.", "security": [ { "worldSession": [] } ], "responses": { "201": { "description": "Studio id, name and owner role.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80 }, "type": { "enum": [ "studio", "community" ] } }, "required": [ "name" ] } } } } } }, "/api/v1/communities/{communityId}/page": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "communityPage", "description": "Authorized framed Protobuf Community root. Contains tags, definition/policy revisions and logical references; definition and navigator have dedicated endpoints; inventory/index logical resolvers remain future work.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "One Community Frame.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/communities/{communityId}/navigator": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "communityNavigator", "description": "Authorized Protobuf navigator configuration. Registered section labels, order and visibility; no executable code or permission changes.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Navigator Frame.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/communities/{communityId}/definition": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "communityDefinition", "description": "Authorized Protobuf definition with versioned navigation settings and discoverability.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Definition Frame.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "patch": { "operationId": "updateCommunityDefinition", "description": "Owner/admin only; checked revision, bounded tags and transactional audit. Tags never grant access. Public joining permits explicit membership requests without invitations. Discovery lists public join pages; invitation-only Communities cannot be listed. Disabling either setting leaves existing memberships intact.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80 }, "tags": { "type": "array", "maxItems": 8, "items": { "type": "string", "pattern": "^[a-z][a-z0-9-]{0,31}$" } }, "version": { "type": "integer", "minimum": 1 }, "discoverable": { "type": "boolean" }, "publicJoin": { "type": "boolean" }, "navigationConfig": { "type": "object", "properties": { "sections": { "type": "array", "minItems": 10, "maxItems": 10, "items": { "type": "object", "required": [ "id", "label", "enabled" ], "properties": { "id": { "type": "string" }, "label": { "type": "string", "minLength": 1, "maxLength": 60 }, "enabled": { "type": "boolean" } } } } } } }, "required": [ "name", "tags", "version" ] } } } } } }, "/api/v1/communities/{communityId}/workspace": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "openStudioWorkspace", "description": "Load an authorized Studio, its visible channels and 50 messages from the selected channel in one response. Optional channel must belong to this Studio and be viewable. Community/channel IDs are 19-digit decimal strings; old Studio routes and legacy IDs are retired. Accept application/vnd.world.page for a bounded Protobuf Workspace frame; the browser uses this transport.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Workspace and authorized initial chat snapshot.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "channel", "in": "query", "schema": { "type": "string" } } ] } }, "/api/v1/communities/{communityId}/channels": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "listChannels", "description": "Only channels the caller may view.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "operationId": "createChannel", "description": "Owner/admin only, at most 100 channels per Studio.", "security": [ { "worldSession": [] } ], "responses": { "201": { "description": "New channel.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "enum": [ "text", "announcements" ] }, "visibility": { "enum": [ "members", "restricted" ] } }, "required": [ "name" ] } } } } } }, "/api/v1/communities/{communityId}/studio-projects": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "studioOverview", "description": "Community directory of project names and kinds. Only project members receive cover references, template details and episode counts. Includes six common animation presets and six storyboard layouts. Custom dimensions are capped at QHD: long edge 2560, short edge 1440, with either orientation.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "operationId": "createStudioProject", "description": "Community owner/admin establishes an animation project container and becomes its project owner. Does not create an episode. Project permissions are separate from community roles. Idempotent create.", "security": [ { "worldSession": [] } ], "responses": { "201": { "description": "Project container with viewer capabilities and empty episode list.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "template": { "type": "object", "description": "schema=1; animation width/height are positive integers with max(width,height)<=2560 and min(width,height)<=1440; storyboard template/paper/dpi/notesFraction/geometryVersion=2" }, "cover": { "type": [ "object", "null" ], "required": [ "schema", "packId", "itemId", "revision" ], "properties": { "schema": { "const": 1 }, "packId": { "type": "string" }, "itemId": { "type": [ "string", "null" ] }, "revision": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } }, "required": [ "name" ] } } } } } }, "/api/v1/communities/{communityId}/studio-projects/{projectId}": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "studioProject", "description": "Project-member-only details and episodes. Community admin status does not grant project access.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "patch": { "operationId": "updateProjectTemplate", "description": "Project owner/admin/manager only. Requires current project version. Changes the default for future episodes; existing episode settings remain unchanged. Template version advances only when validated template changes. QHD limits apply to custom dimensions too.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer" }, "name": { "type": "string" }, "template": { "type": "object" }, "cover": { "type": [ "object", "null" ], "required": [ "schema", "packId", "itemId", "revision" ], "properties": { "schema": { "const": 1 }, "packId": { "type": "string" }, "itemId": { "type": [ "string", "null" ] }, "revision": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } }, "required": [ "version", "name", "template" ] } } } } } }, "/api/v1/communities/{communityId}/studio-projects/{projectId}/episodes": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "createAnimationEpisode", "description": "Project managers create an episode in Development. Project Settings snapshots the parent template; Custom validates and snapshots the supplied episode-only template. Neither changes the parent or existing documents. Atomically links the episode. Requires current project version, a template within QHD limits, and an idempotency key. Returns the existing animation workflow ID; maximum 100 episodes per project.", "security": [ { "worldSession": [] } ], "responses": { "201": { "description": "Episode ID and parent project ID.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string", "maxLength": 600 }, "settingsMode": { "enum": [ "project", "custom" ] }, "template": { "type": "object", "description": "Required for custom mode; same schema as project templates." }, "cover": { "type": [ "object", "null" ], "required": [ "schema", "packId", "itemId", "revision" ], "properties": { "schema": { "const": 1 }, "packId": { "type": "string" }, "itemId": { "type": [ "string", "null" ] }, "revision": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } }, "required": [ "version", "name" ] } } } } } }, "/api/v1/communities/{communityId}/studio-projects/{projectId}/members": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "projectTeam", "description": "Project owner/admin only; public profile identities, explicit project roles and project version.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "put": { "operationId": "setProjectRole", "description": "Versioned, audited project role update. Owner/admin may manage managers/artists/viewers; only project owner may grant/change admin. The owner cannot be removed. Target must be an active community member. Community membership admits access but never supplies project-management authority.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer" }, "principalId": { "type": "string" }, "role": { "enum": [ "admin", "manager", "artist", "viewer" ] }, "state": { "enum": [ "active", "revoked" ] } }, "required": [ "version", "principalId", "role", "state" ] } } } } } }, "/api/v1/communities/{communityId}/animation-projects": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "listAnimationWorkflows", "description": "Lists up to 100 episode workflow summaries visible to the current project member. Parent containers are listed through studio-projects.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "operationId": "createAnimationWorkflow", "description": "Retired unparented creation endpoint. Returns 409 project_container_required; create an episode through studio-projects/{projectId}/episodes.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "deprecated": true } }, "/api/v1/communities/{communityId}/animation-projects/{projectId}": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "animationWorkflow", "description": "Project-member-only episode state, pinned template, public producer/assignee identities and latest 40 events. Shot occurrence IDs are distinct from content IDs. This JSON management API does not change the .page Protobuf transport or native .y2k formats.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/communities/{communityId}/animation-projects/{projectId}/commands": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "animationWorkflowCommand", "description": "Version-checked, idempotent workflow transaction with atomic event history. Project-manager-only set-stage/deliverable/advance/add-shot/review/assign/unassign/reopen-shot/episode-cover. Community admin status alone grants none of these permissions. Contributors claim/release/submit only their assigned work. Managers assign pre-production tasks; assigned contributors and managers may update primary progress states. target-status atomically updates the canonical deliverables for an overview target; managers or artists assigned to every constituent can update unlocked work. Progress Done does not approve or lock work. Approved deliverables must be reopened before progress changes. New episodes allow Outline, Script and Storyboard work immediately. Outline, Script and Storyboard require sign-off before Audio and Timing; these require sign-off before animation shots, followed by PostFX and Export. Legacy flexible episodes retain their existing access. target-review signs off or reopens a target; empty work cannot be approved. Managers use set-stage to move directly or reopen a completed episode. Stage changes do not imply deliverable approval. One task represents the whole shot; acceptance locks the shot. Legacy pass submissions remain preserved as history. Reopening a shot requires a reason and preserves the current stage and unrelated reviews. Bounties are immutable recorded offers in minor currency units; no payment settlement or native editing is performed. Omit fields unrelated to the chosen action.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 1 }, "action": { "enum": [ "deliverable", "advance", "add-shot", "claim", "release", "submit", "review", "unassign", "reopen-shot", "assign", "episode-cover", "episode-description", "shot-status", "preproduction-status", "preproduction-assign", "set-stage", "target-status", "target-review" ] }, "stage": { "enum": [ "development", "pre-production", "production", "post" ] }, "target": { "enum": [ "outline", "script", "storyboard", "audio-timing", "postfx", "export" ] }, "step": { "type": "string" }, "status": { "enum": [ "todo", "in-progress", "in-review", "done" ] }, "description": { "type": "string", "maxLength": 600 }, "notes": { "type": "string", "maxLength": 8000 }, "writing": { "type": "object", "description": "Validated version-1 writing blocks for Outline and Script; plain text must match notes." }, "accepted": { "type": "boolean" }, "refs": { "type": "array", "maxItems": 8, "items": { "type": "object", "required": [ "schema", "packId", "itemId", "revision" ], "properties": { "schema": { "const": 1 }, "packId": { "type": "string" }, "itemId": { "type": [ "string", "null" ] }, "revision": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } }, "cover": { "type": [ "object", "null" ], "required": [ "schema", "packId", "itemId", "revision" ], "properties": { "schema": { "const": 1 }, "packId": { "type": "string" }, "itemId": { "type": [ "string", "null" ] }, "revision": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } }, "principalId": { "type": "string" }, "shotId": { "type": "string" }, "taskId": { "enum": [ "shot" ] }, "accept": { "type": "boolean" }, "reason": { "type": "string", "maxLength": 2000 }, "name": { "type": "string", "maxLength": 100 }, "scene": { "type": "string", "maxLength": 100 }, "frames": { "type": "integer", "minimum": 1, "maximum": 2000000 }, "brief": { "type": "string", "maxLength": 2000 }, "currency": { "enum": [ "USD", "EUR", "GBP", "PLN" ] }, "bounties": { "type": "object", "additionalProperties": false, "properties": { "shot": { "type": "integer", "minimum": 0, "maximum": 100000000 } } } }, "required": [ "version", "action" ] } } } } } }, "/api/v1/communities/{communityId}/projects": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "animationProjects", "description": "Owner and active Studio admins only until project assignments exist. Returns up to 100 private workflow records and phase definitions.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "operationId": "createAnimationProject", "description": "Create an animation workflow in Development. Only a name is accepted; phases cannot be skipped. Idempotency is per Studio and creating account. No authored content is uploaded.", "security": [ { "worldSession": [] } ], "responses": { "201": { "description": "Created animation project.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 } }, "required": [ "name" ] } } } } } }, "/api/v1/communities/{communityId}/projects/{projectId}": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "animationProject", "description": "Owner/admin-only project metadata, phase checklists and recent approval history. Project IDs are 19-digit decimal strings.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/communities/{communityId}/projects/{projectId}/checks": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "operationId": "checkAnimationWork", "description": "Owner/admin marks one item in the current phase. Previous and future phases and completed projects are read-only. Version conflicts return 409; this is manual workflow sign-off, not verification of uploaded artwork.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 1 }, "step": { "enum": [ "outline", "sketches", "script", "storyboard", "audio", "timing", "animatic", "animation", "postfx", "completion" ] }, "done": { "type": "boolean" } }, "required": [ "version", "step", "done" ] } } } } } }, "/api/v1/communities/{communityId}/projects/{projectId}/approve": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "approveAnimationPhase", "description": "Studio owner only. Requires every current-phase item to be checked and the exact current version/phase. Development opens Pre-Production; Pre-Production opens Production; Production approval completes the project. SQL mutation and approval history are atomic.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 1 }, "phase": { "enum": [ "development", "pre-production", "production" ] } }, "required": [ "version", "phase" ] } } } } } }, "/api/v1/communities/{communityId}/members": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "members", "description": "Members of an accessible Studio; no private account IDs.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/communities/{communityId}/members/{principalId}": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "principalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "operationId": "updateMember", "description": "Owner/admin only. Only owners can manage admins. Owner cannot be removed through membership changes.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "enum": [ "admin", "contributor", "reviewer", "guest" ] }, "state": { "enum": [ "active", "revoked" ] } }, "required": [ "role", "state" ] } } } } } }, "/api/v1/communities/{communityId}/invitations": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "listInvites", "description": "Owner/admin lists invitation identifiers, roles, expiry, reusable status and join counts; bearer tokens are never returned.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "operationId": "invite", "description": "Owner/admin creates an invitation. Set reusable=true for a seven-character root-domain link that multiple accounts can use until revoked; otherwise a single-use 48-hour link. No email is sent. Invitees sign in with their own account.", "security": [ { "worldSession": [] } ], "responses": { "201": { "description": "Invitation URL, role and expiry.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "enum": [ "contributor", "reviewer", "guest" ] }, "reusable": { "type": "boolean" } }, "required": [] } } } } } }, "/api/v1/invitations/accept": { "post": { "operationId": "acceptInvitation", "description": "Accept a short reusable code or a legacy single-use token. Reusable joins preserve active roles, clear stale restricted grants on rejoin, enforce bans and join limits, and are audited. Legacy single-use replay remains rejected.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ] } } } } } }, "/api/v1/communities/{communityId}/audit": { "parameters": [ { "name": "communityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "audit", "description": "Owner/admin only; latest 100 membership/grant events. Not yet a complete lifecycle audit.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/channels/{channelId}/typing": { "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "channelTyping", "description": "Other active typists in this channel. Requires current visibility; rechecks typist membership, post permission, session and timeout. Excludes self. Maximum ten profiles; hints expire after eight seconds.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "operationId": "setChannelTyping", "description": "Publish or clear this session’s activity hint. No draft text is stored. Active hints require post permission. Limited to 60 changes per account per minute.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean" } }, "required": [ "active" ] } } } } } }, "/api/v1/channels/{channelId}/messages": { "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "messages", "description": "With Accept application/vnd.world.page, returns one Snapshot Frame, at most 50 posts/events under the byte budget. No cursor requests latest snapshot; before is a room-local post number; after is a committed room change cursor. Cursors and post numbers are exact decimal strings. History must not advance the live cursor. JSON compatibility uses the older global sequence; do not mix cursor namespaces.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Binary snapshot/history/delta or JSON compatibility history.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "before", "in": "query", "schema": { "type": "string" } }, { "name": "after", "in": "query", "schema": { "type": "string" } } ] }, "post": { "operationId": "sendMessage", "description": "Rechecks posting permission in SQL. Read-only roles cannot post; announcements require owner/admin. Repeated idempotency key returns the same message when text and normalized references match. Requires non-empty text or 1–8 references; references are resolved server-side. History and workspace messages include content references. Content-Type application/vnd.world.page accepts exactly one PostCommand Frame for this Community (32 KiB maximum). The browser sends binary commands; response is a binary Receipt when requested. Edits/deletions are separate JSON commands.", "security": [ { "worldSession": [] } ], "responses": { "201": { "description": "Message id / Receipt.", "content": { "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "maxLength": 4000 }, "contentRefs": { "type": "array", "maxItems": 8, "items": { "type": "object", "required": [ "schema", "packId", "itemId", "revision" ], "properties": { "schema": { "const": 1 }, "packId": { "type": "string" }, "itemId": { "type": [ "string", "null" ] }, "revision": { "type": "string", "pattern": "^[a-f0-9]{64}$" } } } } }, "required": [] } }, "application/vnd.world.page": { "schema": { "type": "string", "format": "binary" } } } } } }, "/api/v1/channels/{channelId}/messages/{messageId}": { "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "operationId": "editChatMessage", "description": "Author with current posting access edits the text at the expected revision. Generates a new committed change; original message number stays fixed.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 1 }, "body": { "type": "string", "minLength": 1, "maxLength": 4000 } }, "required": [ "version", "body" ] } } } } }, "delete": { "operationId": "deleteChatMessage", "description": "Author or owner/admin with posting access. Requires current revision; erases current and prior event payloads and emits a numbered tombstone.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 1 } }, "required": [ "version" ] } } } } } }, "/api/v1/channels/{channelId}/grants": { "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "channelGrants", "description": "Owner/admin only.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "put": { "operationId": "updateChannelGrant", "description": "Owner/admin only. Restricted-channel view and post grant; post requires view. Roles and active membership remain upper bounds.", "security": [ { "worldSession": [] } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "403": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "409": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "410": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "413": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "415": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } }, "503": { "description": "Error envelope: {error:{code,message,requestId}}.", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "X-CSRF-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "principalId": { "type": "string" }, "view": { "type": "boolean" }, "post": { "type": "boolean" } }, "required": [ "principalId", "view", "post" ] } } } } } } } }