Character

Get one character

Changed on
get/api/v2/character/{id}

Request

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

Path parameters

idstring uuid required

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

Query parameters

expandstring[]

Comma-separated link fields whose ids are replaced by ElementStub objects (one level deep). A field that is not a link is a 422.

fieldsstring[]

Comma-separated sparse fieldset: only these keys are returned, so type never and id only when named. Accepts: id, name, description, supertype, subtype, image_url, physicality, mentality, background, motivations, reputation, height, weight, birth_date, charisma, coercion, competence, compassion, creativity, courage, level, hit_points, STR, DEX, CON, INT, WIS, CHA, birthplace, location, species, traits, abilities, languages, objects, institutions, family, friends, rivals, created_at, updated_at, change_seq, created_by, changed_by, changed_via, or any extension field name. Anything else is a 422. With expand, a link is expanded only if it is also named here.

asstring

View as (the owner's keys only: a key with no member): read as another reader would. A membership id of this world (a person, an agent seat or a player seat) reads as that member's own key, its own creations included; a Character id reads as a guest of that Character with no membership (what it knows, the roster, nothing counted as its own); public reads everything that is not hidden. A hidden element is the plain 404, never a 410. An unknown value is a 422 (param as); a member key sending it is a 403 view_as_owner_only. Writes, /changes, /members, /me, the world and the files routes do not take it (422).

Response

The element. With ?fields= the body holds only the named keys (not this schema's required set); with ?expand= each named link holds ElementStub objects instead of ids.

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

physicalitystring required

The character's visible physical features and body attributes.

mentalitystring required

The character's mindset, emotional tone, and style of thinking.

backgroundstring required

History, upbringing, or formative experiences of the character.

motivationsstring required

Core desires, goals, or values that drive the character's choices and behavior.

reputationstring required

Brief summary of the character's current condition, role, or predicament.

heightinteger nullable required

The character's approximate or exact height, in the world's length unit (World length_unit).

weightinteger nullable required

The character's approximate or exact weight, in the world's mass unit (World mass_unit).

birth_dateinteger nullable required

Moment of birth, expressed in the world's TIME units.

charismainteger nullable required

Ability to attract, inspire, and influence others.

coercioninteger nullable required

Capacity to dominate, intimidate, or apply force to shape outcomes.

competenceinteger nullable required

Skill in planning, understanding, and managing complex systems or situations.

compassioninteger nullable required

Willingness to empathize with and care for others.

creativityinteger nullable required

Ability to generate novel ideas, perspectives, or solutions.

courageinteger nullable required

Readiness to face danger, risk, or adversity.

levelinteger nullable required

Progression rank of the character in a game system.

hit_pointsinteger nullable required

Total health available to the character.

STRinteger nullable required

Physical force and carrying capacity.

DEXinteger nullable required

Agility, coordination, and reflexes.

CONinteger nullable required

Endurance and resistance to strain.

INTinteger nullable required

Reasoning, memory, and learning.

WISinteger nullable required

Intuition, awareness, and judgment.

CHAinteger nullable required

Persuasiveness and personal magnetism.

birthplacestring uuid nullable required

Location where the character was born. A Location's id.

locationstring uuid nullable required

The character's present physical location. A Location's id.

speciesstring[] required

Species the character might belong to. Species ids.

traitsstring[] required

Traits for notable behavioral, physical, or systemic characteristics. Trait ids.

abilitiesstring[] required

Abilities the character might perform, control, or invoke. Ability ids.

languagesstring[] required

Languages the character can understand, speak, or use for communication. Language ids.

objectsstring[] required

Key objects owned by or symbolically linked to the character. Object ids.

institutionsstring[] required

Institutions the character is affiliated with. Institution ids.

familystring[] required

Families the character belongs to by blood or adoption. Family ids.

friendsstring[] required

Characters the character considers close allies or companions. Character ids.

rivalsstring[] required

Characters the character is in active opposition or competition with. Character 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