# API Reference Look up a pinned route by the job it serves. World API explains the requests a world client writes first. ## The pinned surface This page is a lookup of every operation in the published OpenAPI contract, grouped by the job a future client is trying to do. Expand a route to read its access rule and wire definition. Use /openapi.json on your own API server to check the contract installed there. Public probes, browser sessions, workspace tokens and outside-agent keys have different access rules; each operation states its own. [Download the pinned OpenAPI schema](/openapi.json). [World API](/docs/world-api) ## Worldbuilding Create or reopen a world. - [List Worlds](/docs/world-api/list-worlds): GET /worlds. Return the worlds in your workspace and its world-count policy. Use the returned world ID when reading a world’s content. - [List Recipes](/docs/world-api/recipes): GET /worlds/recipes. Return the server’s world recipes in catalog order. Each recipe has a key, a display label, and a tile count. Use its key when creating a generated world. - [Generate a World](/docs/world-api/generate): POST /worlds/generated. Generate and save a world from a recipe. The response is the saved entry, which identifies the world and the version it reopens. - [List Saved Entries](/docs/world-api/entries): GET /world-entries. Read the saved entries your workspace can reopen. An entry carries its title, world ID, and authored version. Use that version when inspecting or editing the world. **GETList Worlds`/worlds`** Return the worlds in your workspace and its world-count policy. Use the returned world ID when reading a world’s content. Required permissions: world.read [Link to this operation](/docs/api-reference#api-worlds_worlds_get). [Request examples and fields](/docs/world-api/list-worlds). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorldsView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETList Recipes`/worlds/recipes`** Return the server’s world recipes in catalog order. Each recipe has a key, a display label, and a tile count. Use its key when creating a generated world. Required permissions: world.read [Link to this operation](/docs/api-reference#api-recipes_worlds_recipes_get). [Request examples and fields](/docs/world-api/recipes). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorldRecipeView" }, "title": "Response Recipes Worlds Recipes Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTGenerate a World`/worlds/generated`** Generate and save a world from a recipe. The response is the saved entry, which identifies the world and the version it reopens. Required permissions: world.write [Link to this operation](/docs/api-reference#api-create_generated_world_worlds_generated_post). [Request examples and fields](/docs/world-api/generate). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGeneratedWorldBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedWorldEntryView" } } } }, "409": { "description": "Refused by name; nothing was written." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETList Saved Entries`/world-entries`** Read the saved entries your workspace can reopen. An entry carries its title, world ID, and authored version. Use that version when inspecting or editing the world. Required permissions: world.read [Link to this operation](/docs/api-reference#api-entries_world_entries_get). [Request examples and fields](/docs/world-api/entries). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SavedWorldEntryView" }, "title": "Response Entries World Entries Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCreate Entry`/world-entries`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-create_entry_world_entries_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSavedWorldEntryBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedWorldEntryView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETEntry`/world-entries/{entry_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-entry_world_entries__entry_id__get). ```json { "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedWorldEntryView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **PUTUpdate Entry`/world-entries/{entry_id}`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-update_entry_world_entries__entry_id__put). ```json { "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSavedWorldEntryBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedWorldEntryView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETCandidates`/world-entries/candidates`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-candidates_world_entries_candidates_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SavedWorldCandidateView" }, "title": "Response Candidates World Entries Candidates Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCreate Starter Entry`/world-entries/starter`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-create_starter_entry_world_entries_starter_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStarterWorldBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedWorldEntryView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETEvery parameter a world can be asked for by, as its grammar declares it.`/world-generation/grammars`** The catalog. Nobody can tune a parameter they cannot enumerate. Every declared parameter, with its unit, the cascade level it belongs to, the one stage that reads it, what happens when nothing sets it, its range or its options, and the stated basis of that range. All of it read off the registered grammar rather than restated here, so this cannot drift from what the cascade will actually enforce. Required permissions: world.read [Link to this operation](/docs/api-reference#api-grammars_world_generation_grammars_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GrammarView" }, "title": "Response Grammars World Generation Grammars Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTState a specification; get the world it makes, or a refusal naming the parameter.`/world-generation/worlds`** Resolve, charge, generate. In that order, and the order is the point. The charge is taken from the tile count the RESOLVED specification covers, before any record is made, so a request the workspace cannot afford costs nothing but the resolution. That mirrors exulanica.models.budget, which reserves before a call for the same reason exulanica.api.quotas gives: charging less than a request can cost lets the last request cross the ceiling, which is the one thing a ceiling exists to prevent. Nothing is stored. A specification needs no row, because the seed is derived from it: the request body and this route are together enough to make the same world again, and a table would be a second copy of a fact that is already reproducible. Required permissions: tiles.materialise [Link to this operation](/docs/api-reference#api-ask_for_a_world_world_generation_worlds_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecificationBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedWorldView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETERemove World`/worlds/{world_id}`** Permanently remove a generated world; a backup restore honors the removal again. Required permissions: deletion.write, world.write [Link to this operation](/docs/api-reference#api-remove_world_worlds__world_id__delete). ```json { "parameters": [ { "name": "world_id", "in": "path", "required": true, "schema": { "type": "string", "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhether each kind of world can be made in this workspace now, and how.`/worlds/capabilities`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-world_creation_worlds_capabilities_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response World Creation Worlds Capabilities Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTMake a world from a description, as a job the page polls.`/worlds/drafts`** Admit the words and start the draft; answer at once, never waiting on a model. 403 kinds_from_people_not_offered on a server whose deployment has not turned kinds from people on; 503 without a model credential; 429 budget_exceeded with its spending member when the workspace's allowance admits no attempt (spending_suspended while the authority is held closed); 409 world_limit_reached when the workspace holds as many generated worlds as it may; 403 worlds_read_only where the database role cannot register a world: each before anything is spent, and each said by GET /worlds/drafts before anything is typed. 409 kind_draft_busy while a draft runs in this workspace, with its draft_id when the caller started it as a world's draft; 429 kind_draft_limit with a Retry-After when the caller has started as many drafts this hour as one person may. A server already running as many drafts as it may still answers 202: the draft waits queued until its worker has a slot, and ends refused kind_draft_capacity only where no thread could be started for it. The three figures are the world draft policy's budgets. A body over 131,072 bytes, including quote metadata, is refused 413 before it is read. Saved names are replaced in the words before the job starts. Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-start_world_draft_worlds_drafts_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftWorldBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MadeWorldDraftView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhether a draft of a world would be taken now, and what one may spend.`/worlds/drafts`** What starting a draft would meet, for this person in this workspace, before a word is typed: offered or the first refusal a start would give, by code and sentence, in the order the start asks them; the most times one draft asks a model (calls_at_most); this person's starts this hour, how many are left and when the next frees; and their own draft of a world still running here, by id. Nothing is said of anybody else: another person's running draft is kind_draft_busy with no id. The server's own capacity changes from moment to moment and is answered when a draft starts. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_world_draft_offer_worlds_drafts_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorldDraftOfferView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe kinds of world a person can make worlds of.`/worlds/kinds`** The town, the shipped kinds and the workspace's own kinds, each in plain words, and whether this caller may draft a new kind of place here. Required permissions: world.read [Link to this operation](/docs/api-reference#api-library_worlds_kinds_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KindLibraryView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTKeep a creator's world kind in this workspace once its checks pass.`/worlds/kinds`** Read the kind, build its sample worlds and keep it when every one passes. A server whose deployment has not turned kinds from people on (EXULANICA_KINDS_FROM_PEOPLE) answers 403 kinds_from_people_not_offered for a document it would otherwise keep, before any sample world is built and before anything is written: a kept kind is a person's own document, and no removal reaches its row. A body that is no kind is refused 422 for itself first, as on any server. A body over UPLOAD_BODY_MAXIMUM is refused 413 before it is read; a document larger than UPLOAD_BYTES_MAXIMUM, one whose origin is not uploaded, and any refusal of either stage answer 422 with the refusal's code, where and why (stage B's with its report so far); a version or a document the workspace already holds, and a workspace already keeping as many kind versions as it may, answer 409, before any sample world is built. Stage B runs in the kind worker (exulanica.world.kinds.worker), never on the request's thread: checks the worker does not finish within its limit, or cannot take, answer 503 kind_work_overran, kind_work_busy or kind_work_unavailable with a Retry-After, and finished checks are kept, so sending the same kind again reads them. Required permissions: world.write [Link to this operation](/docs/api-reference#api-upload_kind_worlds_kinds_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadKindBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadedKindView" } } } }, "422": { "description": "Refused by name; nothing was written." } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhether a world can be made, or photographs added to it, from your reviewed photographs now; writes nothing.`/worlds/personal-source`** Required permissions: admission.read, world.read [Link to this operation](/docs/api-reference#api-personal_source_world_worlds_personal_source_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalWorldView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCompose your reviewed photographs into your personal-source world, or add them to it, as last read.`/worlds/personal-source`** Required permissions: admission.read, world.write [Link to this operation](/docs/api-reference#api-compose_personal_source_world_worlds_personal_source_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComposePersonalWorldBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComposedPersonalWorldView" } } } }, "409": { "description": "Refused by name; nothing was written." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETList References`/worlds/references`** The caller's most recent reference requests, newest first, and whether one may be made. Required permissions: world.read [Link to this operation](/docs/api-reference#api-list_references_worlds_references_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRequest Reference`/worlds/references`** Ask for notes on what the things in a description and the person's own pictures look like, for one draft. Answers 202 with the request at once; an idempotency key answers 200 with the request it first made. Required permissions: model.invoke, references.request, world.write [Link to this operation](/docs/api-reference#api-request_reference_worlds_references_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe showcase worlds this installation serves, each with its card picture's digest.`/worlds/showcase`** Every served showcase world's key, title, sentence, identity and card picture's record. Required permissions: world.read [Link to this operation](/docs/api-reference#api-showcase_catalog_worlds_showcase_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShowcaseCatalogView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhat a generated world may be made from: every value, its range, presets, refusals.`/worlds/specification`** The specification schema this server offers, with its presets and every refusal by name. Required permissions: world.read [Link to this operation](/docs/api-reference#api-specification_worlds_specification_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Specification Worlds Specification Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe pictures this workspace keeps from picture searches.`/worlds/web-pictures`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-list_web_pictures_worlds_web_pictures_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response List Web Pictures Worlds Web Pictures Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **PUTPut Picture`/world-entries/{entry_id}/picture`** Keep the picture of the world's first view a page drew, in place of any other. The body is the picture itself, typed by Content-Type; the query names the version, state and look it shows, which must be the entry's own now. Refused by name: another type (415), a larger one (413), one with anything but the picture in it or of another size (422), one of a world that holds a photograph (422), one of a world as it no longer is (409). Required permissions: world.write [Link to this operation](/docs/api-reference#api-put_picture_world_entries__entry_id__picture_put). ```json { "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Entry Id" } }, { "name": "authored_version_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Authored Version Id" } }, { "name": "authored_state_sha256", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Authored State Sha256" } }, { "name": "style_version_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Style Version Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "image/jpeg": { "schema": { "type": "string", "contentMediaType": "image/jpeg" } }, "image/webp": { "schema": { "type": "string", "contentMediaType": "image/webp" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedWorldEntryPictureView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETPicture`/world-entries/{entry_id}/picture`** The kept picture's bytes, while sha256 is its digest: the address names the bytes, so a browser keeps them as long as it likes. Required permissions: world.read [Link to this operation](/docs/api-reference#api-picture_world_entries__entry_id__picture_get). ```json { "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Entry Id" } }, { "name": "sha256", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAttach Sources`/world-entries/{entry_id}/source-attachments`** Required permissions: admission.read, world.write [Link to this operation](/docs/api-reference#api-attach_sources_world_entries__entry_id__source_attachments_post). ```json { "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachSavedWorldSourcesBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedWorldEntryView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTDetach Sources`/world-entries/{entry_id}/source-detachments`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-detach_sources_world_entries__entry_id__source_detachments_post). ```json { "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetachSavedWorldSourcesBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedWorldEntryView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRebind Sources`/world-entries/{entry_id}/source-rebinds`** Required permissions: admission.read, world.write [Link to this operation](/docs/api-reference#api-rebind_sources_world_entries__entry_id__source_rebinds_post). ```json { "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Entry Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RebindSavedWorldSourcesBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedWorldEntryView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETPreview World Removal`/worlds/{world_id}/removal`** Read removal consequences. Only its creator or workspace owner can remove a world. Required permissions: world.read [Link to this operation](/docs/api-reference#api-preview_world_removal_worlds__world_id__removal_get). ```json { "parameters": [ { "name": "world_id", "in": "path", "required": true, "schema": { "type": "string", "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorldRemovalView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhere a draft of a world has got to, for the person who started it.`/worlds/drafts/{draft_id}`** The draft's state: choosing, drafting, making, ready with the saved world, or refused by name. 404 world_draft_unknown for an id the server holds for nobody here to read: another person's, another workspace's, a kind's draft, one a restart lost, or none. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_world_draft_worlds_drafts__draft_id__get). ```json { "parameters": [ { "name": "draft_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Draft Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MadeWorldDraftView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTSave an admitted terrain realization as a world.`/worlds/generated/terrain`** Retain exact authored terrain and a valid entry through saved-world authority. The source declares bounded person contact and passive flat-patch geometry. It has no society projection; creating it does not fulfill a world kind's activity requirements. Required permissions: world.write [Link to this operation](/docs/api-reference#api-create_terrain_world_worlds_generated_terrain_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTerrainWorldBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedWorldEntryView" } } } }, "422": { "description": "Invalid terrain or entry; nothing was written." } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTDraft a kind of world from a description, as a job the page polls.`/worlds/kinds/drafts`** Admit the words and start the draft; answer at once, never waiting on the model. 403 kinds_from_people_not_offered on a server whose deployment has not turned kinds from people on (EXULANICA_KINDS_FROM_PEOPLE), before anything is read; 503 without a model credential; 429 budget_exceeded with its spending member when the workspace's allowance for the drafting model admits no attempt (spent, or below what one reserves; spending_suspended while the authority is held closed); 409 kind_cap_reached when the workspace keeps as many kinds as it may, each before anything is spent; 409 kind_draft_busy while a draft runs in this workspace, with its draft_id when the caller started it; 429 kind_draft_limit with a Retry-After when the caller has started as many drafts this hour as one person may; 503 kind_draft_capacity with a Retry-After when the server runs as many drafts as it may. Saved names are replaced before the job starts, and the workspace's rules, releasing no place's name, are applied again as each request leaves. Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-start_kind_draft_worlds_kinds_drafts_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftKindBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KindDraftView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe kinds of place this caller is drafting or drafted lately, newest first.`/worlds/kinds/drafts`** The caller's drafts this server still holds in this workspace, newest first, so a reload, a second tab or a return finds a draft still running without starting another. Required permissions: world.read [Link to this operation](/docs/api-reference#api-list_kind_drafts_worlds_kinds_drafts_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KindDraftListView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Reference`/worlds/references/{reference_id}`** One reference request: its steps as they happen, then its notes, or why it stopped. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_reference_worlds_references__reference_id__get). ```json { "parameters": [ { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Reference Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTMake your own copy of a showcase world, or open the one you hold.`/worlds/showcase/{showcase}`** Make the caller's copy of the showcase world showcase and bring it to life, or answer the copy the caller's workspace already holds. Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-open_showcase_world_worlds_showcase__showcase__post). ```json { "parameters": [ { "name": "showcase", "in": "path", "required": true, "schema": { "type": "string", "title": "Showcase" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "The copy the workspace already holds." }, "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "No showcase world of that key is served here." }, "409": { "description": "Refused by name; nothing was written." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTDraft a world's specification from a description; nothing is made.`/worlds/specification/drafts`** Ask the specification drafter for a proposal of body.description, validate it as a person's own values are validated, and sample one town of it when it is valid; make nothing. Answered 503 where the instance has no model credential, before the specification is read. Required permissions: model.invoke, world.read [Link to this operation](/docs/api-reference#api-draft_world_worlds_specification_drafts_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorldDraftView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne picture this workspace keeps.`/worlds/web-pictures/{picture_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_web_picture_worlds_web_pictures__picture_id__get). ```json { "parameters": [ { "name": "picture_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Picture Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Read Web Picture Worlds Web Pictures Picture Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETEErase one picture this workspace keeps.`/worlds/web-pictures/{picture_id}`** Required permissions: deletion.write, world.write [Link to this operation](/docs/api-reference#api-erase_web_picture_worlds_web_pictures__picture_id__delete). ```json { "parameters": [ { "name": "picture_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Picture Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTMake a world of a kind and save it as yours.`/worlds/kinds/{kind}/worlds`** Make a world of kind with a preset and values, for a new identity, and save its entry. The town is made as POST /worlds/generated makes it, from its preset through the same gate and composer, so it is the same world. Every other kind is made by the site grammar from the kind the workspace holds or the product ships (the latest version unless one is named). An unknown kind or preset answers 404; a value the kind does not offer 422, naming the key, the value and the range; a title empty once trimmed 422; a land document the landform catalog refuses 422, naming its path (landform_*), and land asked with a support declaration, or of the town where the deployment makes no worlds on land (EXULANICA_WORLDS_ON_LAND), 422 landform_not_served; a kind none of whose candidates makes a world people can live in, for any identity drawn (on land: none whose layout the land can take; a town on land tries one identity), 409 with every refusal; a workspace already holding as many generated worlds as the count policy allows 409; a deployment whose database role cannot register a world 403 worlds_read_only. Nothing is written when any is refused. A world's receipt carries its kind's whole document, so a world of a kind the workspace keeps copies a person's document once more. A server whose deployment has not turned kinds from people on (EXULANICA_KINDS_FROM_PEOPLE) makes worlds of shipped kinds and the town only, and answers 403 kinds_from_people_not_offered for a kind the workspace keeps. Required permissions: world.write [Link to this operation](/docs/api-reference#api-create_kind_world_worlds_kinds__kind__worlds_post). ```json { "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "title": "Kind" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateKindWorldBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedWorldEntryView" } } } }, "409": { "description": "Refused by name; nothing was written." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA kind's draft: drafting, ready with the kept kind, or refused by name.`/worlds/kinds/drafts/{draft_id}`** The requester's retained draft, including after another process takes over. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_kind_draft_worlds_kinds_drafts__draft_id__get). ```json { "parameters": [ { "name": "draft_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Draft Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KindDraftView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETERemove Kept Kind`/worlds/kinds/versions/{document_sha256}`** Required permissions: deletion.write, world.write [Link to this operation](/docs/api-reference#api-remove_kept_kind_worlds_kinds_versions__document_sha256__delete). ```json { "parameters": [ { "name": "document_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Document Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCancel Reference`/worlds/references/{reference_id}/cancel`** Stop a request: a queued one at once, a running one at its next step. A finished one is answered as it stands. Required permissions: model.invoke, references.request, world.write [Link to this operation](/docs/api-reference#api-cancel_reference_worlds_references__reference_id__cancel_post). ```json { "parameters": [ { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Reference Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Reference Pictures`/worlds/references/{reference_id}/pictures`** The pictures a picture search found, for its requester only, while this process holds them: each its address, its website and its words, for the page to show from the website. Never stored, so never cached either. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_reference_pictures_worlds_references__reference_id__pictures_get). ```json { "parameters": [ { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Reference Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA showcase world's card picture, while the digest named is its own.`/worlds/showcase/{showcase}/picture`** The card picture's bytes, while sha256 is their digest: the address names the bytes, so a browser keeps them as long as it likes. Required permissions: world.read [Link to this operation](/docs/api-reference#api-showcase_picture_worlds_showcase__showcase__picture_get). ```json { "parameters": [ { "name": "showcase", "in": "path", "required": true, "schema": { "type": "string", "title": "Showcase" } }, { "name": "sha256", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "No showcase world of that key, or no picture of that digest" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe kept bytes of one picture this workspace keeps.`/worlds/web-pictures/{picture_id}/bytes`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_web_picture_bytes_worlds_web_pictures__picture_id__bytes_get). ```json { "parameters": [ { "name": "picture_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Picture Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Read Web Picture Bytes Worlds Web Pictures Picture Id Bytes Get" } }, "image/jpeg": {}, "image/png": {}, "image/webp": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETArrival Scene Geometry`/world-entries/{entry_id}/arrival/scene-geometry/{artifact_id}`** Serve only the trained artifact of this entry's currently authorized v4 build. Required permissions: world.read [Link to this operation](/docs/api-reference#api-arrival_scene_geometry_world_entries__entry_id__arrival_scene_geometry__artifact_id__get). ```json { "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Entry Id" } }, { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Artifact Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETKind Removal Preview`/worlds/kinds/versions/{document_sha256}/removal`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-kind_removal_preview_worlds_kinds_versions__document_sha256__removal_get). ```json { "parameters": [ { "name": "document_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Document Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTKeep Reference Picture`/worlds/references/{reference_id}/pictures/{n}/keep`** Keep the picture a search found at position n, with the person's answer: fetched once, written again with no metadata, and kept apart from their own photographs. Only the request's requester keeps one, while this process holds the search's pictures. Required permissions: references.request, world.write [Link to this operation](/docs/api-reference#api-keep_reference_picture_worlds_references__reference_id__pictures__n__keep_post). ```json { "parameters": [ { "name": "reference_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Reference Id" } }, { "name": "n", "in": "path", "required": true, "schema": { "type": "integer", "maximum": 7, "minimum": 0, "title": "N" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. ## Assets and Imports Admit content, style packs, and photographs, and prepare them for a world. **GETThe same, addressed by permalink rather than by row id.`/evidence`** Resolve an exulanica:// permalink. The permalink is designed to stay valid forever and to parse back to an address with the same digest, which is what lets an archived answer's citation still open. It names a blob directly, so the workspace check cannot come from the row id and has to be made explicitly: a span with this digest must exist in the caller's workspace. Without that, a permalink would be a way to read any blob in the database by naming its hash. Required permissions: library.read [Link to this operation](/docs/api-reference#api-by_uri_evidence_get). ```json { "parameters": [ { "name": "uri", "in": "query", "required": true, "schema": { "type": "string", "title": "Uri" } }, { "name": "range", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Range" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWatched intakes in this workspace, newest first.`/formation`** What there is to watch. Finished batches are listed as well as running ones, because a client that arrived after an ingest finished should still be able to read what happened rather than find nothing and conclude the upload was lost. The stream of a finished batch replays its history and ends, which is the same code path a live subscriber takes. Required permissions: library.read [Link to this operation](/docs/api-reference#api-batches_formation_get). ```json { "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchRow" }, "title": "Response Batches Formation Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhich captures have reconstructed geometry, and the digest of each.`/geometry`** The descriptor list, in the presentation order point_map_descriptors documents. Keyed by capture. An island is a client decision (ADR-0005) and the graph payload ships no island id, so this ships none either: the client puts capture ids through the same islandOf its occurrences went through, and geometry lands in the same regions the anchors did. A server that grouped them here would be answering a question it was deliberately kept out of. Required permissions: library.read [Link to this operation](/docs/api-reference#api-geometry_geometry_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeometryView" }, "title": "Response Geometry Geometry Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe entity graph, as one snapshot at one state version.`/graph`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-snapshot_graph_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphPayload" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTUpload photographs. Intake runs now; the model stages are queued.`/intake`** Read the upload's body, then admit its photographs. The route declares no form parameter, so the framework reads none of the body before the app's dependencies have authenticated the caller and claimed the workspace's upload share; and it opens its connection only once the body is in, so none is held while it arrives. Required permissions: intake.write [Link to this operation](/docs/api-reference#api-intake_intake_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "files" ], "properties": { "files": { "type": "array", "items": { "type": "string", "contentMediaType": "application/octet-stream" }, "title": "Files", "description": "The photographs to ingest." } } } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntakeAccepted" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTNew Subject`/person-subjects`** Create somebody a decision can be about, named or not. Required permissions: consent.write [Link to this operation](/docs/api-reference#api-new_subject_person_subjects_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSubject" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response New Subject Person Subjects Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAdmit Personal`/personal-admission`** Record receipts for the exact captures returned by upload, then queue observation. Required permissions: admission.write [Link to this operation](/docs/api-reference#api-admit_personal_personal_admission_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalBatch" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admit Personal Personal Admission Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETPersonal Status`/personal-admission`** Required permissions: admission.read [Link to this operation](/docs/api-reference#api-personal_status_personal_admission_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Personal Status Personal Admission Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETEvery place whose name has a decision, and each use.`/place-name-rights`** Required permissions: consent.read [Link to this operation](/docs/api-reference#api-every_place_place_name_rights_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Every Place Place Name Rights Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETList Tiles`/tiles`** Required permissions: tiles.materialise [Link to this operation](/docs/api-reference#api-list_tiles_tiles_get). ```json { "parameters": [ { "name": "city_seed", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "City Seed" } }, { "name": "lod", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 64, "minimum": 0 }, { "type": "null" } ], "title": "Lod" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAdmit Workspace Asset`/workspace-assets`** Required permissions: admission.write [Link to this operation](/docs/api-reference#api-admit_workspace_asset_workspace_assets_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "declaration", "content" ], "properties": { "declaration": { "type": "string", "maxLength": 65536, "title": "Declaration" }, "content": { "type": "string", "contentMediaType": "application/octet-stream", "title": "Content" } } } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETList Workspace Assets`/workspace-assets`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-list_workspace_assets_workspace_assets_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAdmit Workspace Style Pack`/workspace-style-packs`** Required permissions: admission.write [Link to this operation](/docs/api-reference#api-admit_workspace_style_pack_workspace_style_packs_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "declaration", "manifest" ], "properties": { "declaration": { "type": "string", "maxLength": 65536 }, "manifest": { "type": "string", "maxLength": 262144 } }, "additionalProperties": { "type": "string", "contentMediaType": "application/octet-stream" } } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThis workspace's own style pack versions and their checks.`/workspace-style-packs`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-list_workspace_style_packs_workspace_style_packs_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRegister Derived Asset`/environment-resources/assets`** Register derived bytes against an admitted source, so a feature index can name them. The admission stays authoritative. A withdrawn source, or one whose rights do not permit what the derivation declares, refuses here exactly as it refuses everywhere else, and the derived row can never widen its source's rights. Required permissions: admission.write [Link to this operation](/docs/api-reference#api-register_derived_asset_environment_resources_assets_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DerivedEnvironmentAsset" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTDeclare Place`/environment-resources/places`** Create a place whose frame a provider documented, so a source can be admitted to it. The frame this records is **declared, never measured**: the response says so in frame_authority and the receipt repeats it, because a reader that could not tell a declaration from a recovered frame would be told a measurement had been made where none was. Creating a place grants no right to any source; rights are resolved per admission. Required permissions: admission.write [Link to this operation](/docs/api-reference#api-declare_place_environment_resources_places_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclaredPlaceFrame" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAdmit Source`/environment-resources/sources`** Required permissions: admission.write [Link to this operation](/docs/api-reference#api-admit_source_environment_resources_sources_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceAdmission" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe original media a citation resolves to.`/evidence/{span_id}`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-original_evidence__span_id__get). ```json { "parameters": [ { "name": "span_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Span Id" } }, { "name": "range", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Range" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETFormation progress for one intake batch, as it happens.`/formation/{batch_id}`** Subscribe to a batch. Two ways to resume, and both exist for a reason. Last-Event-ID is what a browser's own EventSource sends on an automatic reconnect and the client never has to think about it. since is for a client that reconnects deliberately, having held its own token across a view change or a reload, which an EventSource cannot do because it is a new object with no memory. The header wins when both are present. A browser sends it only when it genuinely has an event to resume from, so it is the more recent of the two by construction. Required permissions: library.read [Link to this operation](/docs/api-reference#api-stream_formation__batch_id__get). ```json { "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Batch Id" } }, { "name": "since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Since" } }, { "name": "last-event-id", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last-Event-Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe bytes of one reconstructed point map. Never a citation target.`/geometry/{artifact_id}`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-point_map_geometry__artifact_id__get). ```json { "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Artifact Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} }, "application/vnd.exulanica.point-map": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETLive admitted photographs for review before reconstruction.`/graph/sources`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-sources_graph_sources_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewSourceRow" }, "title": "Response Sources Graph Sources Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTThis occurrence is that person.`/identity/confirm`** Required permissions: library.write [Link to this operation](/docs/api-reference#api-confirm_identity_confirm_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Confirm Identity Confirm Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhat has been decided, most recent first.`/identity/events`** The identity ledger, which is what makes undo exact rather than approximate. Required permissions: library.read [Link to this operation](/docs/api-reference#api-events_identity_events_get). ```json { "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response Events Identity Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTTwo records of one person become one.`/identity/merge`** Required permissions: library.write [Link to this operation](/docs/api-reference#api-merge_identity_merge_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTThe account holder says who somebody is.`/identity/name`** Required permissions: library.write [Link to this operation](/docs/api-reference#api-name_identity_name_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NameRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamedView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTNo, that is not them. Remembered against the evidence.`/identity/reject`** Required permissions: library.write [Link to this operation](/docs/api-reference#api-reject_identity_reject_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Reject Identity Reject Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTThe account holder corrects a name they gave.`/identity/rename`** One transaction, two writes, and the second one is not optional. Migration 0006 makes name_is supersede, so the new claim retires the old one inside the insert, and 0002's cache trigger nulls entity.display_name on that retirement because the replacement row does not exist yet. rename_entity writes the cache back in the same transaction; a caller that wrote only the assertion would leave the person unnamed. Required permissions: library.write [Link to this operation](/docs/api-reference#api-rename_identity_rename_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Rename Identity Rename Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWithdraw a confirmed link.`/identity/revoke`** Required permissions: deletion.write [Link to this operation](/docs/api-reference#api-revoke_identity_revoke_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTThese occurrences are somebody else.`/identity/split`** Required permissions: library.write [Link to this operation](/docs/api-reference#api-split_identity_split_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTReverse one identity decision, from what its event recorded.`/identity/undo`** Required permissions: library.write [Link to this operation](/docs/api-reference#api-undo_decision_identity_undo_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UndoRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETLibrary`/materials/library`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-library_materials_library_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETMakers`/materials/makers`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-makers_materials_makers_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETList Recipes`/materials/recipes`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-list_recipes_materials_recipes_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCreate Recipe`/materials/recipes`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-create_recipe_materials_recipes_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipeBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWho is in this photograph, and their state.`/person-regions/{capture_id}`** Required permissions: consent.read [Link to this operation](/docs/api-reference#api-regions_person_regions__capture_id__get). ```json { "parameters": [ { "name": "capture_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Capture Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Regions Person Regions Capture Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhere one place's name may go, and why not.`/place-name-rights/{entity_id}`** Required permissions: consent.read [Link to this operation](/docs/api-reference#api-one_place_place_name_rights__entity_id__get). ```json { "parameters": [ { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Entity Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response One Place Place Name Rights Entity Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETExact trained scene bytes, never a citation target.`/scene-geometry/{artifact_id}`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-trained_scene_scene_geometry__artifact_id__get). ```json { "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Artifact Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe entities lifted into one scene, as voxels, under the geometry read policy.`/scene-segments/{scene_id}`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-scene_segments_scene_segments__scene_id__get). ```json { "parameters": [ { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Scene Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SceneSegmentsView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe vehicles driving a stored generated city's streets, second by second, to draw.`/tiles/traffic`** Required permissions: tiles.materialise [Link to this operation](/docs/api-reference#api-tile_traffic_tiles_traffic_get). ```json { "parameters": [ { "name": "world_seed", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "World Seed" } }, { "name": "from_second", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "From Second" } }, { "name": "seconds", "in": "query", "required": false, "schema": { "type": "integer", "default": 60, "title": "Seconds" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Workspace Asset`/workspace-assets/{asset_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_workspace_asset_workspace_assets__asset_id__get). ```json { "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne version of a workspace style pack, and its check.`/workspace-style-packs/{manifest_sha256}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_workspace_style_pack_workspace_style_packs__manifest_sha256__get). ```json { "parameters": [ { "name": "manifest_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Manifest Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe reviewed assets a person may place as objects, with real byte availability and what inhabitants do with each.`/world/assets`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-reviewed_asset_catalog_world_assets_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaceableAssetView" }, "title": "Response Reviewed Asset Catalog World Assets Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe character catalogs this host serves: each publication's identity and state.`/world/character-catalogs`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-character_catalogs_world_character_catalogs_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Character Catalogs World Character Catalogs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETPaintings`/world/paintings`** The world's paintings, newest first, without their bytes. Required permissions: world.read [Link to this operation](/docs/api-reference#api-paintings_world_paintings_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Paintings World Paintings Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAsk For Pieces`/world/piece-requests`** Ask for new pieces of a world's look for some thing kinds. Answers 202 with the requests and their estimate; an idempotency key, or an ask already waiting, answers 200. Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-ask_for_pieces_world_piece_requests_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PieceAskBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETList Piece Requests`/world/piece-requests`** A world's piece requests, newest first, and whether the piece maker is running. Required permissions: world.read [Link to this operation](/docs/api-reference#api-list_piece_requests_world_piece_requests_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETProtected topology source slots with honest availability states.`/world/source-media`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-source_media_world_source_media_get). ```json { "parameters": [ { "name": "topology_digest", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ], "title": "Topology Digest" } }, { "name": "source_snapshot_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Source Snapshot Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SourceMediaView" }, "title": "Response Source Media World Source Media Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe committed style packs this host serves: each pack's identity, licence and origin.`/world/style-packs`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-style_packs_world_style_packs_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Style Packs World Style Packs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETMetadata`/environment-resources/{kind}/{resource_id}`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-metadata_environment_resources__kind___resource_id__get). ```json { "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "enum": [ "source", "asset" ], "type": "string", "title": "Kind" } }, { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "operation", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/EnvironmentOperation" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETDeclared Place`/environment-resources/places/{place_id}`** What a place declared about its frame, for a reader holding only its identifier. Registered before the {kind}/{resource_id} reads below, so places resolves here rather than as a resource kind. A caller that reached a place through a Selection row or a composed instance can ask this what kind of frame it has, which is the only way the declared-never-measured distinction survives past the request that created the place. Required permissions: library.read [Link to this operation](/docs/api-reference#api-declared_place_environment_resources_places__place_id__get). ```json { "parameters": [ { "name": "place_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Place Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe photograph with every unconsented person filled neutral.`/evidence/{span_id}/masked`** The derivative a viewer may see, never the original bytes behind it. A sibling of the route above rather than a change to it, and the distinction is not cosmetic. GET /evidence/{span_id} resolves the exact bytes a citation names, and those bytes are inside the span digest: serving something else there would break every archived citation that verifies against it. So the original endpoint keeps its meaning and this one exists for the world, which shows photographs to people rather than resolving citations. **Refuses rather than falling back.** When the photograph contains somebody who has not consented and no masked derivative exists, this returns 409 and no bytes. Serving the original would show exactly the person the derivative exists to hide, on the one path a viewer actually looks at, and it would do it precisely when something upstream had already gone wrong. Required permissions: library.read [Link to this operation](/docs/api-reference#api-masked_evidence__span_id__masked_get). ```json { "parameters": [ { "name": "span_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Span Id" } }, { "name": "view_scene", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "View Scene" } }, { "name": "view_capture", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "View Capture" } }, { "name": "view_binding", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "View Binding" } }, { "name": "range", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Range" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe region of the original this span names, as PNG.`/evidence/{span_id}/region`** A crop, for showing what a citation points at inside a photograph. Not what the citation resolves to. The address names the original bytes and a region within them; this renders that region so an interface can draw it, and a caller wanting the evidence itself asks for the endpoint above. Required permissions: library.read [Link to this operation](/docs/api-reference#api-region_evidence__span_id__region_get). ```json { "parameters": [ { "name": "span_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Span Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTLink Subject Regions`/identity/subjects/link`** Confirm that regions across photographs show one person, creating one subject if needed. Required permissions: consent.write [Link to this operation](/docs/api-reference#api-link_subject_regions_identity_subjects_link_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkSubject" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Link Subject Regions Identity Subjects Link Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTUnlink Subject Regions`/identity/subjects/unlink`** Withdraw region-to-subject links, retaining every earlier edit and consent receipt. Required permissions: consent.write [Link to this operation](/docs/api-reference#api-unlink_subject_regions_identity_subjects_unlink_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlinkSubject" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Unlink Subject Regions Identity Subjects Unlink Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Recipe`/materials/recipes/{recipe_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_recipe_materials_recipes__recipe_id__get). ```json { "parameters": [ { "name": "recipe_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Recipe Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTEdit Regions`/person-regions/{capture_id}/edits`** Confirm, correct or delete proposed regions. Each edit is its own receipt. Required permissions: consent.write [Link to this operation](/docs/api-reference#api-edit_regions_person_regions__capture_id__edits_post). ```json { "parameters": [ { "name": "capture_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Capture Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegionEdits" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Edit Regions Person Regions Capture Id Edits Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAdd Consent`/person-subjects/{subject_id}/consents`** Record one consent transition, as the account holder and never as the subject. Required permissions: consent.write [Link to this operation](/docs/api-reference#api-add_consent_person_subjects__subject_id__consents_post). ```json { "parameters": [ { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentDecision" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Consent Person Subjects Subject Id Consents Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAllow`/place-name-rights/{entity_id}/grants`** Allow this place's name to go to every model of one use, against the notice shown. Required permissions: consent.write [Link to this operation](/docs/api-reference#api-allow_place_name_rights__entity_id__grants_post). ```json { "parameters": [ { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Entity Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceNameAllowRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Allow Place Name Rights Entity Id Grants Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStop`/place-name-rights/{entity_id}/withdrawals`** Stop this place's name going to any model of one use, from the next request on. Required permissions: consent.write [Link to this operation](/docs/api-reference#api-stop_place_name_rights__entity_id__withdrawals_post). ```json { "parameters": [ { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Entity Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceNameStopRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Stop Place Name Rights Entity Id Withdrawals Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Tile Bytes`/tiles/{baked_tile_id}/bytes`** Required permissions: tiles.materialise [Link to this operation](/docs/api-reference#api-read_tile_bytes_tiles__baked_tile_id__bytes_get). ```json { "parameters": [ { "name": "baked_tile_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Baked Tile Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRequest Workspace Preparation`/workspace-assets/{asset_id}/preparation`** Required permissions: admission.write [Link to this operation](/docs/api-reference#api-request_workspace_preparation_workspace_assets__asset_id__preparation_post). ```json { "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWithdraw Workspace Asset`/workspace-assets/{asset_id}/withdraw`** Required permissions: admission.write [Link to this operation](/docs/api-reference#api-withdraw_workspace_asset_workspace_assets__asset_id__withdraw_post). ```json { "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA ready workspace style pack version as one uncompressed tar archive.`/workspace-style-packs/{manifest_sha256}/archive`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_workspace_style_pack_archive_workspace_style_packs__manifest_sha256__archive_get). ```json { "parameters": [ { "name": "manifest_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Manifest Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} }, "application/x-tar": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAsk for a ready version of your own style pack to join the shared library.`/workspace-style-packs/{manifest_sha256}/publish-request`** Required permissions: admission.write [Link to this operation](/docs/api-reference#api-request_workspace_style_pack_publication_workspace_style_packs__manifest_sha256__publish_request_post). ```json { "parameters": [ { "name": "manifest_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Manifest Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWithdraw a version of a workspace style pack for good.`/workspace-style-packs/{manifest_sha256}/withdraw`** Required permissions: admission.write [Link to this operation](/docs/api-reference#api-withdraw_workspace_style_pack_workspace_style_packs__manifest_sha256__withdraw_post). ```json { "parameters": [ { "name": "manifest_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Manifest Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne reviewed asset of any kind, whether it may be placed and whether its bytes exist.`/world/assets/{asset_key}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-reviewed_asset_world_assets__asset_key__get). ```json { "parameters": [ { "name": "asset_key", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Asset Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceableAssetView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne published character catalog, as the canonical document its digest names.`/world/character-catalogs/{catalog_sha256}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-character_catalog_world_character_catalogs__catalog_sha256__get). ```json { "parameters": [ { "name": "catalog_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Catalog Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Character Catalog World Character Catalogs Catalog Sha256 Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETPainting`/world/paintings/{sha256}`** A kept painting's bytes in the world, by its digest. Required permissions: world.read [Link to this operation](/docs/api-reference#api-painting_world_paintings__sha256__get). ```json { "parameters": [ { "name": "sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Sha256" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Piece Request`/world/piece-requests/{piece_request_id}`** One piece request and where it stands. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_piece_request_world_piece_requests__piece_request_id__get). ```json { "parameters": [ { "name": "piece_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Piece Request Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETECancel Piece Request`/world/piece-requests/{piece_request_id}`** Cancel a request no session has taken. One taken or ended is answered 409 with its state. Required permissions: world.write [Link to this operation](/docs/api-reference#api-cancel_piece_request_world_piece_requests__piece_request_id__delete). ```json { "parameters": [ { "name": "piece_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Piece Request Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRequire one authorised source slot to have available local evidence bytes.`/world/source-media/{source_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-require_source_media_world_source_media__source_id__get). ```json { "parameters": [ { "name": "source_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Source Id" } }, { "name": "topology_digest", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ], "title": "Topology Digest" } }, { "name": "source_snapshot_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Source Snapshot Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceMediaView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne style pack manifest or listed file, as the bytes its SHA-256 names.`/world/style-packs/{content_sha256}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-style_pack_content_world_style_packs__content_sha256__get). ```json { "parameters": [ { "name": "content_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Content Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Style Pack Content World Style Packs Content Sha256 Get" } }, "model/gltf-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETResource Bytes`/environment-resources/{kind}/{resource_id}/bytes`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-resource_bytes_environment_resources__kind___resource_id__bytes_get). ```json { "parameters": [ { "name": "kind", "in": "path", "required": true, "schema": { "enum": [ "source", "asset" ], "type": "string", "title": "Kind" } }, { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } }, { "name": "operation", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/EnvironmentOperation" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPublish Feature Index`/environment-resources/sources/{admission_id}/feature-indexes`** Required permissions: admission.write [Link to this operation](/docs/api-reference#api-publish_feature_index_environment_resources_sources__admission_id__feature_indexes_post). ```json { "parameters": [ { "name": "admission_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Admission Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureIndexPublication" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETFeatures`/environment-resources/sources/{admission_id}/features`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-features_environment_resources_sources__admission_id__features_get). ```json { "parameters": [ { "name": "admission_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Admission Id" } }, { "name": "feature_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ], "title": "Feature Id" } }, { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EnvironmentFeatureKind" }, { "type": "null" } ], "title": "Kind" } }, { "name": "bbox", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "integer" }, "minItems": 4, "maxItems": 6 }, { "type": "null" } ], "title": "Bbox" } }, { "name": "label", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 512 }, { "type": "null" } ], "title": "Label" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRequest Bake`/materials/recipes/{recipe_id}/bake`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-request_bake_materials_recipes__recipe_id__bake_post). ```json { "parameters": [ { "name": "recipe_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Recipe Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Bake`/materials/recipes/{recipe_id}/bake`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_bake_materials_recipes__recipe_id__bake_get). ```json { "parameters": [ { "name": "recipe_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Recipe Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWithdraw Recipe`/materials/recipes/{recipe_id}/withdraw`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-withdraw_recipe_materials_recipes__recipe_id__withdraw_post). ```json { "parameters": [ { "name": "recipe_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Recipe Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWithdraw Right`/personal-admission/model-rights/{right_id}/withdraw`** End a model right now, and answer with that right. Final, and idempotent: a second withdrawal of the same right changes nothing. Another workspace's right is answered exactly as an id nobody granted. A picture's reading right is stopped only by the person who granted it or an owner of the workspace; anyone else is answered as for an id nobody granted. Stopping it ends, in this one transaction, every reading right not yet withdrawn that its grantor holds on that picture, so nothing more of it is sent whichever of them a request would have used; stopping it again ends only those granted at or before its own stop, never a consent given since. Required permissions: admission.write [Link to this operation](/docs/api-reference#api-withdraw_right_personal_admission_model_rights__right_id__withdraw_post). ```json { "parameters": [ { "name": "right_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Right Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Withdraw Right Personal Admission Model Rights Right Id Withdraw Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCancel Workspace Preparation`/workspace-assets/{asset_id}/preparation/cancel`** Required permissions: admission.write [Link to this operation](/docs/api-reference#api-cancel_workspace_preparation_workspace_assets__asset_id__preparation_cancel_post). ```json { "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Workspace Asset Prepared Bytes`/workspace-assets/{asset_id}/prepared/bytes`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_workspace_asset_prepared_bytes_workspace_assets__asset_id__prepared_bytes_get). ```json { "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Asset Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} }, "model/gltf-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne file of a ready workspace style pack version, after the final read check.`/workspace-style-packs/{manifest_sha256}/files/{content_sha256}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_workspace_style_pack_file_workspace_style_packs__manifest_sha256__files__content_sha256__get). ```json { "parameters": [ { "name": "manifest_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Manifest Sha256" } }, { "name": "content_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Content Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} }, "model/gltf-binary": {}, "image/png": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe reviewed geometry itself. Never a citation target and never evidence.`/world/assets/{asset_key}/bytes`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-reviewed_asset_bytes_world_assets__asset_key__bytes_get). ```json { "parameters": [ { "name": "asset_key", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Asset Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} }, "model/gltf-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe licence text the reviewed bytes are published under.`/world/assets/{asset_key}/licence`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-reviewed_asset_licence_world_assets__asset_key__licence_get). ```json { "parameters": [ { "name": "asset_key", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Asset Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} }, "text/plain": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTTake Back Pieces`/world/piece-requests/{piece_request_id}/take-back`** Ask for a request's pieces to leave its world's look. Answers 202 with the request; one whose pieces its world never took in is answered 409 with where it stands. Required permissions: world.write [Link to this operation](/docs/api-reference#api-take_back_pieces_world_piece_requests__piece_request_id__take_back_post). ```json { "parameters": [ { "name": "piece_request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Piece Request Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Bake Bytes`/materials/recipes/{recipe_id}/bake/bytes`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_bake_bytes_materials_recipes__recipe_id__bake_bytes_get). ```json { "parameters": [ { "name": "recipe_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Recipe Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead`/world/versions/{version_id}/characters/{subject_kind}/{subject_id}/appearance`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_world_versions__version_id__characters__subject_kind___subject_id__appearance_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_kind", "in": "path", "required": true, "schema": { "enum": [ "avatar", "synthetic-inhabitant" ], "type": "string", "title": "Subject Kind" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "society_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Society Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Read World Versions Version Id Characters Subject Kind Subject Id Appearance Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **PUTSave`/world/versions/{version_id}/characters/{subject_kind}/{subject_id}/appearance`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-save_world_versions__version_id__characters__subject_kind___subject_id__appearance_put). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_kind", "in": "path", "required": true, "schema": { "enum": [ "avatar", "synthetic-inhabitant" ], "type": "string", "title": "Subject Kind" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "society_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Society Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Save World Versions Version Id Characters Subject Kind Subject Id Appearance Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETFamilies`/world/versions/{version_id}/characters/{subject_kind}/{subject_id}/appearance/families`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-families_world_versions__version_id__characters__subject_kind___subject_id__appearance_families_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_kind", "in": "path", "required": true, "schema": { "enum": [ "avatar", "synthetic-inhabitant" ], "type": "string", "title": "Subject Kind" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "society_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Society Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Families World Versions Version Id Characters Subject Kind Subject Id Appearance Families Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETHistory`/world/versions/{version_id}/characters/{subject_kind}/{subject_id}/appearance/history`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-history_world_versions__version_id__characters__subject_kind___subject_id__appearance_history_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_kind", "in": "path", "required": true, "schema": { "enum": [ "avatar", "synthetic-inhabitant" ], "type": "string", "title": "Subject Kind" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "society_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Society Id" } }, { "name": "before_revision", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Before Revision" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response History World Versions Version Id Characters Subject Kind Subject Id Appearance History Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPrepare a body for a recipe over a parametric family, or answer the one prepared.`/world/versions/{version_id}/characters/{subject_kind}/{subject_id}/appearance/preparations`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-request_preparation_world_versions__version_id__characters__subject_kind___subject_id__appearance_preparations_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_kind", "in": "path", "required": true, "schema": { "enum": [ "avatar", "synthetic-inhabitant" ], "type": "string", "title": "Subject Kind" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "society_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Society Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreparationBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Request Preparation World Versions Version Id Characters Subject Kind Subject Id Appearance Preparations Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTReset`/world/versions/{version_id}/characters/{subject_kind}/{subject_id}/appearance/reset`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-reset_world_versions__version_id__characters__subject_kind___subject_id__appearance_reset_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_kind", "in": "path", "required": true, "schema": { "enum": [ "avatar", "synthetic-inhabitant" ], "type": "string", "title": "Subject Kind" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "society_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Society Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Reset World Versions Version Id Characters Subject Kind Subject Id Appearance Reset Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne character body preparation: its state, its body once prepared, or its failure.`/world/versions/{version_id}/characters/{subject_kind}/{subject_id}/appearance/preparations/{preparation_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_preparation_world_versions__version_id__characters__subject_kind___subject_id__appearance_preparations__preparation_id__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_kind", "in": "path", "required": true, "schema": { "enum": [ "avatar", "synthetic-inhabitant" ], "type": "string", "title": "Subject Kind" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "preparation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Preparation Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "society_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Society Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Read Preparation World Versions Version Id Characters Subject Kind Subject Id Appearance Preparations Preparation Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA prepared character body's bytes, while the family it was prepared over is served.`/world/versions/{version_id}/characters/{subject_kind}/{subject_id}/appearance/preparations/{preparation_id}/bytes`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_preparation_bytes_world_versions__version_id__characters__subject_kind___subject_id__appearance_preparations__preparation_id__bytes_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_kind", "in": "path", "required": true, "schema": { "enum": [ "avatar", "synthetic-inhabitant" ], "type": "string", "title": "Subject Kind" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "preparation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Preparation Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "society_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Society Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Read Preparation Bytes World Versions Version Id Characters Subject Kind Subject Id Appearance Preparations Preparation Id Bytes Get" } }, "model/gltf-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStop a character body preparation that has not finished.`/world/versions/{version_id}/characters/{subject_kind}/{subject_id}/appearance/preparations/{preparation_id}/cancel`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-cancel_preparation_world_versions__version_id__characters__subject_kind___subject_id__appearance_preparations__preparation_id__cancel_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_kind", "in": "path", "required": true, "schema": { "enum": [ "avatar", "synthetic-inhabitant" ], "type": "string", "title": "Subject Kind" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "preparation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Preparation Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "society_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Society Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Cancel Preparation World Versions Version Id Characters Subject Kind Subject Id Appearance Preparations Preparation Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. ## World Structure Read a version, discover supported capabilities, and edit objects or appearance. - [Read a Version](/docs/world-api/version): GET /world/versions/{version_id}. Read a world version and its authored state. Retain state_sha256 before editing; it identifies the state your change is based on. - [Read Capabilities](/docs/world-api/capabilities): GET /world/versions/{version_id}/capabilities. Discover this version’s regions and supported operations. Descriptors report prerequisites, permission, availability, and reasons an operation cannot run. Use their choices instead of assuming every world supports every edit. - [Read Society State](/docs/world-api/society): GET /world/versions/{version_id}/society. Read the society attached to this version, including its current state and the places its inhabitants can visit. - [Place an Object](/docs/world-api/objects): POST /world/versions/{version_id}/objects. Place a catalog asset in an authored world. Supply the current state digest, a unique object ID, a supported region, and an asset digest from the catalog. **GETRead a Version`/world/versions/{version_id}`** Read a world version and its authored state. Retain state_sha256 before editing; it identifies the state your change is based on. Required permissions: world.read [Link to this operation](/docs/api-reference#api-alternate_version_world_versions__version_id__get). [Request examples and fields](/docs/world-api/version). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Capabilities`/world/versions/{version_id}/capabilities`** Discover this version’s regions and supported operations. Descriptors report prerequisites, permission, availability, and reasons an operation cannot run. Use their choices instead of assuming every world supports every edit. Required permissions: world.read [Link to this operation](/docs/api-reference#api-version_capabilities_world_versions__version_id__capabilities_get). [Request examples and fields](/docs/world-api/capabilities). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Version Capabilities World Versions Version Id Capabilities Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPlace an Object`/world/versions/{version_id}/objects`** Place a catalog asset in an authored world. Supply the current state digest, a unique object ID, a supported region, and an asset digest from the catalog. Required permissions: world.write [Link to this operation](/docs/api-reference#api-add_authored_object_world_versions__version_id__objects_post). [Request examples and fields](/docs/world-api/objects). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddObjectBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTDraft Creature`/things/creatures`** Ask for a creature from the person's words; answers 202 with its draft at once. Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-draft_creature_things_creatures_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatureBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETEvery thing kind this workspace holds, newest first.`/things/kinds`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-held_kinds_things_kinds_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Held Kinds Things Kinds Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe shipped thing library: every kind, look and look container, by digest.`/things/library`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-thing_library_listing_things_library_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Thing Library Listing Things Library Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe published arrangements a preview or apply may name, with their words.`/world/arrangements`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-arrangement_catalog_route_world_arrangements_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrangementCatalogView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe reviewed behaviours an object may be given, with each parameter's bounds.`/world/behaviours`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-reviewed_behaviours_world_behaviours_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewedBehaviourView" }, "title": "Response Reviewed Behaviours World Behaviours Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **PUTPut Portrait`/world/portraits`** Keep a look's portrait in the world, unless one is kept already. A look is named by its digest, not owned: any look may have a portrait in a world the caller holds. Required permissions: world.write [Link to this operation](/docs/api-reference#api-put_portrait_world_portraits_put). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "look_sha256", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Look Sha256" } }, { "name": "recipe", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 56, "title": "Recipe" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "image/jpeg": { "schema": { "type": "string", "contentMediaType": "image/jpeg" } }, "image/webp": { "schema": { "type": "string", "contentMediaType": "image/webp" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Put Portrait World Portraits Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETPortraits`/world/portraits`** For each look asked (comma separated digests), its kept portrait by the recipe, or null. Required permissions: world.write [Link to this operation](/docs/api-reference#api-portraits_world_portraits_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "looks", "in": "query", "required": true, "schema": { "type": "string", "minLength": 64, "maxLength": 4160, "title": "Looks" } }, { "name": "recipe", "in": "query", "required": false, "schema": { "type": "string", "minLength": 4, "maxLength": 56, "default": "portrait/v1", "title": "Recipe" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Portraits World Portraits Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThis world's projects the caller owns or that are shared with them.`/world/projects`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-list_projects_world_projects_get). ```json { "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectView" }, "title": "Response List Projects World Projects Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStart a project bound to a version of this world. An exact retry of a key is 200.`/world/projects`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-create_project_world_projects_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETEvery alternate world version in this workspace, newest first.`/world/versions`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-alternate_versions_world_versions_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlternateVersionView" }, "title": "Response Alternate Versions World Versions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCreate an alternate version from a source snapshot or from another version.`/world/versions`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-create_alternate_version_world_versions_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVersionBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchedVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETList Creature Drafts`/things/creatures/drafts`** The requester's own drafts, newest first: a reload or a second tab finds one still running. Required permissions: world.read [Link to this operation](/docs/api-reference#api-list_creature_drafts_things_creatures_drafts_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETCreature Offer`/things/creatures/offered`** Whether this workspace may ask for a creature here, why not by code, how long a draft usually takes by the creature drafter's measured calls, and every code a draft may end with. Required permissions: world.read [Link to this operation](/docs/api-reference#api-creature_offer_things_creatures_offered_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA thing kind this workspace holds, by the SHA-256 of its document.`/things/kinds/{kind_sha256}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-held_kind_things_kinds__kind_sha256__get). ```json { "parameters": [ { "name": "kind_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Kind Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Held Kind Things Kinds Kind Sha256 Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETEErase a creature this workspace drafted, whole, by the SHA-256 of its kind.`/things/kinds/{kind_sha256}`** Required permissions: deletion.write, world.write [Link to this operation](/docs/api-reference#api-erase_kind_things_kinds__kind_sha256__delete). ```json { "parameters": [ { "name": "kind_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Kind Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne thing kind, look, the body plans catalog or a look's container, by its SHA-256.`/things/library/{content_sha256}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-thing_library_content_things_library__content_sha256__get). ```json { "parameters": [ { "name": "content_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Content Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Thing Library Content Things Library Content Sha256 Get" } }, "model/gltf-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA look this workspace holds, by the SHA-256 of its document.`/things/looks/{look_sha256}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-held_look_things_looks__look_sha256__get). ```json { "parameters": [ { "name": "look_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Look Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Held Look Things Looks Look Sha256 Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA body plan this workspace holds, by the SHA-256 of its document.`/things/plans/{plan_sha256}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-held_plan_things_plans__plan_sha256__get). ```json { "parameters": [ { "name": "plan_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Plan Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Held Plan Things Plans Plan Sha256 Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhat a generative world model may condition on for one place at one time.`/world-read/places/{place_id}`** A place and a time, resolved to the version in force then. Four answers, and the reason they are four rather than two is that a caller can act on each. * **404** for a place that does not exist and for another workspace's, indistinguishable, for the same M10 reason the scene address gives. * **424** for a place with no anchor. The place row exists and has no shared frame yet, which is the window between creating it and its first accepted alignment. Answering 404 would deny a place the caller can see, and 410 would say somebody deleted it. * **410** for a place whose anchor was withdrawn. Every version's frame is the anchor's, so withdrawing the anchor's photographs takes the shared frame with it, and the caller holding an earlier bundle is entitled to learn that rather than to be told 404. * **200** for a readable place, INCLUDING one with no version at or before at. That is an answer, not an absence: the bundle carries the place, its versions and their times, no scene at all, and says which of those it is. Turning it into a 404 would report a place that exists as missing. at is optional and a missing one means the latest dated version rather than "now". A read whose answer depends on the clock has a digest that moves with no write behind it, which exulanica/graph/world_read.py records the cost of. A naive timestamp is refused rather than assumed to be UTC: the column is UTC and guessing is how an hour goes missing. Required permissions: library.read [Link to this operation](/docs/api-reference#api-place_bundle_world_read_places__place_id__get). ```json { "parameters": [ { "name": "place_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Place Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "at", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Resolve the version of this place in force at this instant.", "title": "At" }, "description": "Resolve the version of this place in force at this instant." }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhat a generative world model may condition on for one scene, digest-bound.`/world-read/scenes/{scene_id}`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-scene_bundle_world_read_scenes__scene_id__get). ```json { "parameters": [ { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Scene Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETReviewed comfort, navigation, disclosure, and initiative controls.`/world/interactions/catalog`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-catalog_world_interactions_catalog_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Catalog World Interactions Catalog Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETCurrent`/world/interactions/current`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-current_world_interactions_current_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionStateView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPreview`/world/interactions/previews`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-preview_world_interactions_previews_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionPreviewBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionPreviewView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRecommendations`/world/interactions/recommendations`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-recommendations_world_interactions_recommendations_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InteractionRecommendationView" }, "title": "Response Recommendations World Interactions Recommendations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRollback`/world/interactions/rollback`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-rollback_world_interactions_rollback_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionRollbackBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETVersions`/world/interactions/versions`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-versions_world_interactions_versions_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InteractionVersionView" }, "title": "Response Versions World Interactions Versions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETPicture`/world/pictures/{sha256}`** A kept History picture's bytes in the world, by its digest. Required permissions: world.write [Link to this operation](/docs/api-reference#api-picture_world_pictures__sha256__get). ```json { "parameters": [ { "name": "sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Sha256" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne project: its binding as the version reads now, and what the caller may see.`/world/projects/{project_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_project_world_projects__project_id__get). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **PUTRename the project, or bind it to another version of this world.`/world/projects/{project_id}`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-update_project_world_projects__project_id__put). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETEDelete the project, every item's words and every share, for good.`/world/projects/{project_id}`** Required permissions: deletion.write [Link to this operation](/docs/api-reference#api-delete_project_world_projects__project_id__delete). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETReviewed world profiles and capability-backed controls.`/world/styles/catalog`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-catalog_world_styles_catalog_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Catalog World Styles Catalog Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe current immutable style version and protected topology digest.`/world/styles/current`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-current_world_styles_current_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StyleStateView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTValidate an isolated appearance preview without changing current state.`/world/styles/previews`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-preview_world_styles_previews_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe open appearance previews a page may take up when it opens this world, newest first, each with its proposal.`/world/styles/previews`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-open_previews_world_styles_previews_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenPreviewsView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRestore historical style values by creating a new immutable version.`/world/styles/rollback`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-rollback_world_styles_rollback_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RollbackBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StyleVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETImmutable style history, including rollback versions.`/world/styles/versions`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-versions_world_styles_versions_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StyleVersionView" }, "title": "Response Versions World Styles Versions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTOpen the first snapshot and alternate from the current composed sources.`/world/versions/bootstrap`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-bootstrap_alternate_version_world_versions_bootstrap_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BootstrapWorldBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BootstrapWorldView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAsk Creature Look`/things/creatures/{kind_sha256}/looks`** Ask for a made look of a creature this workspace keeps; answers 202 with its look job at once, or with the one already waiting for that creature. Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-ask_creature_look_things_creatures__kind_sha256__looks_post). ```json { "parameters": [ { "name": "kind_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Kind Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Creature Draft`/things/creatures/drafts/{draft_id}`** One creature draft: queued, running, kept with its kind and look, erased since, refused with the check's code and its fixed sentence, or failed with why. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_creature_draft_things_creatures_drafts__draft_id__get). ```json { "parameters": [ { "name": "draft_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Draft Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Creature Look`/things/creatures/looks/{look_id}`** One look job, for any member of the workspace: queued, staged, made with the look's digest, refused with the fit's code, or failed or cancelled with why. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_creature_look_things_creatures_looks__look_id__get). ```json { "parameters": [ { "name": "look_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Look Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe container of a look this workspace holds, by the SHA-256 of the look.`/things/looks/{look_sha256}/container`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-held_look_container_things_looks__look_sha256__container_get). ```json { "parameters": [ { "name": "look_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Look Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Held Look Container Things Looks Look Sha256 Container Get" } }, "model/gltf-binary": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhich photographs actually observed each retained sparse point.`/world-read/scenes/{scene_id}/observations`** Click-to-evidence's recorded half. A scene with no accepted pose receipt answers 404 alongside a missing and a foreign one. That is deliberate: "this scene exists but its pose was refused" is a fact about somebody's library, and the read surface does not distinguish reasons a caller may not have. limit and after_point_id page the answer, and no limit means the whole graph, which is what this route returns and what a client reading it expects. The response says which one it got: MEASURED 2026-09-07 against the retained reference instance, the bowl scene's graph is 97,633,587 canonical bytes and the volcanic scene's is 1,179,240,157, so a caller who wants a page has to be able to ask for one, and a caller who gets a page has to be told so. The inspector resolves one click at a time through /resolve below, because the volcanic scene's whole graph is more than a browser can hold as one string. Required permissions: library.read [Link to this operation](/docs/api-reference#api-scene_observation_graph_world_read_scenes__scene_id__observations_get). ```json { "parameters": [ { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Scene Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "description": "Return at most this many points, in point-id order.", "title": "Limit" }, "description": "Return at most this many points, in point-id order." }, { "name": "after_point_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Continue after this point id, from a previous page's next_point_id.", "title": "After Point Id" }, "description": "Continue after this point id, from a previous page's next_point_id." }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTFile what a world model imagined, in the tier below every recorded rung.`/world-write/scenes/{scene_id}/generated`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-record_generation_world_write_scenes__scene_id__generated_post). ```json { "parameters": [ { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Scene Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedSceneBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETEDiscard`/world/interactions/previews/{preview_id}`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-discard_world_interactions_previews__preview_id__delete). ```json { "parameters": [ { "name": "preview_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Preview Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETProposal Record`/world/interactions/proposals/{proposal_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-proposal_record_world_interactions_proposals__proposal_id__get). ```json { "parameters": [ { "name": "proposal_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Proposal Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionProposalView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe owner's non-content record of a project, kept after its words are deleted.`/world/projects/{project_id}/audit`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-project_audit_world_projects__project_id__audit_get). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAuditView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe bounded context the caller may hand onward, assembled now; nothing is stored.`/world/projects/{project_id}/context`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-project_context_world_projects__project_id__context_get). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "max_entries", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 64, "minimum": 1, "default": 24, "title": "Max Entries" } }, { "name": "max_bytes", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 32768, "minimum": 1024, "default": 8192, "title": "Max Bytes" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectContextView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe items the caller may see, with what each names as its authority reads now.`/world/projects/{project_id}/items`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-list_items_world_projects__project_id__items_get). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "enum": [ "proposed", "active", "resolved" ], "type": "string" } }, { "type": "null" } ], "title": "Status" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectItemView" }, "title": "Response List Items World Projects Project Id Items Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTKeep an item, or copy one of the caller's own. An exact retry of a key is 200.`/world/projects/{project_id}/items`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-add_item_world_projects__project_id__items_post). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectItemBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectItemView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTShare the project, or listed items of it, with the other people of this workspace.`/world/projects/{project_id}/shares`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-share_world_projects__project_id__shares_post). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectShareBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectSharesView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETEDiscard an isolated preview without changing style state.`/world/styles/previews/{preview_id}`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-discard_world_styles_previews__preview_id__delete). ```json { "parameters": [ { "name": "preview_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Preview Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETInspect one authorised style proposal, provenance, and lifecycle state.`/world/styles/proposals/{proposal_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-proposal_world_styles_proposals__proposal_id__get). ```json { "parameters": [ { "name": "proposal_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Proposal Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StyleProposalView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhich timeline each of a world version's systems runs on, and where it is.`/world/versions/{version_id}/clock`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_clock_world_versions__version_id__clock_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Read Clock World Versions Version Id Clock Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **PUTCouple a world version's clock: one timeline for its people, traffic and birds.`/world/versions/{version_id}/clock`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-transition_clock_world_versions__version_id__clock_put). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransitionBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Transition Clock World Versions Version Id Clock Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPlace one exact environment asset or feature against the current version state.`/world/versions/{version_id}/environment-instances`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-add_environment_instance_world_versions__version_id__environment_instances_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddEnvironmentBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe flyers a saved world's objects host, as steps of its flight for a page to draw.`/world/versions/{version_id}/flight`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-world_flight_world_versions__version_id__flight_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "from_step", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "From Step" } }, { "name": "steps", "in": "query", "required": false, "schema": { "type": "integer", "default": 600, "title": "Steps" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response World Flight World Versions Version Id Flight Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWorld Inventory`/world/versions/{version_id}/inventory`** Enumerate saved identities; role membership does not grant model assignment or execution. Required permissions: world.read [Link to this operation](/docs/api-reference#api-world_inventory_world_versions__version_id__inventory_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response World Inventory World Versions Version Id Inventory Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA town on its land's land: the chunks, backdrop and water drawn round it.`/world/versions/{version_id}/land`** Serve the land a town made on its land stands on (exulanica.town-land/v1): the digest of its land document, and of every chunk (/land/chunks/{chunk_x}/{chunk_y}) and the backdrop (/land/backdrop) round it, and its water, made in the kind worker and kept by the town's receipt, with its own digest as the entity tag. A town on level ground answers 404 land_unavailable; a site states its land in its drawing and any other world states none, 404 unknown_reference. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_town_land_world_versions__version_id__land_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe volumes placed round a site world, their chunks and tops named by digest.`/world/versions/{version_id}/landscape`** Serve a site world's landscape drawing (exulanica.landscape-drawing/v1), naming its site drawing, its land and each placed volume's chunks and tops by digest. A world on no landscape answers 404 landscape_unavailable. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_site_landscape_world_versions__version_id__landscape_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe parts of a site world a person may change, as they stand. Writes nothing.`/world/versions/{version_id}/parts`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_parts_world_versions__version_id__parts_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Read Parts World Versions Version Id Parts Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA site world's drawing, for the world whose snapshot names its receipt.`/world/versions/{version_id}/site`** Serve the version's exact drawing after worker/cache and final current-source checks. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_site_drawing_world_versions__version_id__site_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Terrain Contact`/world/versions/{version_id}/terrain-contact`** Bind static terrain contact to an authorized version with no unreconciled authored delta. Any authored occupancy without a complete terrain proxy adapter is unavailable. A source geometry digest alone is never a claim that the current edited world is clear. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_terrain_contact_world_versions__version_id__terrain_contact_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "expected_state_sha256", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{64}$" }, { "type": "null" } ], "title": "Expected State Sha256" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe look each thing of a version wears: the latest choice per thing.`/world/versions/{version_id}/thing-looks`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-thing_looks_world_versions__version_id__thing_looks_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPlace a thing by its kind, shipped or its workspace's own, against the current state.`/world/versions/{version_id}/things`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-add_thing_world_versions__version_id__things_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddThingBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe vehicles a saved world's roads hold, second by second, for a page to draw.`/world/versions/{version_id}/traffic`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-world_traffic_world_versions__version_id__traffic_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "from_second", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "From Second" } }, { "name": "seconds", "in": "query", "required": false, "schema": { "type": "integer", "default": 60, "title": "Seconds" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe one recorded point a cursor selects in one photograph, and who observed it.`/world-read/scenes/{scene_id}/observations/resolve`** Click-to-evidence, resolved here rather than by downloading the graph to the browser. The answer holds at most one point and that point's retained observations, so it is bounded by the scene's member count and not by its point count. MEASURED 2026-09-11 on the volcanic scene: the inspector's own centre-of-view click is 11,277 bytes, and the heaviest point any click can select there, 78 retained photographs, is 92,547. The whole graph is 1,015,016,928. A miss is a 200 whose state says so, because nothing recorded near a click is an answer. exulanica/graph/observations.py holds the rest of the argument. Required permissions: library.read [Link to this operation](/docs/api-reference#api-scene_observation_resolve_world_read_scenes__scene_id__observations_resolve_get). ```json { "parameters": [ { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Scene Id" } }, { "name": "capture_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "description": "The photograph whose recovered camera the cursor is in.", "title": "Capture Id" }, "description": "The photograph whose recovered camera the cursor is in." }, { "name": "u", "in": "query", "required": true, "schema": { "type": "number", "maximum": 1000000000, "minimum": -1000000000, "description": "Cursor, in that photograph's pixels, +u right.", "title": "U" }, "description": "Cursor, in that photograph's pixels, +u right." }, { "name": "v", "in": "query", "required": true, "schema": { "type": "number", "maximum": 1000000000, "minimum": -1000000000, "description": "Cursor, in that photograph's pixels, +v down.", "title": "V" }, "description": "Cursor, in that photograph's pixels, +v down." }, { "name": "tolerance_px", "in": "query", "required": false, "schema": { "type": "number", "maximum": 1024, "exclusiveMinimum": 0, "description": "How far a point may project from it.", "default": 24, "title": "Tolerance Px" }, "description": "How far a point may project from it." }, { "name": "occlusion_band_px", "in": "query", "required": false, "schema": { "type": "number", "maximum": 1024, "minimum": 0, "description": "Within this of the nearest, nearer wins.", "default": 4, "title": "Occlusion Band Px" }, "description": "Within this of the nearest, nearer wins." }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETHow many recorded points and observations a click in this scene resolves against.`/world-read/scenes/{scene_id}/observations/summary`** Counts only, for the inspector to show before anyone clicks. Hundreds of bytes. Required permissions: library.read [Link to this operation](/docs/api-reference#api-scene_observation_counts_world_read_scenes__scene_id__observations_summary_get). ```json { "parameters": [ { "name": "scene_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Scene Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTApply`/world/interactions/previews/{preview_id}/apply`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-apply_world_interactions_previews__preview_id__apply_post). ```json { "parameters": [ { "name": "preview_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Preview Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionApplyBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETEDelete one item and every copy of it, erasing their words.`/world/projects/{project_id}/items/{item_id}`** Required permissions: deletion.write [Link to this operation](/docs/api-reference#api-delete_item_world_projects__project_id__items__item_id__delete). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRevisionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETEStop one share. The next read by anyone else no longer shows what it opened.`/world/projects/{project_id}/shares/{share_id}`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-stop_share_world_projects__project_id__shares__share_id__delete). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "share_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Share Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRevisionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAtomically apply one still-current preview as a new immutable version.`/world/styles/previews/{preview_id}/apply`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-apply_world_styles_previews__preview_id__apply_post). ```json { "parameters": [ { "name": "preview_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Preview Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StyleVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAdd exactly the resolved objects as ordinary edits, or refuse with the reason.`/world/versions/{version_id}/arrangements/apply`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-arrangement_apply_route_world_versions__version_id__arrangements_apply_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrangementApplyBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrangementApplyView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhere an arrangement's objects would stand in one authored version. Writes nothing.`/world/versions/{version_id}/arrangements/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-arrangement_preview_route_world_versions__version_id__arrangements_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrangementPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Arrangement Preview Route World Versions Version Id Arrangements Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA world version's clock receipts, newest first.`/world/versions/{version_id}/clock/events`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-clock_events_world_versions__version_id__clock_events_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 128, "minimum": 1, "default": 64, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Clock Events World Versions Version Id Clock Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETReplay a coupled world's minutes from what was stored and check them.`/world/versions/{version_id}/clock/verify`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-verify_clock_world_versions__version_id__clock_verify_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "from_tick", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "title": "From Tick" } }, { "name": "to_tick", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "title": "To Tick" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Verify Clock World Versions Version Id Clock Verify Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPerform exactly the resolved composition, or refuse with its blocked reason.`/world/versions/{version_id}/compositions/apply`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-composition_apply_route_world_versions__version_id__compositions_apply_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompositionApplyBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTThe server's verdict on one composition into one authored version. Writes nothing.`/world/versions/{version_id}/compositions/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-composition_preview_route_world_versions__version_id__compositions_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompositionPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Composition Preview Route World Versions Version Id Compositions Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTUndo the newest authored edit from stored history, even after source withdrawal.`/world/versions/{version_id}/environment-instances/undo`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-undo_environment_edit_world_versions__version_id__environment_instances_undo_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseStateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTQuery World Entities`/world/versions/{version_id}/inventory/query`** Match actual constant base factors; reading performs no edit, worker or model call. Required permissions: world.read [Link to this operation](/docs/api-reference#api-query_world_entities_world_versions__version_id__inventory_query_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorldEntityQueryBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA site world's land drawn to the horizon, never walked.`/world/versions/{version_id}/land/backdrop`** Serve a site world's backdrop (exulanica.landform-backdrop/v1), held to the digest its drawing names, or a town on its land's, held to the digest its land section names. A level world answers 404 land_unavailable. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_site_land_backdrop_world_versions__version_id__land_backdrop_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe graded top of the volume a site world stands on.`/world/versions/{version_id}/land/top`** Serve the graded top a site world laid out on a placed volume's top stands on (exulanica.site-top/v1: its heights on the 1 m lattice in the site's frame and the water on them), held to the digest its drawing (exulanica.site-drawing/v6) names. A level world answers 404 land_unavailable, and so does a world on land, which has chunks instead. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_site_land_top_world_versions__version_id__land_top_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne chunk of a placed volume's surface, by the digest the landscape drawing names.`/world/versions/{version_id}/landscape/chunk`** Serve one volume chunk (exulanica.volume-chunk/v1) the world's landscape drawing names by sha256; a digest it does not name 404 landscape_document_unavailable. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_site_landscape_chunk_world_versions__version_id__landscape_chunk_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "sha256", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Sha256" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne chunk or the backdrop of the land under a world on a volume's top, by digest.`/world/versions/{version_id}/landscape/ground`** Serve one chunk (exulanica.landform-chunk/v1) or the backdrop (exulanica.landform-backdrop/v1) of the land a world on a placed volume's top floats over, which its landscape drawing (exulanica.landscape-drawing/v2) names by sha256 in its ground; a digest it does not name 404 landscape_document_unavailable. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_site_landscape_ground_world_versions__version_id__landscape_ground_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "sha256", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Sha256" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne walkable top of a placed volume, by the digest the landscape drawing names.`/world/versions/{version_id}/landscape/top`** Serve one walkable top (exulanica.volume-sheet/v1) the world's landscape drawing names by sha256; a digest it does not name 404 landscape_document_unavailable. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_site_landscape_top_world_versions__version_id__landscape_top_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "sha256", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Sha256" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTReverse the newest object edit, from the document that edit stored.`/world/versions/{version_id}/objects/undo`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-undo_authored_edit_world_versions__version_id__objects_undo_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseStateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETGet Realtime State`/world/versions/{version_id}/realtime/state`** Return the current 20 Hz room state snapshot, AOI delta frame, and active tier summary. Required permissions: world.read [Link to this operation](/docs/api-reference#api-get_realtime_state_world_versions__version_id__realtime_state_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "observer_x_mm", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "Observer X Mm" } }, { "name": "observer_y_mm", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Observer Y Mm" } }, { "name": "observer_z_mm", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "Observer Z Mm" } }, { "name": "radius_mm", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500000, "minimum": 1000, "default": 24000, "title": "Radius Mm" } }, { "name": "since_tick", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Since Tick" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Realtime State World Versions Version Id Realtime State Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPost Realtime Step`/world/versions/{version_id}/realtime/step`** Advance the 20 Hz room by 1..100 ticks and apply player actions / Tier 2 proposals. Required permissions: world.write [Link to this operation](/docs/api-reference#api-post_realtime_step_world_versions__version_id__realtime_step_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepRealtimeBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Post Realtime Step World Versions Version Id Realtime Step Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETA world, being or thing's properties and catalog actions, without performing them.`/world/versions/{version_id}/subjects/{ref}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_subject_world_versions__version_id__subjects__ref__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "ref", "in": "path", "required": true, "schema": { "type": "string", "title": "Ref" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETEvery placed thing's newest character record of a version, in one read.`/world/versions/{version_id}/things/characters`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-thing_characters_read_world_versions__version_id__things_characters_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTSave a passive rigid thing with explicit admitted support affinity.`/world/versions/{version_id}/things/on-support`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-place_supported_thing_world_versions__version_id__things_on_support_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedThingBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhat placing a thing would record, and where it would stand. Writes nothing.`/world/versions/{version_id}/things/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-add_thing_preview_world_versions__version_id__things_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddThingPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Add Thing Preview World Versions Version Id Things Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTReverse the newest undo not yet redone, unless an edit was made since.`/world/versions/{version_id}/things/redo`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-redo_thing_edit_world_versions__version_id__things_redo_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseStateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTUndo the newest authored edit from stored history.`/world/versions/{version_id}/things/undo`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-undo_thing_edit_world_versions__version_id__things_undo_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseStateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAsk again for the bakes a generated world's tiles lack, as making it did.`/world/versions/{version_id}/tiles/bakes`** Queue a bake for each tile of the version's generated world that has no servable bake and none queued or running: its own tiles (~exulanica.world.generated_worlds.queue_world_bakes) and the tiles the version's changes to its buildings alter (~exulanica.world.version_tiles.queue_version_bakes), in one transaction. A tile whose bake failed is such a tile. Answers how many were queued, none when nothing is missing. A world no recipe's composer composed has no tiles and answers 404 unknown_reference, as an unknown world or version does; a deployment whose database role cannot register a world is refused 403 worlds_read_only before anything is queued, as making one is. Required permissions: world.write [Link to this operation](/docs/api-reference#api-queue_world_tile_bakes_world_versions__version_id__tiles_bakes_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TileBakesQueuedView" } } } }, "404": { "description": "No such world or version here, or a world with no tiles." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCorrect an item. The earlier words stay in its history until it is deleted.`/world/projects/{project_id}/items/{item_id}/corrections`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-correct_item_world_projects__project_id__items__item_id__corrections_post). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectItemCorrectionBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectItemView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETEvery revision of one of the owner's items, with its words: its correction history.`/world/projects/{project_id}/items/{item_id}/history`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-item_history_world_projects__project_id__items__item_id__history_get). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectItemRevisionView" }, "title": "Response Item History World Projects Project Id Items Item Id History Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTClose a goal, question or task that is done. It leaves the context.`/world/projects/{project_id}/items/{item_id}/resolve`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-resolve_item_world_projects__project_id__items__item_id__resolve_post). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectItemResolveBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectItemView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAccept a suggestion into the context, or reject it and erase its words.`/world/projects/{project_id}/items/{item_id}/review`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-review_item_world_projects__project_id__items__item_id__review_post). ```json { "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectItemReviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectItemReviewView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPlace exactly the resolved estimate, or refuse with its blocked reason.`/world/versions/{version_id}/compositions/photo-point-maps/apply`** Required permissions: admission.read, world.write [Link to this operation](/docs/api-reference#api-photo_point_map_apply_route_world_versions__version_id__compositions_photo_point_maps_apply_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhotoPointMapApplyBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTThe server's verdict on placing a 3D estimate from a photograph. Writes nothing.`/world/versions/{version_id}/compositions/photo-point-maps/preview`** Required permissions: admission.read, world.write [Link to this operation](/docs/api-reference#api-photo_point_map_preview_route_world_versions__version_id__compositions_photo_point_maps_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhotoPointMapPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Photo Point Map Preview Route World Versions Version Id Compositions Photo Point Maps Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTMove an available, still-authorized environment instance without changing its source.`/world/versions/{version_id}/environment-instances/{instance_id}/move`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-move_environment_instance_world_versions__version_id__environment_instances__instance_id__move_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "instance_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Instance Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveObjectBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStore a removal, including when the pinned source has since been withdrawn.`/world/versions/{version_id}/environment-instances/{instance_id}/remove`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-remove_environment_instance_world_versions__version_id__environment_instances__instance_id__remove_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "instance_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Instance Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseStateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTGive one authored object a reviewed behaviour, replace it, or take it away with null.`/world/versions/{version_id}/objects/{object_id}/behaviour`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-set_authored_object_behaviour_world_versions__version_id__objects__object_id__behaviour_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "object_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Object Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetObjectBehaviourBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTReplace one authored object's region-local transform.`/world/versions/{version_id}/objects/{object_id}/move`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-move_authored_object_world_versions__version_id__objects__object_id__move_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "object_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Object Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveObjectBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStore a removal. POST rather than DELETE: this appends history, it destroys nothing.`/world/versions/{version_id}/objects/{object_id}/remove`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-remove_authored_object_world_versions__version_id__objects__object_id__remove_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "object_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Object Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseStateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhich edit an undo would reverse, and what it would restore. Writes nothing.`/world/versions/{version_id}/objects/undo/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-undo_authored_edit_preview_world_versions__version_id__objects_undo_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Undo Authored Edit Preview World Versions Version Id Objects Undo Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStand a made part at a new centre, turned in quarter turns, where the world takes it.`/world/versions/{version_id}/parts/{part_id}/move`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-move_part_world_versions__version_id__parts__part_id__move_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "part_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "maxLength": 36, "pattern": "^[0-9a-f-]{36}$", "title": "Part Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MovePartBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRemove a made part nobody lives or works in, where people still reach every place.`/world/versions/{version_id}/parts/{part_id}/remove`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-remove_part_world_versions__version_id__parts__part_id__remove_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "part_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "maxLength": 36, "pattern": "^[0-9a-f-]{36}$", "title": "Part Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseStateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStand a made building taller or lower, within the storeys its world's kind allows.`/world/versions/{version_id}/parts/{part_id}/storeys`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-part_storeys_world_versions__version_id__parts__part_id__storeys_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "part_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "maxLength": 36, "pattern": "^[0-9a-f-]{36}$", "title": "Part Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartStoreysBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne thing or being of the version's society of things, as its card shows it.`/world/versions/{version_id}/society/things/{thing_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-thing_card_read_world_versions__version_id__society_things__thing_id__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "thing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Thing Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTThe world's owner writes or clears who a placed being is; answers the record.`/world/versions/{version_id}/things/{thing_id}/character`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-thing_character_write_world_versions__version_id__things__thing_id__character_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "thing_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[a-z0-9]([a-z0-9:._-]{0,198}[a-z0-9])?$", "title": "Thing Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingCharacterBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTMove a placed thing to another pose in its region, its kind unchanged.`/world/versions/{version_id}/things/{thing_id}/move`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-move_thing_world_versions__version_id__things__thing_id__move_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "thing_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Thing Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveThingBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStore the removal of a placed thing.`/world/versions/{version_id}/things/{thing_id}/remove`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-remove_thing_world_versions__version_id__things__thing_id__remove_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "thing_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Thing Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseStateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternateVersionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead a placed thing's support affinity and current bounded clearance availability.`/world/versions/{version_id}/things/{thing_id}/support`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_thing_support_world_versions__version_id__things__thing_id__support_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "thing_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Thing Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETEvery character record of a version, newest first, with what it stated and when.`/world/versions/{version_id}/things/characters/history`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-thing_character_history_world_versions__version_id__things_characters_history_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 200, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCheck passive rigid thing placement against an exact source support and state.`/world/versions/{version_id}/things/on-support/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-preview_supported_thing_world_versions__version_id__things_on_support_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportedThingBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhich undo a redo would reverse, and what it would put back. Writes nothing.`/world/versions/{version_id}/things/redo/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-redo_thing_edit_preview_world_versions__version_id__things_redo_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingEditPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Redo Thing Edit Preview World Versions Version Id Things Redo Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhich edit an undo would reverse, and what it would restore. Writes nothing.`/world/versions/{version_id}/things/undo/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-undo_thing_edit_preview_world_versions__version_id__things_undo_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingEditPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Undo Thing Edit Preview World Versions Version Id Things Undo Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne baked tile of a generated world, for the world that names it.`/world/versions/{version_id}/tiles/{baked_tile_id}/bytes`** A baked tile's bytes, served only when the version's own snapshot names the tile: a tile its changes to a made town's buildings alter is its workspace's own bake, served from the workspace's namespace (exulanica.world.version_tiles). Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_world_tile_bytes_world_versions__version_id__tiles__baked_tile_id__bytes_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "baked_tile_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Baked Tile Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **PUTPut Moment Picture`/world/versions/{version_id}/history/moments/{moment_id}/picture`** Keep the picture a page drew of a moment of this version, unless one is kept already. Required permissions: world.write [Link to this operation](/docs/api-reference#api-put_moment_picture_world_versions__version_id__history_moments__moment_id__picture_put). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "moment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Moment Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "recipe", "in": "query", "required": true, "schema": { "type": "string", "minLength": 4, "maxLength": 56, "title": "Recipe" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "image/jpeg": { "schema": { "type": "string", "contentMediaType": "image/jpeg" } }, "image/webp": { "schema": { "type": "string", "contentMediaType": "image/webp" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Put Moment Picture World Versions Version Id History Moments Moment Id Picture Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne 128 m chunk of a site world's land, by its place on the city's tile grid.`/world/versions/{version_id}/land/chunks/{chunk_x}/{chunk_y}`** Serve one chunk of a site world's graded land (exulanica.landform-chunk/v1), held to the digest its drawing (exulanica.site-drawing/v5) names, or of a town on its land's, held to the digest its land section (GET /world/versions/{version_id}/land) names. A level world answers 404 land_unavailable; a chunk the land does not hold 404 land_chunk_unavailable. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_site_land_chunk_world_versions__version_id__land_chunks__chunk_x___chunk_y__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "chunk_x", "in": "path", "required": true, "schema": { "type": "integer", "maximum": 4096, "minimum": -4096, "title": "Chunk X" } }, { "name": "chunk_y", "in": "path", "required": true, "schema": { "type": "integer", "maximum": 4096, "minimum": -4096, "title": "Chunk Y" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhat moving one authored object would record. Writes nothing.`/world/versions/{version_id}/objects/{object_id}/move/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-move_authored_object_preview_world_versions__version_id__objects__object_id__move_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "object_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Object Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MovePreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Move Authored Object Preview World Versions Version Id Objects Object Id Move Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhat removing one authored object would record. Writes nothing.`/world/versions/{version_id}/objects/{object_id}/remove/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-remove_authored_object_preview_world_versions__version_id__objects__object_id__remove_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "object_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Object Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Authored Object Preview World Versions Version Id Objects Object Id Remove Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhat moving or turning a made part would record, and whether it may. Writes nothing.`/world/versions/{version_id}/parts/{part_id}/move/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-move_part_preview_world_versions__version_id__parts__part_id__move_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "part_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "maxLength": 36, "pattern": "^[0-9a-f-]{36}$", "title": "Part Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MovePartPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Move Part Preview World Versions Version Id Parts Part Id Move Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhat removing one made part would record, and whether it may. Writes nothing.`/world/versions/{version_id}/parts/{part_id}/remove/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-remove_part_preview_world_versions__version_id__parts__part_id__remove_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "part_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "maxLength": 36, "pattern": "^[0-9a-f-]{36}$", "title": "Part Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingEditPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Part Preview World Versions Version Id Parts Part Id Remove Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhat standing a made building taller or lower would record. Writes nothing.`/world/versions/{version_id}/parts/{part_id}/storeys/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-part_storeys_preview_world_versions__version_id__parts__part_id__storeys_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "part_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "maxLength": 36, "pattern": "^[0-9a-f-]{36}$", "title": "Part Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartStoreysPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Part Storeys Preview World Versions Version Id Parts Part Id Storeys Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTThe world's owner chooses a shipped look for a thing; answers its card.`/world/versions/{version_id}/society/things/{thing_id}/look`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-thing_look_choose_world_versions__version_id__society_things__thing_id__look_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "thing_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Thing Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingLookBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhat moving one placed thing would record, and where it would stand. Writes nothing.`/world/versions/{version_id}/things/{thing_id}/move/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-move_thing_preview_world_versions__version_id__things__thing_id__move_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "thing_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Thing Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveThingPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Move Thing Preview World Versions Version Id Things Thing Id Move Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhat removing one placed thing would record. Writes nothing.`/world/versions/{version_id}/things/{thing_id}/remove/preview`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-remove_thing_preview_world_versions__version_id__things__thing_id__remove_preview_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "thing_id", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 200, "title": "Thing Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThingEditPreviewBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Remove Thing Preview World Versions Version Id Things Thing Id Remove Preview Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. ## Models and Decisions Assign an open model to a role and run or inspect decisions. - [List Decision Roles](/docs/world-api/models): GET /world/versions/{version_id}/models. Read the decision roles registered for a world, the models offered for each role, and the owner’s current choices. **GETList Decision Roles`/world/versions/{version_id}/models`** Read the decision roles registered for a world, the models offered for each role, and the owner’s current choices. Required permissions: world.read [Link to this operation](/docs/api-reference#api-world_models_world_versions__version_id__models_get). [Request examples and fields](/docs/world-api/models). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response World Models World Versions Version Id Models Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Society State`/world/versions/{version_id}/society`** Read the society attached to this version, including its current state and the places its inhabitants can visit. Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_world_versions__version_id__society_get). [Request examples and fields](/docs/world-api/society). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "places", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Places" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Society World Versions Version Id Society Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAdmit Model`/models`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-admit_model_models_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRecordBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETDiscover Models`/models`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-discover_models_models_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Discover Models Models Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPreflight Model`/models/preflight`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-preflight_model_models_preflight_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelPreflightBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Preflight Model Models Preflight Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRemove Admitted Model`/models/remove`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-remove_admitted_model_models_remove_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRecordBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Model Binding`/models/bindings/{binding_sha256}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_model_binding_models_bindings__binding_sha256__get). ```json { "parameters": [ { "name": "binding_sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Binding Sha256" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Model Probe`/models/probes/{probe_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_model_probe_models_probes__probe_id__get). ```json { "parameters": [ { "name": "probe_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Probe Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPrepare Model Probe`/models/probes/prepare`** Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-prepare_model_probe_models_probes_prepare_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelRecordBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCancel Model Probe`/models/probes/{probe_id}/cancel`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-cancel_model_probe_models_probes__probe_id__cancel_post). ```json { "parameters": [ { "name": "probe_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Probe Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStart Model Probe`/models/probes/{probe_id}/start`** Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-start_model_probe_models_probes__probe_id__start_post). ```json { "parameters": [ { "name": "probe_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Probe Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProbeStartBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCreate Society`/world/versions/{version_id}/society`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-create_society_world_versions__version_id__society_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSocietyBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Create Society World Versions Version Id Society Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETEErase Society Records`/world/versions/{version_id}/society`** Erase this world version's society whole, under a society tombstone: every row that records it (what its people said among them), its clock, its asks to outside programs and its crossings, and the comparisons and experiments started from it; the Companion's answers that cited the version are withdrawn. Refused society_unavailable (404) where the version holds no society, and restore_sealed (409) while the installation is sealed for a restore. Required permissions: deletion.write, world.write [Link to this operation](/docs/api-reference#api-erase_society_records_world_versions__version_id__society_delete). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTChoose World Model`/world/versions/{version_id}/models/{role_key}`** Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-choose_world_model_world_versions__version_id__models__role_key__post). ```json { "parameters": [ { "name": "role_key", "in": "path", "required": true, "schema": { "type": "string", "title": "Role Key" } }, { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleChoiceBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Choose World Model World Versions Version Id Models Role Key Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRecord Action`/world/versions/{version_id}/society/actions`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-record_action_world_versions__version_id__society_actions_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocietyActionBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Record Action World Versions Version Id Society Actions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETAction Events`/world/versions/{version_id}/society/actions`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-action_events_world_versions__version_id__society_actions_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 128, "minimum": 1, "default": 64, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Action Events World Versions Version Id Society Actions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Control`/world/versions/{version_id}/society/control`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_control_world_versions__version_id__society_control_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **PUTConfigure Control`/world/versions/{version_id}/society/control`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-configure_control_world_versions__version_id__society_control_put). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigureBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPropose Decision`/world/versions/{version_id}/society/decisions`** Refused by name for every society: explicitly requested model proposals are retired. They were the retired exulanica-society/v3 engine's, and no host was ever configured to answer them. A model decides for a person only as the world's owner chose, at the planner's own choice point. The world and its society are resolved first, so a stranger learns nothing from the refusal that an unknown version would not tell them; a stored request still reads. Required permissions: world.write [Link to this operation](/docs/api-reference#api-propose_decision_world_versions__version_id__society_decisions_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisionBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Propose Decision World Versions Version Id Society Decisions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSociety District`/world/versions/{version_id}/society/district`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_district_world_versions__version_id__society_district_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocietyDistrictView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSociety Events`/world/versions/{version_id}/society/events`** The society's events, newest first, a page at a time (before reads on). Naming a window of minutes (from_tick, to_tick, inclusive) reads it oldest first instead, a page at a time (after reads on), so a page can show what was said in the minutes it draws, in order; kinds keeps those kinds alone (said for lines). A window that ends before it begins, before with a window, after without one or a malformed kind is refused invalid_events_window. Each decision_applied event also carries did, what its chosen option did in a History branch's shape (kind, target, with), read from its receipt and not stored, or null where the receipt holds no proposal. Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_events_world_versions__version_id__society_events_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 256, "minimum": 1, "default": 256, "title": "Limit" } }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "Before" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120 }, { "type": "null" } ], "title": "After" } }, { "name": "kinds", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 16 }, { "type": "null" } ], "title": "Kinds" } }, { "name": "from_tick", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 2147483647, "minimum": 0 }, { "type": "null" } ], "title": "From Tick" } }, { "name": "to_tick", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 2147483647, "minimum": 0 }, { "type": "null" } ], "title": "To Tick" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Society Events World Versions Version Id Society Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPrepare Experiment`/world/versions/{version_id}/society/experiments`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-prepare_experiment_world_versions__version_id__society_experiments_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareExperimentBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperimentDefinitionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSociety Models`/world/versions/{version_id}/society/models`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_models_world_versions__version_id__society_models_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Society Models World Versions Version Id Society Models Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTChoose Society Model`/world/versions/{version_id}/society/models`** Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-choose_society_model_world_versions__version_id__society_models_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelChoiceBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Choose Society Model World Versions Version Id Society Models Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStart Playing`/world/versions/{version_id}/society/play`** Start playing one being: a choice naming it with the person who plays, the session's account. Refused by name where the society is not a society of things (engine_takes_no_play), another person plays it (being_played), its own program decides for it (decided_from_outside) or its kind lets no person decide for it (decider_not_allowed). Required permissions: being.act, world.read [Link to this operation](/docs/api-reference#api-start_playing_world_versions__version_id__society_play_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlayBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Start Playing World Versions Version Id Society Play Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTChange Society Presence`/world/versions/{version_id}/society/presence`** One recorded minute in which everyone leaves, or the same people arrive again. The request names only what the person wants and the state they saw; the server resolves the world, the society, the rights and the minute. A refusal names what stands in the way. Required permissions: world.write [Link to this operation](/docs/api-reference#api-change_society_presence_world_versions__version_id__society_presence_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresenceBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Change Society Presence World Versions Version Id Society Presence Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSociety Stand`/world/versions/{version_id}/society/stand`** Where a being put down at a point of the region's frame would stand: the walking node of the society's latest input it would be taken in at now, with its position and the height a thing placed there rests at, or null where none is open there. Its rights are asked as the state's are. Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_stand_world_versions__version_id__society_stand_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "x_mm", "in": "query", "required": true, "schema": { "type": "integer", "maximum": 2147483647, "minimum": -2147483647, "title": "X Mm" } }, { "name": "z_mm", "in": "query", "required": true, "schema": { "type": "integer", "maximum": 2147483647, "minimum": -2147483647, "title": "Z Mm" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Society Stand World Versions Version Id Society Stand Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAdvance Society`/world/versions/{version_id}/society/steps`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-advance_society_world_versions__version_id__society_steps_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepSocietyBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Advance Society World Versions Version Id Society Steps Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTTake Newcomers In Society`/world/versions/{version_id}/society/take-in`** A living town's people take in what was placed in their world after they came: this version's living society is ended and a society of things made on the same version, in one transaction, and answered as a creation answers. They are the same people, with their identities, homes, jobs, roles and shifts; their day so far is not kept: the erasure is the one DELETE .../society makes (a society tombstone, every row that records the society, its clock, its asks and crossings, the comparisons and experiments started from it, and the Companion's answers that cited the version withdrawn). Refused society_unavailable (404) where the version holds no society, society_takes_in_already (409) where its society is not a living one, nothing_to_take_in (409) where the engine table gives the version no society of things, and restore_sealed (409) while the installation is sealed for a restore; a refusal of the making is answered as a creation's and leaves the living society as it was. Required permissions: deletion.write, world.write [Link to this operation](/docs/api-reference#api-take_newcomers_in_society_world_versions__version_id__society_take_in_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Take Newcomers In Society World Versions Version Id Society Take In Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETExport verified world decision trajectories and counterfactual pairs.`/world/versions/{version_id}/society/trajectories`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_trajectories_world_versions__version_id__society_trajectories_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "format", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "json", "jsonl", "openai", "openenv", "dpo" ], "type": "string" }, { "type": "null" } ], "title": "Format" } }, { "name": "kind", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "all", "sft", "dpo" ], "type": "string" }, { "type": "null" } ], "title": "Kind" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 2000, "minimum": 1, "default": 2000, "title": "Limit" } }, { "name": "subject_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Subject Id" } }, { "name": "request_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Request Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Society Trajectories World Versions Version Id Society Trajectories Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTSet World Minds Budget`/world/versions/{version_id}/models/{role_key}/budget`** Set what this world may spend on the model minds of its beings, in any hour of real time. One appended record of the world, naming who set it; the newest is the budget, and the same request asked again answers the record it made (budget is that record, also when a later request has set another since). A request that names the budget it was prepared against (after_budget_seq) is refused where another has been set since (budget_changed). It asks no model and spends nothing. The process's own budget and its reserve, a deployment's allowance and the workspace's grant still bound every call: a budget is never above them, whatever it reads. Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-set_world_minds_budget_world_versions__version_id__models__role_key__budget_post). ```json { "parameters": [ { "name": "role_key", "in": "path", "required": true, "schema": { "type": "string", "title": "Role Key" } }, { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MindsBudgetBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Set World Minds Budget World Versions Version Id Models Role Key Budget Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Action`/world/versions/{version_id}/society/actions/{request_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_action_world_versions__version_id__society_actions__request_id__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Request Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Read Action World Versions Version Id Society Actions Request Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETControl Events`/world/versions/{version_id}/society/control/events`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-control_events_world_versions__version_id__society_control_events_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 128, "minimum": 1, "default": 64, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Control Events World Versions Version Id Society Control Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTOpen Living Session`/world/versions/{version_id}/society/control/sessions`** Open a living session on the society and play it: one bounded stretch of playback, stated by its limits, from the tick and state digest the caller read where the society is paused, or from the minute it is at where it plays, with no pause written. Refused 409 session_already_open while one is open, session_request_reused for a key that opened a session with other limits, and stale_society_state for another revision, or for another tick or digest of a paused society; 422 for limits beyond the installation's. The same key answers the session it opened. Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-open_living_session_world_versions__version_id__society_control_sessions_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenSessionBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Open Living Session World Versions Version Id Society Control Sessions Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETList Living Sessions`/world/versions/{version_id}/society/control/sessions`** Every living session of the society, newest first, each open until it closed. Required permissions: world.read [Link to this operation](/docs/api-reference#api-list_living_sessions_world_versions__version_id__society_control_sessions_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response List Living Sessions World Versions Version Id Society Control Sessions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTManual Step`/world/versions/{version_id}/society/control/steps`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-manual_step_world_versions__version_id__society_control_steps_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StepBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Manual Step World Versions Version Id Society Control Steps Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Decision`/world/versions/{version_id}/society/decisions/{request_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_decision_world_versions__version_id__society_decisions__request_id__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Request Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Read Decision World Versions Version Id Society Decisions Request Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Experiment`/world/versions/{version_id}/society/experiments/{experiment_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_experiment_world_versions__version_id__society_experiments__experiment_id__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "experiment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Experiment Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperimentDefinitionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSociety Input Provenance`/world/versions/{version_id}/society/inputs/{input_seq}`** One stored input of the version's society: its identity and the authored state it was composed after, the version's edit_seq and state digest as the input records them, never the input itself. An event names its input by input_seq, so this read joins an event to the edit in the version's history that it followed. Its rights are asked as the events read asks them. Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_input_provenance_world_versions__version_id__society_inputs__input_seq__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "input_seq", "in": "path", "required": true, "schema": { "type": "integer", "maximum": 2147483647, "minimum": 1, "title": "Input Seq" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Society Input Provenance World Versions Version Id Society Inputs Input Seq Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETEvery model choice made for the version's people, newest first, with when.`/world/versions/{version_id}/society/models/history`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_model_history_world_versions__version_id__society_models_history_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 200, "title": "Limit" } }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Before" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Society Model History World Versions Version Id Society Models History Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Living Session`/world/versions/{version_id}/society/control/sessions/{session_id}`** One living session and what it came to: what it used of each limit, each provider's bound (what it committed, and what is unresolved), its decisions in decision order with their request ids, and the measures of its model decisions overall and per model, from the decisions asked for its minutes alone. 404 session_unknown where the society has none by that id. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_living_session_world_versions__version_id__society_control_sessions__session_id__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Read Living Session World Versions Version Id Society Control Sessions Session Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAsk Decision Again`/world/versions/{version_id}/society/decisions/{request_id}/asks`** Ask another model a recorded decision again, once, never applying its answer. Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-ask_decision_again_world_versions__version_id__society_decisions__request_id__asks_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Request Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Ask Decision Again World Versions Version Id Society Decisions Request Id Asks Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Decision Asks`/world/versions/{version_id}/society/decisions/{request_id}/asks`** The original answer of a recorded decision, and every ask beside it. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_decision_asks_world_versions__version_id__society_decisions__request_id__asks_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Request Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Read Decision Asks World Versions Version Id Society Decisions Request Id Asks Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTReserve Attempt`/world/versions/{version_id}/society/experiments/{experiment_id}/attempts`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-reserve_attempt_world_versions__version_id__society_experiments__experiment_id__attempts_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "experiment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Experiment Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReserveAttemptBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttemptResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOffer Asks Again`/world/versions/{version_id}/society/people/{subject_id}/asks-again`** What asking a person's last answered decisions again of model (provider/model_id), and once more of the model that answered each, would be; with request_id, that one decision of the person's, whatever its age. Asks and writes nothing: its checks read through read-only sessions. Required permissions: world.read [Link to this operation](/docs/api-reference#api-offer_asks_again_world_versions__version_id__society_people__subject_id__asks_again_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "model", "in": "query", "required": true, "schema": { "type": "string", "minLength": 3, "maxLength": 265, "title": "Model" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "request_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Request Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Offer Asks Again World Versions Version Id Society People Subject Id Asks Again Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAnswer`/world/versions/{version_id}/society/play/{subject_id}/answer`** The reader's answer for the being they play, for the minute base_tick: one option the minute offers, by its label, and its line where it says something or the spot it walks to (point) where it walks to one the reader chooses. Checked as any decider's answer is, its line read in Unicode normal form C and trimmed first, and kept as the latest for that minute; the minute takes the latest. Refused minute_passed (409, with the current minute) where that minute has been played or has taken the being's answer already, not_played where the reader does not play the being, too_many_answers (429, with Retry-After where the society plays) past twelve answers a minute, and by the check that fails. Required permissions: being.act, world.read [Link to this operation](/docs/api-reference#api-answer_world_versions__version_id__society_play__subject_id__answer_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlayAnswerBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Answer World Versions Version Id Society Play Subject Id Answer Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTGive Back`/world/versions/{version_id}/society/play/{subject_id}/give-back`** Give the being back: it is decided for again as it was before the play began. Refused not_played where the reader does not play it. Required permissions: being.act, world.read [Link to this operation](/docs/api-reference#api-give_back_world_versions__version_id__society_play__subject_id__give_back_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GiveBackBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Give Back World Versions Version Id Society Play Subject Id Give Back Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETTurn`/world/versions/{version_id}/society/play/{subject_id}/turn`** What the being is offered in the minute to come, read from the society's stored state as its request will offer it: each option's label, kind, the place or being it names and whether it takes a line; the line's bound; whether the reader plays it; how many quiet minutes are left before the being is given back; and when the minute is due. Required permissions: world.read [Link to this operation](/docs/api-reference#api-turn_world_versions__version_id__society_play__subject_id__turn_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "subject_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Subject Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Turn World Versions Version Id Society Play Subject Id Turn Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStop Living Session`/world/versions/{version_id}/society/control/sessions/{session_id}/stop`** Stop a living session and close it, stopped_by_person, the world handed back as the run found it (playing where it began playing, else paused). A session that already closed is answered as it closed. Required permissions: world.write [Link to this operation](/docs/api-reference#api-stop_living_session_world_versions__version_id__society_control_sessions__session_id__stop_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Session Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Stop Living Session World Versions Version Id Society Control Sessions Session Id Stop Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Attempt`/world/versions/{version_id}/society/experiments/{experiment_id}/attempts/{attempt_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_attempt_world_versions__version_id__society_experiments__experiment_id__attempts__attempt_id__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "experiment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Experiment Id" } }, { "name": "attempt_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Attempt Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttemptResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. ## Comparisons and Replay Run a controlled model comparison or replay recorded history. - [Read Recorded History](/docs/world-api/replay): GET /world/versions/{version_id}/society/replay. Read the society’s history replayed from stored records. Replay uses recorded decisions without making new model calls. **GETRead Recorded History`/world/versions/{version_id}/society/replay`** Read the society’s history replayed from stored records. Replay uses recorded decisions without making new model calls. Required permissions: world.read [Link to this operation](/docs/api-reference#api-replay_society_world_versions__version_id__society_replay_get). [Request examples and fields](/docs/world-api/replay). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Replay Society World Versions Version Id Society Replay Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTReplay Model Probe`/models/probes/{probe_id}/replay`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-replay_model_probe_models_probes__probe_id__replay_post). ```json { "parameters": [ { "name": "probe_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Probe Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETRead Version Moments`/world/versions/{version_id}/history/moments`** The version's moments, newest last, each with its kept picture by the recipe asked for. Required permissions: world.read [Link to this operation](/docs/api-reference#api-read_version_moments_world_versions__version_id__history_moments_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Before" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "recipe", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 4, "maxLength": 56, "pattern": "^[a-z][a-z0-9-]{0,47}/v[1-9][0-9]{0,5}$" }, { "type": "null" } ], "title": "Recipe" } }, { "name": "story", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Story" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Read Version Moments World Versions Version Id History Moments Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSociety Comparisons`/world/versions/{version_id}/society/comparisons`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_comparisons_world_versions__version_id__society_comparisons_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Society Comparisons World Versions Version Id Society Comparisons Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStart Society Comparison`/world/versions/{version_id}/society/comparisons`** Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-start_society_comparison_world_versions__version_id__society_comparisons_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparisonStartBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Start Society Comparison World Versions Version Id Society Comparisons Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSignal Comparisons`/world/versions/{version_id}/traffic/comparisons`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-signal_comparisons_world_versions__version_id__traffic_comparisons_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Signal Comparisons World Versions Version Id Traffic Comparisons Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTStart Signal Comparison`/world/versions/{version_id}/traffic/comparisons`** Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-start_signal_comparison_world_versions__version_id__traffic_comparisons_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignalComparisonStartBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Start Signal Comparison World Versions Version Id Traffic Comparisons Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSociety Comparison`/world/versions/{version_id}/society/comparisons/{comparison_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_comparison_world_versions__version_id__society_comparisons__comparison_id__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "comparison_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comparison Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Society Comparison World Versions Version Id Society Comparisons Comparison Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETPlan Society Comparison`/world/versions/{version_id}/society/comparisons/plan`** What a start would do, writing nothing: the roles, groups, models and development seeds this server offers a comparison of the version's society, the windows it may run over (an hour, or a day where the society's engine keeps one and a reading line was measured for its day), and, for the selection the query names (model as /, once or twice; person for a named group; input_seq for an earlier stored input to freeze; bound_usd for the bound a start would state; window for the window, an hour unless named), the runs it plans, the input it freezes, the most it can cost and what one like it typically cost, with the most one decided person's run can ask and call, each model's reservation for one ask and the most its asking can take, or the refusal a start of it would meet, by the same predicates a start's allowance and grant checks read (Services.allowance_refusal, Services.bound_room_refusal). Without a bound, the grant is judged on the calls the selection can make alone. Required permissions: world.read [Link to this operation](/docs/api-reference#api-plan_society_comparison_world_versions__version_id__society_comparisons_plan_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "role", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 63 }, { "type": "null" } ], "title": "Role" } }, { "name": "group", "in": "query", "required": false, "schema": { "anyOf": [ { "enum": [ "everyone", "owner_choice", "named" ], "type": "string" }, { "type": "null" } ], "title": "Group" } }, { "name": "choice_seq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Choice Seq" } }, { "name": "person", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 512, "default": [], "title": "Person" } }, { "name": "model", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "maxItems": 2, "default": [], "title": "Model" } }, { "name": "control", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Control" } }, { "name": "seeds", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 64, "minimum": 1, "default": 1, "title": "Seeds" } }, { "name": "input_seq", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "title": "Input Seq" } }, { "name": "bound_usd", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{1,6}(\\.[0-9]{1,8})?$" }, { "type": "null" } ], "title": "Bound Usd" } }, { "name": "window", "in": "query", "required": false, "schema": { "enum": [ "hour", "day" ], "type": "string", "default": "hour", "title": "Window" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Plan Society Comparison World Versions Version Id Society Comparisons Plan Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSignal Comparison`/world/versions/{version_id}/traffic/comparisons/{comparison_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-signal_comparison_world_versions__version_id__traffic_comparisons__comparison_id__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "comparison_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comparison Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Signal Comparison World Versions Version Id Traffic Comparisons Comparison Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETPlan Signal Comparison`/world/versions/{version_id}/traffic/comparisons/plan`** What a start would do, writing nothing and playing no episode: the town's signals, the models offered for a signal's decisions, the development seeds this server holds and, for the selection the query names (model as /, once or twice; signal for a named group, every signal where none is named; bound_usd for the bound a start would state), the runs it plans and the most it can cost, or the refusal a start of it would meet, by the same predicates a start's allowance and grant checks read (Services.allowance_refusal, Services.bound_room_refusal). Without a bound, the grant is judged on the calls the selection can make alone. Required permissions: world.read [Link to this operation](/docs/api-reference#api-plan_signal_comparison_world_versions__version_id__traffic_comparisons_plan_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "model", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "maxItems": 2, "default": [], "title": "Model" } }, { "name": "control", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Control" } }, { "name": "seeds", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 64, "minimum": 1, "default": 1, "title": "Seeds" } }, { "name": "signal", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "maxItems": 64, "default": [], "title": "Signal" } }, { "name": "bound_usd", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{1,6}(\\.[0-9]{1,8})?$" }, { "type": "null" } ], "title": "Bound Usd" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Plan Signal Comparison World Versions Version Id Traffic Comparisons Plan Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCancel Society Comparison`/world/versions/{version_id}/society/comparisons/{comparison_id}/cancel`** Cancel a comparison started from the application, once. A start no host holds closes now: every run left open fails as comparison_cancelled, asking nothing, and what a host whose lease ran out may have spent is presumed as a takeover presumes it. A start a host is playing is closed by that host before its next dispatch. Its durable bounds, where it spends under them, are closed once the cancellation is recorded, so the authority refuses an ask a host sends after it. A repeated cancel changes nothing, and a finished start keeps its own closing. Answers the comparison as the listing states it. Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-cancel_society_comparison_world_versions__version_id__society_comparisons__comparison_id__cancel_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "comparison_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comparison Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Cancel Society Comparison World Versions Version Id Society Comparisons Comparison Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTCancel Signal Comparison`/world/versions/{version_id}/traffic/comparisons/{comparison_id}/cancel`** Cancel a signal comparison started from the application, once, as a comparison of people is cancelled: a start no host holds closes now, its open runs failed as comparison_cancelled asking nothing, with what a host whose lease ran out may have spent presumed; a host playing it stops before its next ask. Its durable bounds, where it spends under them, are closed once the cancellation is recorded. A repeated cancel changes nothing, and a finished start keeps its own closing. Answers the comparison as the listing states it. Required permissions: model.invoke, world.write [Link to this operation](/docs/api-reference#api-cancel_signal_comparison_world_versions__version_id__traffic_comparisons__comparison_id__cancel_post). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "comparison_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comparison Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Cancel Signal Comparison World Versions Version Id Traffic Comparisons Comparison Id Cancel Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSociety Comparison Run`/world/versions/{version_id}/society/comparisons/{comparison_id}/runs/{run_id}`** One run as the page draws it. A day's run is read one hour at a time (hour, its first where none is named): the hour replayed from the state the hour before it sealed, its genesis for the first, from the receipts the hour recorded, held to the hour's record, and drawn as an hour's run is, with where the hour lies in the day. An hour the window does not hold is refused (hour_not_in_window), and one the run has not sealed is run_not_completed. Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_comparison_run_world_versions__version_id__society_comparisons__comparison_id__runs__run_id__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "comparison_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comparison Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "hour", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Hour" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Society Comparison Run World Versions Version Id Society Comparisons Comparison Id Runs Run Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSignal Comparison Run`/world/versions/{version_id}/traffic/comparisons/{comparison_id}/runs/{run_id}`** One run's outcome and every choice point's receipt, as recorded; no replay. Required permissions: world.read [Link to this operation](/docs/api-reference#api-signal_comparison_run_world_versions__version_id__traffic_comparisons__comparison_id__runs__run_id__get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "comparison_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comparison Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Signal Comparison Run World Versions Version Id Traffic Comparisons Comparison Id Runs Run Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSociety Comparison Run Day`/world/versions/{version_id}/society/comparisons/{comparison_id}/runs/{run_id}/day`** A day's run over every hour it sealed, from its sealed hours alone, with no replay: each hour's terms for the group and what its asking took, and every person's minutes, coded as the run's drawing classifies a minute, with the activities and places the codes name, so two runs' days can be set side by side minute by minute without drawing every hour. Answered for a run still playing or one that failed too, over the hours it sealed; the inputs' rights are asked before anything drawn from them is answered. A comparison whose window is an hour is comparison_not_a_day. Required permissions: world.read [Link to this operation](/docs/api-reference#api-society_comparison_run_day_world_versions__version_id__society_comparisons__comparison_id__runs__run_id__day_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "comparison_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comparison Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Society Comparison Run Day World Versions Version Id Society Comparisons Comparison Id Runs Run Id Day Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETReplay Signal Comparison Run`/world/versions/{version_id}/traffic/comparisons/{comparison_id}/runs/{run_id}/replay`** A completed run played again from what it stored, asking no model, held to its record. Required permissions: world.read [Link to this operation](/docs/api-reference#api-replay_signal_comparison_run_world_versions__version_id__traffic_comparisons__comparison_id__runs__run_id__replay_get). ```json { "parameters": [ { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Version Id" } }, { "name": "comparison_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Comparison Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Run Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Replay Signal Comparison Run World Versions Version Id Traffic Comparisons Comparison Id Runs Run Id Replay Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. ## Agent Integration Grant an outside agent a turn or ask the Companion. **GETWhat a person's worlds can connect to: each one's words, mark and guide, by kind.`/integrations`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-integrations_catalog_integrations_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Integrations Catalog Integrations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTResolve a Selection to captures, entities and evidence.`/selection`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-resolve_selection_selection_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectionPlan" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectionView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETBridges`/door/bridges`** The bridges this deployment offers this workspace, in words, and who runs each. Required permissions: world.read [Link to this operation](/docs/api-reference#api-bridges_door_bridges_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Bridges Door Bridges Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTIssue Grant`/door/grants`** Issue a grant in one world for one bridge, or answer with the one this key issued. Required permissions: door.grant, world.write [Link to this operation](/docs/api-reference#api-issue_grant_door_grants_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exulanica__api__routes__door__IssueBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Issue Grant Door Grants Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWorld Grants`/door/grants`** The grants issued in one world, newest first, at most limit, each as it stands now, and next, the before that reads the page after them (null after the last): the first page holds every grant that may still stand. Reading a page settles the first of its grants that ran out with something left to settle. Required permissions: world.read [Link to this operation](/docs/api-reference#api-world_grants_door_grants_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Before" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response World Grants Door Grants Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETGrant`/participation/{grant_id}`** Required permissions: world.enter [Link to this operation](/docs/api-reference#api-grant_participation__grant_id__get). ```json { "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Grant Participation Grant Id Get" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETNotice`/participation/notice`** Required permissions: world.enter [Link to this operation](/docs/api-reference#api-notice_participation_notice_get). ```json { "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Notice Participation Notice Get" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRedeem`/participation/redeem`** Required permissions: world.enter [Link to this operation](/docs/api-reference#api-redeem_participation_redeem_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exulanica__api__routes__participation__RedeemBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Redeem Participation Redeem Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRead one utterance as a plan of exact world requests, or decline to. Changes nothing.`/selection/actions`** Required permissions: model.invoke, world.read [Link to this operation](/docs/api-reference#api-plan_actions_selection_actions_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionPlanView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRead one utterance as a bounded appearance proposal, or decline to.`/selection/appearance`** Required permissions: model.invoke, world.read [Link to this operation](/docs/api-reference#api-appearance_selection_appearance_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppearanceRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppearanceView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAnswer a question, citing evidence, or decline to answer.`/selection/ask`** Required permissions: library.read, model.invoke [Link to this operation](/docs/api-reference#api-ask_selection_ask_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exulanica__api__routes__selection__AnswerView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe named entities this session may filter by.`/selection/catalogue`** What the interface offers as filter chips, and what the planner is allowed to reference. Named entities only. An entity with no name is one the user has not identified, and offering it as a filter would be offering to filter by somebody they have never met by name. Required permissions: library.read [Link to this operation](/docs/api-reference#api-catalogue_selection_catalogue_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntityView" }, "title": "Response Catalogue Selection Catalogue Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPropose one typed NYC environment edit without changing world state.`/selection/environment`** Required permissions: model.invoke, world.read [Link to this operation](/docs/api-reference#api-environment_proposal_selection_environment_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentProposalRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentProposalResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTThe evidence a Selection would offer, without composing text.`/selection/packet`** The deterministic half of the answer path, exposed on its own. Useful to the interface, which can show what a question found without spending a model call, and useful to an evaluation run, which needs the retrieval measured separately from the composition. Required permissions: library.read [Link to this operation](/docs/api-reference#api-packet_selection_packet_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectionPlan" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Packet Selection Packet Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETList confirmed canonical-to-memory place bridges.`/selection/place-bridges`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-place_bridges_selection_place_bridges_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaceBridgeView" }, "title": "Response Place Bridges Selection Place Bridges Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTConfirm a canonical-to-memory place bridge.`/selection/place-bridges`** Required permissions: library.write [Link to this operation](/docs/api-reference#api-confirm_place_bridge_selection_place_bridges_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceBridgeRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceBridgeView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPropose a Selection from a question. Does not run it.`/selection/plan`** Required permissions: library.read, model.invoke [Link to this operation](/docs/api-reference#api-plan_from_question_selection_plan_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectionPlan" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTIssue`/world/invitations`** Required permissions: door.grant, world.write [Link to this operation](/docs/api-reference#api-issue_world_invitations_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exulanica__api__routes__participation__IssueBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Issue World Invitations Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETInvitations`/world/invitations`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-invitations_world_invitations_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Invitations World Invitations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTKeep an answer that has already been shown, so a reload does not ask again.`/companion/memory/answers`** Required permissions: library.write [Link to this operation](/docs/api-reference#api-record_answer_companion_memory_answers_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exulanica__api__routes__companion__AnswerView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTKeep an escape, so its cooldown outlives the page it was taken on.`/companion/memory/escapes`** Required permissions: library.write [Link to this operation](/docs/api-reference#api-record_escape_companion_memory_escapes_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EscapeBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EscapeView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhat this Companion asked you, what it answered, and what you told it to leave alone.`/companion/memory/recent`** Required permissions: library.read [Link to this operation](/docs/api-reference#api-recent_companion_memory_recent_get). ```json { "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAnswer`/door/channel/answers`** Answer one open ask of this grant with one of the labels it offered. Channel: grant [Link to this operation](/docs/api-reference#api-answer_door_channel_answers_post). ```json { "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelAnswerBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Answer Door Channel Answers Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTArrive`/door/channel/arrivals`** Send a visitor into the grant's world version: it arrives at the world's next minute. Channel: grant [Link to this operation](/docs/api-reference#api-arrive_door_channel_arrivals_post). ```json { "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrivalBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Arrive Door Channel Arrivals Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETFrames`/door/channel/frames`** What was sent to this grant after the cursor, held up to the bridge's hold for something. Channel: grant [Link to this operation](/docs/api-reference#api-frames_door_channel_frames_get). ```json { "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Frames Door Channel Frames Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTGone`/door/channel/gone`** Say the person behind one of the grant's visitors left the game. Channel: grant [Link to this operation](/docs/api-reference#api-gone_door_channel_gone_post). ```json { "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoneBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Gone Door Channel Gone Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTHello`/door/channel/hello`** Present the adapter, its mapping and the program's own words for this grant. Channel: grant [Link to this operation](/docs/api-reference#api-hello_door_channel_hello_post). ```json { "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelloBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Hello Door Channel Hello Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTHome`/door/channel/home`** Call one of the grant's visitors home at the world's next minute, as its player asked. Channel: grant [Link to this operation](/docs/api-reference#api-home_door_channel_home_post). ```json { "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Home Door Channel Home Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne Grant`/door/grants/{grant_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-one_grant_door_grants__grant_id__get). ```json { "parameters": [ { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response One Grant Door Grants Grant Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRedeem`/door/invites/redeem`** Redeem one invite, as the bridge whose credential is presented, for a channel credential. Channel: bridge [Link to this operation](/docs/api-reference#api-redeem_door_invites_redeem_post). ```json { "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exulanica__api__routes__door__RedeemBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Redeem Door Invites Redeem Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTLeave`/participation/{grant_id}/leave`** Required permissions: world.enter [Link to this operation](/docs/api-reference#api-leave_participation__grant_id__leave_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETSociety`/participation/{grant_id}/society`** Required permissions: world.enter [Link to this operation](/docs/api-reference#api-society_participation__grant_id__society_get). ```json { "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Society Participation Grant Id Society Get" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWorld`/participation/{grant_id}/world`** Required permissions: world.enter [Link to this operation](/docs/api-reference#api-world_participation__grant_id__world_get). ```json { "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response World Participation Grant Id World Get" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTWhat the authorities recorded for a plan's steps, read back. Changes nothing.`/selection/actions/outcome`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-action_outcomes_selection_actions_outcome_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutcomeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionOutcomeView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPrepare typed actions as a plan, with no model. Changes nothing.`/selection/actions/prepare`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-prepare_actions_selection_actions_prepare_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionPlanView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTOutcome`/selection/world-drafts/outcome`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-outcome_selection_world_drafts_outcome_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutcomeBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTPrepare`/selection/world-drafts/prepare`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-prepare_selection_world_drafts_prepare_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Prepare Selection World Drafts Prepare Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETInvitation`/world/invitations/{grant_id}`** Required permissions: world.read [Link to this operation](/docs/api-reference#api-invitation_world_invitations__grant_id__get). ```json { "parameters": [ { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Invitation World Invitations Grant Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETEDelete one memory, and every correction of it, for good.`/companion/memory/answers/{answer_id}`** Required permissions: deletion.write [Link to this operation](/docs/api-reference#api-delete_answer_companion_memory_answers__answer_id__delete). ```json { "parameters": [ { "name": "answer_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Answer Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETCrossing Manifest`/door/crossings/{arrival_id}/manifest`** What came across with one visitor and what stayed behind: the translation manifest its arrival into this world (into the society version_id holds, when it is named) named, as the door kept it, with its digest, and the bridge it came through in the words the deployment declares for it (null for a bridge it no longer declares). One answer for an id that names no arrival there. Required permissions: world.read [Link to this operation](/docs/api-reference#api-crossing_manifest_door_crossings__arrival_id__manifest_get). ```json { "parameters": [ { "name": "arrival_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Arrival Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "version_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Version Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Crossing Manifest Door Crossings Arrival Id Manifest Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTChannel Credential`/door/grants/{grant_id}/channel-credentials`** A channel credential for a standing grant, shown once: for a program its owner runs, or a server bridge declared for this workspace alone. Required permissions: door.grant, world.write [Link to this operation](/docs/api-reference#api-channel_credential_door_grants__grant_id__channel_credentials_post). ```json { "parameters": [ { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Channel Credential Door Grants Grant Id Channel Credentials Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTInvite`/door/grants/{grant_id}/invites`** A one-use invite to a standing grant of a server bridge, shown once, for a player of its bridge to use. Required permissions: door.grant, world.write [Link to this operation](/docs/api-reference#api-invite_door_grants__grant_id__invites_post). ```json { "parameters": [ { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Invite Door Grants Grant Id Invites Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRevoke Grant`/door/grants/{grant_id}/revoke`** End a grant now. Revoking twice changes nothing. Required permissions: door.grant, world.write [Link to this operation](/docs/api-reference#api-revoke_grant_door_grants__grant_id__revoke_post). ```json { "parameters": [ { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Revoke Grant Door Grants Grant Id Revoke Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTSend Away`/door/grants/{grant_id}/send-away`** Send one of a grant's visitors home at the world's next minute, as its owner. Required permissions: door.grant, world.write [Link to this operation](/docs/api-reference#api-send_away_door_grants__grant_id__send_away_post). ```json { "parameters": [ { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAwayBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Send Away Door Grants Grant Id Send Away Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRevoke a confirmed canonical-to-memory place bridge.`/selection/place-bridges/{decision_id}/revoke`** Required permissions: deletion.write [Link to this operation](/docs/api-reference#api-revoke_place_bridge_selection_place_bridges__decision_id__revoke_post). ```json { "parameters": [ { "name": "decision_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Decision Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceBridgeRevocationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceBridgeView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRevoke`/world/invitations/{grant_id}/revoke`** Required permissions: door.grant, world.write [Link to this operation](/docs/api-reference#api-revoke_world_invitations__grant_id__revoke_post). ```json { "parameters": [ { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Revoke World Invitations Grant Id Revoke Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTSay what the answer should have been. The old one is superseded, never rewritten.`/companion/memory/answers/{answer_id}/corrections`** Required permissions: library.write [Link to this operation](/docs/api-reference#api-correct_answer_companion_memory_answers__answer_id__corrections_post). ```json { "parameters": [ { "name": "answer_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Answer Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorrectionBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exulanica__api__routes__companion__AnswerView" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTDelivered`/door/channel/departures/{departure_id}/delivered`** Report what the game delivered of what a departed visitor carried home. Channel: grant [Link to this operation](/docs/api-reference#api-delivered_door_channel_departures__departure_id__delivered_post). ```json { "parameters": [ { "name": "departure_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Departure Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Delivered Door Channel Departures Departure Id Delivered Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTRevoke Credentials`/door/grants/{grant_id}/credentials/revoke`** End every live invite and channel credential of a grant now, without ending the grant: after a credential leaked, the owner ends them all and gives the bridge a new one. Required permissions: door.grant, world.write [Link to this operation](/docs/api-reference#api-revoke_credentials_door_grants__grant_id__credentials_revoke_post). ```json { "parameters": [ { "name": "grant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Grant Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Revoke Credentials Door Grants Grant Id Credentials Revoke Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETFile`/participation/{grant_id}/world/files/{sha256}`** Required permissions: world.enter [Link to this operation](/docs/api-reference#api-file_participation__grant_id__world_files__sha256__get). ```json { "parameters": [ { "name": "sha256", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$", "title": "Sha256" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETTile`/participation/{grant_id}/world/tiles/{baked_tile_id}/bytes`** Required permissions: world.enter [Link to this operation](/docs/api-reference#api-tile_participation__grant_id__world_tiles__baked_tile_id__bytes_get). ```json { "parameters": [ { "name": "baked_tile_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Baked Tile Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. ## Authentication Authenticate a browser session or admit a guest. **POSTGuest Entry`/auth/guest`** Enter as a guest: an account with no identity, a workspace of its own and a session. After the account's transaction commits, the workspace is given its allowance by the spending authority's guest policy and its first world from the installation's arrival list, dressed with the scene the list names for it, if any. Any of these can fail without undoing the entry, so once the account exists the answer is always 201 with the session cookie, and incomplete names each step that failed (allowance with the refusal's code, arrival, or scene with its code and, for one being's mind, its thing_id). A visitor whose allowance is missing is granted it on their next session read (GET /auth/session). Authentication: makes a guest's account, workspace and session; there is no credential yet, and it checks its own origin, entry code and day's limit [Link to this operation](/docs/api-reference#api-guest_entry_auth_guest_post). ```json { "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/GuestEntryBody" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTLogout`/auth/logout`** Authentication: ends the browser session its own cookie names, and must work for any holder of it [Link to this operation](/docs/api-reference#api-logout_auth_logout_post). ```json { "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETAccount Session`/auth/session`** The browser's session: its account, workspace, role and CSRF token. A signed-out browser is answered 401 (authentication_failed), and a server with no browser accounts 503 (account_unavailable); both answers also carry sign_in, how a browser may come in here: google (true or false) and guest (code when POST /auth/guest takes the entry code, open when it takes none, off when it admits nobody new). An answer without sign_in is one whose server could not read its own configuration. Where this host states the day it keeps what is made on it until (EXULANICA_HOST_KEEPS_UNTIL), both answers carry it as host_keeps_until (YYYY-MM-DD), so the gate says it before a guest comes in; where it states none, they leave it out. Authentication: reports the browser session its own cookie names, and refuses without one [Link to this operation](/docs/api-reference#api-account_session_auth_session_get). ```json { "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETGoogle Callback`/auth/google/callback`** Authentication: completes sign-in against its own login cookie, provider state and origin check [Link to this operation](/docs/api-reference#api-google_callback_auth_google_callback_get). ```json { "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETGoogle Start`/auth/google/start`** Authentication: begins Google sign-in; there is no credential yet, and it sets only a login cookie [Link to this operation](/docs/api-reference#api-google_start_auth_google_start_get). ```json { "parameters": [ { "name": "return_uri", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ], "title": "Return Uri" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. ## Installation Check server readiness, worker queues, and spending bounds. **GETLiveness. Touches no dependency.`/healthz`** Public: a liveness probe that needed a credential would go red when the credential rotated [Link to this operation](/docs/api-reference#api-healthz_healthz_get). ```json { "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Healthz Healthz Get" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETReadiness. One query, one object-store call, no model call.`/readyz`** Report each check separately, and return 503 when any of them fails. Separately, because a single boolean tells an operator at 3am that something is wrong and nothing about which thing. The checks are the ones section 6.2 lists, and each one's entry says what it proves rather than only whether it passed. checked_at and age_ms say when the checks ran; capacity gives the declared limits, and GET /operations/capacity the counts. Public: the same, and it reports no workspace content [Link to this operation](/docs/api-reference#api-readyz_readyz_get). ```json { "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Readyz Readyz Get" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhat this workspace may still spend on hosted models, by provider.`/spending`** Required permissions: operations.read [Link to this operation](/docs/api-reference#api-spending_spending_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Spending Spending Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETHow much of each capacity class this API process holds now.`/operations/capacity`** This process's admission limits and counts, and the decode bound's. Counts for the whole process, never another workspace's id; workspace_in_flight is the caller's own. This read is itself a request, so the requests class's in_flight includes it. Another API process keeps counts of its own (docs/deployment.md section 5.4). Required permissions: operations.read [Link to this operation](/docs/api-reference#api-capacity_operations_capacity_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Capacity Operations Capacity Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETMeasured derivative queue health for this workspace.`/operations/derivative-jobs`** Required permissions: operations.read [Link to this operation](/docs/api-reference#api-jobs_operations_derivative_jobs_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Jobs Operations Derivative Jobs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhat this installation runs, its identity, and what each component can do now.`/operations/installation`** The installation facts document, exulanica.installation-facts/v1. Installation-wide rather than one workspace's: code revision, image digests, the configuration fingerprint, component states and recovery times. None of it is workspace content, and none of it is a setting's value. Unauthenticated readiness carries only the component states. Required permissions: operations.read [Link to this operation](/docs/api-reference#api-installation_operations_installation_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Installation Operations Installation Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAdmit Benchmark`/operations/reconstruction-admission`** Required permissions: admission.write [Link to this operation](/docs/api-reference#api-admit_benchmark_operations_reconstruction_admission_post). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BenchmarkReview" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Admit Benchmark Operations Reconstruction Admission Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETMeasured reconstruction dependency and queue health for this workspace.`/operations/reconstruction-scenes`** Required permissions: operations.read [Link to this operation](/docs/api-reference#api-reconstruction_scenes_operations_reconstruction_scenes_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reconstruction Scenes Operations Reconstruction Scenes Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETThe GitHub projects that keep this world, as their followers last wrote them.`/world/github-projects`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-world_github_projects_world_github_projects_get). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAsk the project worker to keep a version of this world in a project.`/world/github-projects`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-request_world_github_project_world_github_projects_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequestBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETOne derivative job's state and progress.`/operations/derivative-jobs/{job_id}`** Whether the job is queued, running or finished, and how far it got. 404 unknown_reference for a job this workspace cannot see, identically to one that never existed. The events route beside this one answers an empty replay for both; this is the read that tells an unknown job from one that has not reported yet. Required permissions: operations.read [Link to this operation](/docs/api-reference#api-job_operations_derivative_jobs__job_id__get). ```json { "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Job Operations Derivative Jobs Job Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETExact inputs, state and outputs for one reconstruction build.`/operations/reconstruction-scenes/{job_id}`** Required permissions: operations.read [Link to this operation](/docs/api-reference#api-reconstruction_scene_detail_operations_reconstruction_scenes__job_id__get). ```json { "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Reconstruction Scene Detail Operations Reconstruction Scenes Job Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETWhether this server keeps worlds, and how many of the workspace's are on GitHub.`/world/github-projects/kept`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-world_github_keeping_world_github_projects_kept_get). ```json { "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTAsk the project worker to put a project it keeps on the person's own GitHub.`/world/github-projects/publications`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-request_world_github_publication_world_github_projects_publications_post). ```json { "parameters": [ { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationRequestBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **GETDurable delivery replay for one derivative job.`/operations/derivative-jobs/{job_id}/events`** Required permissions: operations.read [Link to this operation](/docs/api-reference#api-job_events_operations_derivative_jobs__job_id__events_get). ```json { "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "title": "Response Job Events Operations Derivative Jobs Job Id Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTMake one retryable failed reconstruction build immediately eligible.`/operations/reconstruction-scenes/{job_id}/retry`** Required permissions: operations.write [Link to this operation](/docs/api-reference#api-retry_reconstruction_scene_operations_reconstruction_scenes__job_id__retry_post). ```json { "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Retry Reconstruction Scene Operations Reconstruction Scenes Job Id Retry Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **DELETEWithdraw a request to keep this world in a project.`/world/github-projects/requests/{request_id}`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-withdraw_world_github_project_request_world_github_projects_requests__request_id__delete). ```json { "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$", "title": "Request Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data. **POSTSay yes to the review of putting a project on GitHub: the worker creates it.`/world/github-projects/publications/{request_id}/create`** Required permissions: world.write [Link to this operation](/docs/api-reference#api-create_world_github_publication_world_github_projects_publications__request_id__create_post). ```json { "parameters": [ { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$", "title": "Request Id" } }, { "name": "world_id", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "title": "World Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationCreateBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } ``` Schema references resolve in the complete OpenAPI download. This is a contract definition, not example response data.