Characters
Create Character
POST https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters
Initiates the creation of a character that requires subsequent deployment for activation.
The character can't be used in conversation until it is deployed.
Request Body
The character to create.
- Curl
- Response
curl -L -X POST 'https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters/' \
-H 'Grpc-Metadata-X-Authorization-Bearer-Type: studio_api' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic WlpONVlON01ETU5HSQ==' \
-d '{
"defaultCharacterDescription": {
"description": "Fearless warrior",
"motivation": "Likes to fight against dragons",
"givenName": "Axeon the Enchanted"
}
}'
{
"name": "workspaces/magic_world/characters/axeon_the_enchanted-nwosb",
"language": "EN_US",
"defaultCharacterDescription": {
"givenName": "Axeon the Enchanted",
"description": "Fearless warrior",
"pronoun": "PRONOUN_UNSPECIFIED",
"nicknames": [],
"motivation": "Likes to fight against dragons",
"wikipediaUri": "",
"exampleDialog": "",
"exampleDialogStyle": "EXAMPLE_DIALOG_STYLE_UNSPECIFIED",
"personalityAdjectives": [],
"lifeStage": "LIFE_STAGE_UNSPECIFIED",
"hobbyOrInterests": [],
"characterRole": "",
"narrativeActionsEnabled": false,
"customDialogStyles": [],
"flaws": "",
"dialogResponseLength": "DIALOG_RESPONSE_LENGTH_UNSPECIFIED"
},
"defaultCharacterAssets": {
"voice": {
"baseName": "Masculine - US - Alex",
"ttsType": "TTS_TYPE_INWORLD",
"gender": "VOICE_GENDER_MALE",
"pitch": 0,
"speakingRate": 1,
"roboticVoiceFilterLevel": 0
},
"avatarImg": "",
"avatarImgOriginal": "",
"avatarType": "AVATAR_TYPE_INWORLD",
"avatarDisplayImageSource": "AVATAR_DISPLAY_IMAGE_SOURCE_UNSPECIFIED",
"rpmAvatar": {
"rpmModelUri": "",
"rpmImageUri": "",
"rpmImageUriPortrait": "",
"rpmImageUriPosture": ""
},
"innequinAvatar": {
"avatarBackground": "",
"avatarMaterial": "",
"avatarImgUri": "",
"avatarImgOriginalUri": ""
}
},
"initialMood": {
"joy": 0,
"fear": 0,
"trust": 0,
"surprise": 0
},
"personality": {
"positive": 0,
"peaceful": 0,
"open": 0,
"extravert": 0
},
"commonKnowledge": [],
"socialRank": 0,
"scenes": [],
"personalKnowledge": null,
"behavioralContexts": [],
"meta": null,
"emotionalFluidity": 0.5,
"sharePortalInfo": null,
"yamlConfig": "",
"safetyConfig": {
"TOPIC_ADULT_TOPICS": "SAFETY_LEVEL_STRICT_CONTROL",
"TOPIC_ALCOHOL": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_POLITICS": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_PROFANITY": "SAFETY_LEVEL_STRICT_CONTROL",
"TOPIC_RELIGION": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_SUBSTANCE_USE": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_VIOLENCE": "SAFETY_LEVEL_STRICT_CONTROL"
},
"fourthWall": "FOURTH_WALL_CONTAINMENT_DISABLED",
"longTermCoherence": {
"enabled": false
},
"relationship": {
"enabled": false,
"fluidity": 3
},
"cognitiveControl": "COGNITIVE_CONTROL_UNSPECIFIED"
}
Get Character
GET https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters/{character_name}
Get a specific character within a workspace.
Request Body
Specifies what information to include in the response.
- Curl
- Response
curl -L -X GET 'https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters/{character_name}' \
-H 'Grpc-Metadata-X-Authorization-Bearer-Type: studio_api' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic $INWORLD_STUDIO_API_KEY'
{
"name": "workspaces/magic_world/characters/axeon_the_enchanted",
"language": "EN_US",
"defaultCharacterDescription": {
"givenName": "Axeon the Enchanted",
"description": "Likes to sleep.",
"pronoun": "PRONOUN_UNSPECIFIED",
"nicknames": [],
"motivation": "",
"wikipediaUri": "",
"exampleDialog": "",
"exampleDialogStyle": "EXAMPLE_DIALOG_STYLE_UNSPECIFIED",
"personalityAdjectives": [],
"lifeStage": "LIFE_STAGE_UNSPECIFIED",
"hobbyOrInterests": [],
"characterRole": "Warrior",
"narrativeActionsEnabled": false,
"customDialogStyles": [],
"flaws": "",
"dialogResponseLength": "DIALOG_RESPONSE_LENGTH_UNSPECIFIED"
},
"defaultCharacterAssets": {
"voice": {
"baseName": "Masculine - US - Alex",
"ttsType": "TTS_TYPE_INWORLD",
"gender": "VOICE_GENDER_MALE",
"pitch": 0,
"speakingRate": 1,
"roboticVoiceFilterLevel": 0
},
"avatarImg": "",
"avatarImgOriginal": "",
"avatarType": "AVATAR_TYPE_INWORLD",
"avatarDisplayImageSource": "AVATAR_DISPLAY_IMAGE_SOURCE_UNSPECIFIED",
"rpmAvatar": {
"rpmModelUri": "",
"rpmImageUri": "",
"rpmImageUriPortrait": "",
"rpmImageUriPosture": ""
},
"innequinAvatar": {
"avatarBackground": "",
"avatarMaterial": "",
"avatarImgUri": "",
"avatarImgOriginalUri": ""
}
},
"initialMood": {
"joy": 0,
"fear": 0,
"trust": 0,
"surprise": 0
},
"personality": {
"positive": 0,
"peaceful": 0,
"open": 0,
"extravert": 0
},
"commonKnowledge": [],
"socialRank": 0,
"scenes": [],
"personalKnowledge": null,
"behavioralContexts": [],
"meta": null,
"emotionalFluidity": 0.5,
"sharePortalInfo": null,
"yamlConfig": "",
"safetyConfig": {
"TOPIC_ADULT_TOPICS": "SAFETY_LEVEL_STRICT_CONTROL",
"TOPIC_ALCOHOL": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_POLITICS": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_PROFANITY": "SAFETY_LEVEL_STRICT_CONTROL",
"TOPIC_RELIGION": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_SUBSTANCE_USE": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_VIOLENCE": "SAFETY_LEVEL_STRICT_CONTROL"
},
"fourthWall": "FOURTH_WALL_CONTAINMENT_DISABLED",
"longTermCoherence": {
"enabled": false
},
"relationship": {
"enabled": false,
"fluidity": 3
},
"cognitiveControl": "COGNITIVE_CONTROL_UNSPECIFIED"
}
Deploy Character
POST https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters/{character_name}:deploy
Asynchronously deploys the character. The deployment process is managed as a long-running operation (LRO). The progress and result of this operation should be monitored using the returned LRO object. Upon successful completion, all characters will reflect the updates during their interactions. In the event of a failure, the operation should be retried.
- Curl
- Response
curl -L -X POST 'https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters/{character_name}:deploy' \
-H 'Grpc-Metadata-X-Authorization-Bearer-Type: studio_api' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic WlpONVlON01ETU5HSQ=='
{
"name": "workspaces/{workspace_id}/characters/axeon_the_enchanted/operations/{operation_id}",
"metadata": {
"@type": "type.googleapis.com/ai.inworld.studio.v1.DeployCharacterMetadata"
},
"done": false
}
List Characters
GET https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters
Returns a list of characters that can be filtered by several criteria. When using pagination, ensure that all other parameters provided initially remain unchanged.
Filters can be applied to ListCommonKnowledgeRequest. Filters follow the Google AIP-160 guidelines.
- Single Filter: This filter accepts only the full resource name of the character.
For example, to filter a specific character, use
character.name=workspaces/{workspace_id}/character/{uuid}
. - Multiple Filters: You can also combine multiple filters using the 'OR' condition.
For instance, to filter by two different characters,
use
character.name=workspaces/{workspace_id}/character/{uuid1} OR character.name=workspaces/{workspace_id}/character/{uuid2}
.
Request Body
int32
Max number of items to retrieve per page. Default is 50.
string
A page token received from a previous ListCharacterRequest
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCharactersRequest
must remain the same.
Specifies whether standard or with scenes character list will be returned in the response.
string
Character filter. Filters follow the Google AIP-160 guidelines
- Curl
- Response
curl -L -X GET 'https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters' \
-H 'Grpc-Metadata-X-Authorization-Bearer-Type: studio_api' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic WlpONVlON01ETU5HSQ=='
{
"characters": [
{
"name": "workspaces/magic_world/characters/axeon_the_enchanted",
"language": "EN_US",
"defaultCharacterDescription": {
"givenName": "Axeon the Enchanted",
"description": "Likes to sleep.",
"pronoun": "PRONOUN_UNSPECIFIED",
"nicknames": [],
"motivation": "",
"wikipediaUri": "",
"exampleDialog": "",
"exampleDialogStyle": "EXAMPLE_DIALOG_STYLE_UNSPECIFIED",
"personalityAdjectives": [],
"lifeStage": "LIFE_STAGE_UNSPECIFIED",
"hobbyOrInterests": [],
"characterRole": "Warrior",
"narrativeActionsEnabled": false,
"customDialogStyles": [],
"flaws": "",
"dialogResponseLength": "DIALOG_RESPONSE_LENGTH_UNSPECIFIED"
},
"defaultCharacterAssets": {
"voice": {
"baseName": "Masculine - US - Alex",
"ttsType": "TTS_TYPE_INWORLD",
"gender": "VOICE_GENDER_MALE",
"pitch": 0,
"speakingRate": 1,
"roboticVoiceFilterLevel": 0
},
"avatarImg": "",
"avatarImgOriginal": "",
"avatarType": "AVATAR_TYPE_INWORLD",
"avatarDisplayImageSource": "AVATAR_DISPLAY_IMAGE_SOURCE_UNSPECIFIED",
"rpmAvatar": {
"rpmModelUri": "",
"rpmImageUri": "",
"rpmImageUriPortrait": "",
"rpmImageUriPosture": ""
},
"innequinAvatar": {
"avatarBackground": "",
"avatarMaterial": "",
"avatarImgUri": "",
"avatarImgOriginalUri": ""
}
},
"initialMood": {
"joy": 0,
"fear": 0,
"trust": 0,
"surprise": 0
},
"personality": {
"positive": 0,
"peaceful": 0,
"open": 0,
"extravert": 0
},
"commonKnowledge": [],
"socialRank": 0,
"scenes": [],
"personalKnowledge": null,
"behavioralContexts": [],
"meta": null,
"emotionalFluidity": 0.5,
"sharePortalInfo": null,
"yamlConfig": "",
"safetyConfig": {
"TOPIC_ADULT_TOPICS": "SAFETY_LEVEL_STRICT_CONTROL",
"TOPIC_ALCOHOL": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_POLITICS": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_PROFANITY": "SAFETY_LEVEL_STRICT_CONTROL",
"TOPIC_RELIGION": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_SUBSTANCE_USE": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_VIOLENCE": "SAFETY_LEVEL_STRICT_CONTROL"
},
"fourthWall": "FOURTH_WALL_CONTAINMENT_DISABLED",
"longTermCoherence": {
"enabled": false
},
"relationship": {
"enabled": false,
"fluidity": 3
},
"cognitiveControl": "COGNITIVE_CONTROL_UNSPECIFIED"
},
{
"name": "workspaces/magic_world/characters/axeon_the_enchanted-0bhgq",
"language": "EN_US",
"defaultCharacterDescription": {
"givenName": "Axeon the Enchanted",
"description": "Likes to fight in hard battles with a huge axe.",
"pronoun": "PRONOUN_UNSPECIFIED",
"nicknames": [],
"motivation": "",
"wikipediaUri": "",
"exampleDialog": "",
"exampleDialogStyle": "EXAMPLE_DIALOG_STYLE_UNSPECIFIED",
"personalityAdjectives": [],
"lifeStage": "LIFE_STAGE_UNSPECIFIED",
"hobbyOrInterests": [],
"characterRole": "Warrior",
"narrativeActionsEnabled": false,
"customDialogStyles": [],
"flaws": "",
"dialogResponseLength": "DIALOG_RESPONSE_LENGTH_UNSPECIFIED"
},
"defaultCharacterAssets": {
"voice": {
"baseName": "Masculine - US - Alex",
"ttsType": "TTS_TYPE_INWORLD",
"gender": "VOICE_GENDER_MALE",
"pitch": 0,
"speakingRate": 1,
"roboticVoiceFilterLevel": 0
},
"avatarImg": "",
"avatarImgOriginal": "",
"avatarType": "AVATAR_TYPE_INWORLD",
"avatarDisplayImageSource": "AVATAR_DISPLAY_IMAGE_SOURCE_UNSPECIFIED",
"rpmAvatar": {
"rpmModelUri": "",
"rpmImageUri": "",
"rpmImageUriPortrait": "",
"rpmImageUriPosture": ""
},
"innequinAvatar": {
"avatarBackground": "",
"avatarMaterial": "",
"avatarImgUri": "",
"avatarImgOriginalUri": ""
}
},
"initialMood": {
"joy": 0,
"fear": 0,
"trust": 0,
"surprise": 0
},
"personality": {
"positive": 0,
"peaceful": 0,
"open": 0,
"extravert": 0
},
"commonKnowledge": [],
"socialRank": 0,
"scenes": [],
"personalKnowledge": null,
"behavioralContexts": [],
"meta": null,
"emotionalFluidity": 0.5,
"sharePortalInfo": null,
"yamlConfig": "",
"safetyConfig": {
"TOPIC_ADULT_TOPICS": "SAFETY_LEVEL_STRICT_CONTROL",
"TOPIC_ALCOHOL": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_POLITICS": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_PROFANITY": "SAFETY_LEVEL_STRICT_CONTROL",
"TOPIC_RELIGION": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_SUBSTANCE_USE": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_VIOLENCE": "SAFETY_LEVEL_STRICT_CONTROL"
},
"fourthWall": "FOURTH_WALL_CONTAINMENT_DISABLED",
"longTermCoherence": {
"enabled": false
},
"relationship": {
"enabled": false,
"fluidity": 3
},
"cognitiveControl": "COGNITIVE_CONTROL_UNSPECIFIED"
}
],
"nextPageToken": ""
}
Update Character
PATCH https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters/{character_name}
Updates the specified character. Changes to the character are not reflected in conversation until the character is deployed.
Request Body
The character to update.
- Curl
- Response
curl -L -X PATCH 'https://api.inworld.ai/studio/v1/workspaces/{workspace_id}}/characters/{character_name}' \
-H 'Grpc-Metadata-X-Authorization-Bearer-Type: studio_api' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic WlpONVlON01ETU5HSQ==' \
-d '{
"defaultCharacterDescription": {
"description": "Likes to sleep and sing."
}
}'
{
"name": "workspaces/magic_world/characters/axeon_the_enchanted",
"language": "EN_US",
"defaultCharacterDescription": {
"givenName": "Axeon the Enchanted",
"description": "Likes to sleep and sing.",
"pronoun": "PRONOUN_UNSPECIFIED",
"nicknames": [],
"motivation": "",
"wikipediaUri": "",
"exampleDialog": "",
"exampleDialogStyle": "EXAMPLE_DIALOG_STYLE_UNSPECIFIED",
"personalityAdjectives": [],
"lifeStage": "LIFE_STAGE_UNSPECIFIED",
"hobbyOrInterests": [],
"characterRole": "Warrior",
"narrativeActionsEnabled": false,
"customDialogStyles": [],
"flaws": "",
"dialogResponseLength": "DIALOG_RESPONSE_LENGTH_UNSPECIFIED"
},
"defaultCharacterAssets": {
"voice": {
"baseName": "Masculine - US - Alex",
"ttsType": "TTS_TYPE_INWORLD",
"gender": "VOICE_GENDER_MALE",
"pitch": 0,
"speakingRate": 1,
"roboticVoiceFilterLevel": 0
},
"avatarImg": "",
"avatarImgOriginal": "",
"avatarType": "AVATAR_TYPE_INWORLD",
"avatarDisplayImageSource": "AVATAR_DISPLAY_IMAGE_SOURCE_UNSPECIFIED",
"rpmAvatar": {
"rpmModelUri": "",
"rpmImageUri": "",
"rpmImageUriPortrait": "",
"rpmImageUriPosture": ""
},
"innequinAvatar": {
"avatarBackground": "",
"avatarMaterial": "",
"avatarImgUri": "",
"avatarImgOriginalUri": ""
}
},
"initialMood": {
"joy": 0,
"fear": 0,
"trust": 0,
"surprise": 0
},
"personality": {
"positive": 0,
"peaceful": 0,
"open": 0,
"extravert": 0
},
"commonKnowledge": [],
"socialRank": 0,
"scenes": [],
"personalKnowledge": null,
"behavioralContexts": [],
"meta": {
"totalCommonKnowledge": 0,
"goalsVersion": 2
},
"emotionalFluidity": 0.5,
"sharePortalInfo": null,
"yamlConfig": "",
"safetyConfig": {
"TOPIC_ADULT_TOPICS": "SAFETY_LEVEL_STRICT_CONTROL",
"TOPIC_ALCOHOL": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_POLITICS": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_PROFANITY": "SAFETY_LEVEL_STRICT_CONTROL",
"TOPIC_RELIGION": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_SUBSTANCE_USE": "SAFETY_LEVEL_MILD_CONTROL",
"TOPIC_VIOLENCE": "SAFETY_LEVEL_STRICT_CONTROL"
},
"fourthWall": "FOURTH_WALL_CONTAINMENT_DISABLED",
"longTermCoherence": {
"enabled": false
},
"relationship": {
"enabled": false,
"fluidity": 3
},
"cognitiveControl": "COGNITIVE_CONTROL_UNSPECIFIED"
}
Delete Character
DELETE https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters/{character_name}
Delete a specific character within a workspace.
- Curl
- Response
curl -L -X DELETE 'https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters/{character_name}' \
-H 'Grpc-Metadata-X-Authorization-Bearer-Type: studio_api' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic WlpONVlON01ETU5HSQ=='
{}
Check Deployment Status
GET https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters/{character_name}/operations/{operation_id}
Retrieves the current status of a long-running operation. Clients can use it to periodically poll for the operation's result, following the interval recommendations provided by the API service. This approach is useful for tracking the progress and completion status of operations that are not immediately finalized.
- Curl
- Response
curl -L -X GET 'https://api.inworld.ai/studio/v1/workspaces/{workspace_id}/characters/{character_name}/operations/{operation_id}' \
-H 'Grpc-Metadata-X-Authorization-Bearer-Type: studio_api' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic WlpONVlON01ETU5HSQ=='
{
"name": "workspaces/magic_world/characters/axeon_the_enchanted/operations/1704305230737-tww6QY",
"metadata": {
"@type": "type.googleapis.com/ai.inworld.studio.v1.DeployCharacterMetadata"
},
"done": true,
"response": {
"@type": "type.googleapis.com/ai.inworld.studio.v1.DeployCharacterResponse"
}
}
Schemas
Character
string
Immutable. This field can't be set or changed via API. This field can't Automatically generated resource name by the system based on given_name property.
Structured default character description.
Structured list of different assets associated with the character.
Structured character initial mood.
Structured character personality.
string
List of assigned common knowledge references.
float
Character social rank - the insecure/confident slider’s setting. Affects character conversation. For more details.
Scene
The list of linked scenes to the character. This field is propagated only for list characters method when CharacterView::WITH_SCENE is set.
Information that character knows about.
Immutable. This field can't be set or changed via API. Meta character information.
float
Affects character conversation. Range = [0, 1]. 0 - rare emotions change. 1 - frequent emotions change. For more details.
Immutable. This field can't be set or changed via API. Character portal/arcade info.
string
Goals and actions v2. For more details.
List of safety configs. For more details.
Describes character's relationships specification.
Describes degree of cognitive control.
CharacterAssets
Voice
Reference to the voice resource used by that character.
string
Link to uploaded and resized avatar image for character provided by user.
string
Link to uploaded original avatar image for character provided by user.
Avatar type.
Specifies the source from which the 2D avatar image of the character is derived.
RPM avatar.
Innequin avatar.
CharacterDescription
string
Name of the character. Defaults to 'Character' if empty.
string
Free form description to design character's behavior and purpose. Supposed to be composite prompt including NPC info, history and initial scene's state.
Pronoun of the character. Defaults to PRONOUN_UNSPECIFIED.
string
List of commonly used alternative names of this character.
string
Motivation of the character.
string
Uri to wikipedia for well-known character for additional data extraction. For more details
string
Example of character dialog. For more details
Enumerated example dialog style. For more details of dialog style.
string
List of adjectives describing character: "eloquent", "charming", "aggressive"
Specify the stage of life for character.
string
Repeated field of strings representing the character's hobbies or interests.
string
Role of the character.
bool
Indicates if narrated actions and scenarios are enabled on this character. For more details
CustomDialogStyle indicates designs are using a new layout for Character pages.
string
Flaws & Challenges.
Specify dialog style response length.
CharacterInitialMood
int32
Determines Sadness(-100)/Joy(100) mood.
int32
Determines Anger(-100)/Fear(100) mood.
int32
Determines Disgust(-100)/Trust(100) mood.
int32
Determines Anticipation(-100)/Surprise(100) mood.
CharacterPersonality
int32
Determines Negative(-100)/Positive(100).
int32
Determines Aggressive(-100)/Peaceful(100).
int32
Determines Cautious(-100)/Open(100).
int32
Determines Introvert(-100)/Extravert(100).
CustomDialogStyle
string
Universally unique identifier automatically generated by system.
string
The name of the custom dialog style.
bool
Is this custom style enabled or not.
string
The list of available adjectives. Adjectives field should be multi-select (up to 3): anxious, contemplative, curt, expressive, hilarious, inquisitive, intense, mischievous, snarky, sympathetic, talkative unflinching etc
string
The name of the new dialog style: business abbreviations, cowboy lingo, hackneyed cliches, Internet meme slang, medical terminology, movie quotes, obscure idioms, Orwellian newspeak, sports metaphors, technical jargon
Fact
string
Text data of the fact. Max length is 255 symbols.
InnequinAvatar
string
Reference to avatar material asset.
string
Reference to avatar background asset.
string
Uri to store innequin image.
InteractionCountStat
int32
Total log counters.
int32
Total unread log counters.
int32
Total read log counters.
Meta
int32
Immutable. This field can't be set or changed via API. Indicates the amount of common knowledge created in character.
int32
Immutable. This field can't be set or changed via API. Goals version used by character.
PersonalKnowledge
string
Unique (throughout the entire service) universally unique identifier automatically generated by system.
List of facts. Max size 10000.
Relationship
bool
Enables character's relationships.
float
Determines dynamics of relationship changes (-1, 1), where -1 is slow changes and 1 is fast changes.
RpmAvatar
string
Link to the readyplayerme avatar model. To be used in the companion app. Updated through the separate method.
string
Link to the rendered readyplayerme avatar image. Used to display avatar image in studio and companion app. Updated through the separate method.
string
Link to the rendered readyplayerme avatar portrait image. in studio and companion app. Updated through the separate method.
string
Link to rendered readyplayerme avatar posture image. To be used in the in studio and companion app. Updated through the separate method.
SafetyConfigEntry
string
AvatarDisplayImageSource
Determines which 2D image will be displayed for current character.
Name | Number | Description |
---|---|---|
AVATAR_DISPLAY_IMAGE_SOURCE_UNSPECIFIED | 0 | Unspecified. |
RPM_IMAGE | 1 | Use RPM image, that is created from RPM avatar model. |
INNEQUIN_IMAGE | 2 | Use Innequin image that is created from Innequin avatar model. |
USER_PROVIDED_IMAGE | 3 | Use user provided image. |
AvatarType
Possible values of avatar type. Default is AVATAR_TYPE_UNSPECIFIED. Determines which 3D avatar system is used in UI.
Name | Number | Description |
---|---|---|
AVATAR_TYPE_UNSPECIFIED | 0 | Unspecified. |
AVATAR_TYPE_RPM | 1 | RPM. |
AVATAR_TYPE_INWORLD | 2 | inworld/innequin |
CharacterItemView
CharacterDetailView defines what dependency info should be provided in response. For now only Meta(s) part is optional.
Name | Number | Description |
---|---|---|
CHARACTER_ITEM_VIEW_UNSPECIFIED | 0 | Not specified, equivalent to DEFAULT. |
CHARACTER_ITEM_VIEW_DEFAULT | 1 | Character information default. |
CHARACTER_ITEM_VIEW_WITH_META | 2 | Character representation with meta. |
CharacterSharePurpose
CharacterShareType defines the purpose of share the character(where it is expected to be used):
Name | Number | Description |
---|---|---|
CHARACTER_SHARE_PURPOSE_UNSPECIFIED | 0 | Not specified, equivalent to DEFAULT. |
CHARACTER_SHARE_PURPOSE_OCULUS | 1 | Character shared for the oculus device. |
CHARACTER_SHARE_PURPOSE_PORTAL | 2 | Character shared for the portal simulator. |
CharacterView
CharacterView defines what dependency info should be provided in response. For now only Scene(s) part is optional
Name | Number | Description |
---|---|---|
CHARACTER_VIEW_UNSPECIFIED | 0 | Not specified, equivalent to DEFAULT. |
CHARACTER_VIEW_DEFAULT | 1 | Character information without scene information. |
CHARACTER_VIEW_WITH_SCENES | 2 | Character representation with scene. |
CognitiveControl
Specifies degree of cognitive control.
Name | Number | Description |
---|---|---|
COGNITIVE_CONTROL_UNSPECIFIED | 0 | Missing value. |
COGNITIVE_CONTROL_NONE | 1 | None. |
COGNITIVE_CONTROL_MILD | 2 | Mild control. |
COGNITIVE_CONTROL_STRICT | 3 | Strict control. |
ExampleDialogStyle
List of styles for example dialogue.
Name | Number | Description |
---|---|---|
EXAMPLE_DIALOG_STYLE_UNSPECIFIED | 0 | No style specified / unknown. |
EXAMPLE_DIALOG_STYLE_DEFAULT | 1 | The default character dialog is engaging and realistic. |
EXAMPLE_DIALOG_STYLE_BUBBLY | 2 | The dialog style is thoughtful, energetic, and friendly. |
EXAMPLE_DIALOG_STYLE_FORMAL | 3 | The dialog style is formal and matter-of-fact. |
EXAMPLE_DIALOG_STYLE_BLUNT | 4 | The dialog style is short, direct, and to the point. |
EXAMPLE_DIALOG_STYLE_INQUISITIVE | 5 | The dialog style is inquisitive, which will usually include a question. |
EXAMPLE_DIALOG_STYLE_COMMANDING | 6 | The dialog style is intense and determined. |
EXAMPLE_DIALOG_STYLE_EMPATHETIC | 7 | The dialog style is gentle and compassionate. |
EXAMPLE_DIALOG_STYLE_ENTERTAINING | 8 | The dialog style is entertaining, animated, and comical. |
EXAMPLE_DIALOG_STYLE_HYPOCHONDRIAC. | 9 | The dialog style is neurotic and fearful. |
EXAMPLE_DIALOG_STYLE_LAIDBACK | 10 | The dialog style is relaxed, informal, and nonchalant. |
EXAMPLE_DIALOG_STYLE_LONG_WINDED | 11 | The dialog style is verbose and meandering. |
EXAMPLE_DIALOG_STYLE_MORAL | 12 | The dialog style is principled and incorruptible. |
EXAMPLE_DIALOG_STYLE_MYSTERIOUS | 13 | The dialog style is elusive and cryptic. |
EXAMPLE_DIALOG_STYLE_RACONTEUR | 14 | The dialog style is entertaining and descriptive. |
EXAMPLE_DIALOG_STYLE_SARCASTIC | 15 | The dialog style is snide and contemptuous. |
EXAMPLE_DIALOG_STYLE_TENACIOUS | 16 | The dialog style is determined and persistent |
EXAMPLE_DIALOG_STYLE_VILLAINOUS | 17 | The dialog style is sinister and cruel. |
EXAMPLE_DIALOG_STYLE_CUSTOM | 18 | An custom style selected by user and expected to be specified. |
LifeStage
List of life stages for character.
Name | Number | Description |
---|---|---|
LIFE_STAGE_UNSPECIFIED | 0 | No stage of life specified / unknown. |
LIFE_STAGE_ADOLESCENCE | 5 | Adolescence. |
LIFE_STAGE_YOUNG_ADULTHOOD | 6 | Young adulthood. |
LIFE_STAGE_MIDDLE_ADULTHOOD | 7 | Middle adulthood. |
LIFE_STAGE_LATE_ADULTHOOD | 8 | Late adulthood. |
LIFE_STAGE_CHILDHOOD | 9 | Childhood. |
Pronoun
Structure describing the pronounce for the character.
Name | Number | Description |
---|---|---|
PRONOUN_UNSPECIFIED | 0 | No pronoun specified / unknown |
PRONOUN_FEMALE | 1 | She/Her/Hers |
PRONOUN_MALE | 2 | He/Him/His |
PRONOUN_OTHER | 3 | They/Them/Theirs |
SafetyLevel
Topic-based safety aggressiveness level config.
Name | Number | Description |
---|---|---|
SAFETY_LEVEL_UNSPECIFIED | 0 | Missing value. |
SAFETY_LEVEL_NO_CONTROL | 1 | No safety filter is applied to the given topic. |
SAFETY_LEVEL_MILD_CONTROL | 2 | Allows 'level 0' of given topic. |
SAFETY_LEVEL_STRICT_CONTROL | 3 | All filters applied to the given topic. |