Narrative

Create or replace a narrative by id

Changed on
put/api/v2/narrative/{id}

Request

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

Path parameters

idstring uuid required

The narrative's id (a malformed id is a 422).

Headers

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 ''.

storystring nullable

Content of the narrative, as told or remembered. null stores ''.

consequencesstring nullable

Outcomes or legacy of the narrative. null stores ''.

start_dateinteger nullable

Date when the narrative begins, measured in world TIME units.

end_dateinteger nullable

Date when the narrative ends, measured in world TIME units.

orderinteger nullable

Position of this narrative within a parent narrative's sequence.

parent_narrativestring uuid nullable

Larger narrative that this narrative takes place in. Links a Narrative: an existing one in this world.

protagoniststring uuid nullable

Primary character of the narrative. Links a Character: an existing one in this world.

antagoniststring uuid nullable

Opposing character of the narrative. Links a Character: an existing one in this world.

narratorstring uuid nullable

Character credited with telling or recording the narrative. Links a Character: an existing one in this world.

conservatorstring uuid nullable

Institution that preserves or curates the narrative. Links an Institution: an existing one in this world.

eventsstring[] nullable

Events relevant to the narrative. Links Event elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

charactersstring[] nullable

Characters relevant to the narrative. Links Character elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

objectsstring[] nullable

Objects relevant to the narrative. Links Object elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

locationsstring[] nullable

Locations relevant to the narrative. Links Location elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

speciesstring[] nullable

Species relevant to the narrative. Links Species elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

creaturesstring[] nullable

Creatures relevant to the narrative. Links Creature elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

institutionsstring[] nullable

Institutions relevant to the narrative. Links Institution elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

traitsstring[] nullable

Traits relevant to the narrative. Links Trait elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

collectivesstring[] nullable

Groups relevant to the narrative. Links Collective elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

zonesstring[] nullable

Zones relevant to the narrative. Links Zone elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

abilitiesstring[] nullable

Abilities relevant to the narrative. Links Ability elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

phenomenastring[] nullable

Phenomena relevant to the narrative. Links Phenomenon elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

languagesstring[] nullable

Languages relevant to the narrative. Links Language elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

familiesstring[] nullable

Families relevant to the narrative. Links Family elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

relationsstring[] nullable

Relationships relevant to the narrative. Links Relation elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

titlesstring[] nullable

Titles relevant to the narrative. Links Title elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

constructsstring[] nullable

Constructs relevant to the narrative. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

lawsstring[] nullable

Laws relevant to the narrative. Links Law 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

Replaced: the full element.

type'narrative' 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.

storystring required

Content of the narrative, as told or remembered.

consequencesstring required

Outcomes or legacy of the narrative.

start_dateinteger nullable required

Date when the narrative begins, measured in world TIME units.

end_dateinteger nullable required

Date when the narrative ends, measured in world TIME units.

orderinteger nullable required

Position of this narrative within a parent narrative's sequence.

parent_narrativestring uuid nullable required

Larger narrative that this narrative takes place in. A Narrative's id.

protagoniststring uuid nullable required

Primary character of the narrative. A Character's id.

antagoniststring uuid nullable required

Opposing character of the narrative. A Character's id.

narratorstring uuid nullable required

Character credited with telling or recording the narrative. A Character's id.

conservatorstring uuid nullable required

Institution that preserves or curates the narrative. An Institution's id.

eventsstring[] required

Events relevant to the narrative. Event ids.

charactersstring[] required

Characters relevant to the narrative. Character ids.

objectsstring[] required

Objects relevant to the narrative. Object ids.

locationsstring[] required

Locations relevant to the narrative. Location ids.

speciesstring[] required

Species relevant to the narrative. Species ids.

creaturesstring[] required

Creatures relevant to the narrative. Creature ids.

institutionsstring[] required

Institutions relevant to the narrative. Institution ids.

traitsstring[] required

Traits relevant to the narrative. Trait ids.

collectivesstring[] required

Groups relevant to the narrative. Collective ids.

zonesstring[] required

Zones relevant to the narrative. Zone ids.

abilitiesstring[] required

Abilities relevant to the narrative. Ability ids.

phenomenastring[] required

Phenomena relevant to the narrative. Phenomenon ids.

languagesstring[] required

Languages relevant to the narrative. Language ids.

familiesstring[] required

Families relevant to the narrative. Family ids.

relationsstring[] required

Relationships relevant to the narrative. Relation ids.

titlesstring[] required

Titles relevant to the narrative. Title ids.

constructsstring[] required

Constructs relevant to the narrative. Construct ids.

lawsstring[] required

Laws relevant to the narrative. Law 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, and its type's public fields (none for a narrative); 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 what it keeps. 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, whatever its public fields. Read-only: a write carrying known_of is refused (known_of_not_writable).

Changes

  • 78df39c4c62eRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

  • 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

    • info

      added the optional property to the response with the status