Phenomenon

Create a phenomenon

Changed on
post/api/v2/phenomenon

Request

  • Base URL: https://www.onlyworlds.com
  • URL: https://www.onlyworlds.com/api/v2/phenomenon
  • Auth: API key in header API-Key and API key in header API-Pin

Headers

Idempotency-Keystring

Replays of the same key with the same body return the first successful response (with Idempotent-Replay: true) for 24h; the same key with a different body is a 409 idempotency_error. While the first request with a key is still running, the same key is a 409 idempotency_in_flight: retry after Retry-After.

X-OW-Agentstring

Send it (any non-empty value) when an agent makes this write: the change is recorded with changed_via declared (a delete's tombstone with deleted_via). An agent seat's key and MCP are recorded as agent-made without it. The value is never stored.

Request body

idstring uuid

POST: optional client-minted id (any RFC 4122 UUID; the server mints a UUIDv7 otherwise). PUT/PATCH: ignored, the path id wins.

namestring nullable required

Name of the element. null stores ''.

descriptionstring nullable

Any kind of details about the element. null stores ''.

supertypestring nullable

The top level category to which the element belongs. null stores ''.

subtypestring nullable

The sub level category through which the element is further classified. null stores ''.

image_urlstring nullable

URL to an image representing the element. null stores ''.

expressionstring nullable

How the phenomenon manifests or takes shape in the world. null stores ''.

effectsstring nullable

The primary outcomes or changes caused by the phenomenon. null stores ''.

mythologystring nullable

Cultural, religious, or narrative meaning associated with the phenomenon. null stores ''.

durationinteger nullable

The amount of time the phenomenon lasts, measured in world TIME units.

systemstring uuid nullable

Broader phenomenon that this one is part of or linked to. Links a Phenomenon: an existing one in this world.

catalystsstring[] nullable

Objects or materials that initiate or enhance the phenomenon. Links Object elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

empowermentsstring[] nullable

Abilities that initiate or enhance the phenomenon, or are initiated or enhanced by it. Links Ability elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

triggersstring[] nullable

Conceptual mechanisms or patterns that cause the phenomenon to activate. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

wieldersstring[] nullable

Characters capable of intentionally directing or controlling the phenomenon. Links Character elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

environmentsstring[] nullable

Locations where the phenomenon occurs or is known to manifest. Links Location elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

worldunknown
created_byunknown
changed_byunknown
changed_viaunknown

Response

Created: the full element.

type'phenomenon' required
idstring uuid required
namestring required

Name of the element.

descriptionstring required

Any kind of details about the element.

supertypestring required

The top level category to which the element belongs.

subtypestring required

The sub level category through which the element is further classified.

image_urlstring required

URL to an image representing the element.

expressionstring required

How the phenomenon manifests or takes shape in the world.

effectsstring required

The primary outcomes or changes caused by the phenomenon.

mythologystring required

Cultural, religious, or narrative meaning associated with the phenomenon.

durationinteger nullable required

The amount of time the phenomenon lasts, measured in world TIME units.

systemstring uuid nullable required

Broader phenomenon that this one is part of or linked to. A Phenomenon's id.

catalystsstring[] required

Objects or materials that initiate or enhance the phenomenon. Object ids.

empowermentsstring[] required

Abilities that initiate or enhance the phenomenon, or are initiated or enhanced by it. Ability ids.

triggersstring[] required

Conceptual mechanisms or patterns that cause the phenomenon to activate. Construct ids.

wieldersstring[] required

Characters capable of intentionally directing or controlling the phenomenon. Character ids.

environmentsstring[] required

Locations where the phenomenon occurs or is known to manifest. Location ids.

created_atstring date-time required
updated_atstring date-time required
change_seqinteger required

The world change sequence at this element's last write.

created_bystring uuid nullable required

The world membership that created this element, or null when the world's owner did.

changed_bystring uuid nullable required

The world membership that last changed this element, or null when the world's owner (or the server) did, or no write has touched it since doors were recorded.

changed_via'seat' | 'mcp' | 'declared' | 'api' | 'v1' | 'sync' | 'server' | 'null' nullable required

The door of the last change: seat (an agent seat), mcp (the MCP server), declared (the request sent an X-OW-Agent header), api, v1, sync (the mobile app's sync) or server (the server, on its own behalf). The first three mean an agent made it. Null: no write since doors were recorded.

known_oftrue

Present, and true, only on an element this reader knows of but does not see whole: a guest or player reaches it only because its own Character's sheet links to it (one step out). Such a row keeps id, type, name, description, supertype, subtype, image_url, created_at, updated_at and change_seq; every other field reads as unset (text "", numbers and single links null, multi links [], created_by, changed_by and changed_via null, no extension fields), its files are 404, and search matches only its name and description. Absent: the element is whole. Any other grant (it names the reader's Character, the reader knows it, it is on the roster, the reader made it) makes it whole; a hidden element is never even a stub.

Changes

  • 4dd5b1cd0687Revision changes
    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • info

      added the optional property to the response with the status