Utility Functions

Create Character
Description: Create a new character and get the character ID for it.
Inputs:
Char Name: Name of the character.
Voice: Voice name [MALE/FEMALE].
Backstory: Backstory for the new character.
Outputs:
✅ [On Success]
Char ID: character id for the new character.
⛔ [On Failure] 
Nothing is returned, check logs for details on why it failed.
​
Get All Character IDs
Description: Get a list of character IDs belonging to the user.
Outputs:
✅ [On Success]
Char IDs: list of characters.
⛔ [On Failure] 
Nothing is returned, check logs for details on why it failed.
Get Character Details
Description: Fetch all details of a character including backstory, voice, etc.
Inputs:
Char ID: Character ID for which to fetch all the details.
Outputs:
✅ [On Success]
Character Name: Name of your character. 
Voice Type: Voice name. 
Backstory: Character backstory.
Has Ready Player Me Link: True if the avatar is configured on the website.
Ready Player Me Link: The avatar link to be used to download.
⛔ [On Failure] 
Nothing is returned, check logs for details on why it failed.
Update Character 
Description: Update a particular character.
Inputs:
Char ID: Character ID to be updated.
New Voice: Voice name or [MALE/FEMALE].
New Backstory: Updated backstory.
New Char Name: Name of the character.
For the list of supported voices please refer to the table in Text To Speech API.
To update a subset of properties, such as Voice and Name only, leave the other fields empty and the update will only affect the specified fields with values.
Outputs:
✅ [On Success]
Nothing is returned.
⛔ [On Failure] 
Nothing is returned, check logs for details on why it failed.

Last modified 6mo ago