Skip to main content
PATCH
Update character details

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

game_id
string
required

The unique identifier for the game.

Example:

"game123"

world_id
string
required

The unique identifier for the world.

Example:

"world456"

character_id
string
required

The unique identifier for the character.

Example:

"character789"

Query Parameters

session_id
string

(Optional) The player's session ID.

Example:

"60Z5aZjIuFlyYbjbZZKe"

Body

application/json

The character data fields to update.

age
enum<string>

The age category of the character.

Available options:
infant,
child,
teenager,
youngAdult,
adult,
middleAged,
elderly
Example:

"adult"

description
string

A brief description of the character.

Example:

"A brave warrior with a mysterious past."

gender
string

The gender of the character.

Example:

"Male"

model
enum<string>

The AI model used to power character interactions. Premium models are available only for some subscriptions.

Available options:
standard,
premium
Example:

"standard"

filters
object

Structured content filters applied to the character's responses. Provide the toggles you want to update when adjusting moderation settings.

Example:
items
object[]

A list of updated items for the character.

Schema for items of type "trade"

events
object[]

A list of events related to the character.

Schema for events of type "action"

name
string

The display name of the character.

Example:

"Aragorn"

quests
object[]

A list of quests associated with the character.

role
enum<string>

The role the character plays in the game.

Available options:
noRole,
protagonist,
antagonist,
secondaryCharacter,
tertiaryCharacter,
mentor,
enemy,
villain,
rival,
shopkeeper,
healer,
questGiver,
innkeeper,
guard,
familyMember,
loveInterest,
scientist,
politician,
criminal,
explorer,
wizard,
ghost,
animalCompanion,
artificialIntelligence
Example:

"protagonist"

tone
enum<string>

The style or mood of the character's dialogue.

Available options:
formal,
casual,
sarcastic,
mysterious,
emotive
Example:

"mysterious"

traits
string[]

Legacy/basic trait list. When provided without personality_theory, the API stores the character as basicTraits.

personality_theory
enum<string>
default:basicTraits

Personality framework used by interactions.

Available options:
basicTraits,
bigFive,
darkTriad,
dndAlignment,
mbti,
enneagram
Example:

"basicTraits"

personality_dimensions
object

Dimension values for the selected personality_theory. basicTraits uses traits and an empty object.

Example:
speech_pattern
object

Optional speech style controls consumed by interactions.

Response

Character updated successfully.

message
string

Confirmation message after updating the character.

Example:

"Character: character789 has been updated with the following context."

character_id
string

UID of the character.

Example:

"character789"

character_context
object

Updated character context data.

Example: