This endpoint is called to get the list of characters for a user account. The character list includes information regarding all the characters.
Request
The request body only requires the following header field:
Headers
Field Name
Type
Value / Description
Response
On success, the API will return a nested JSON object in the following format :
No CONVAI-API-KEY provided by the user in the Request.
Invalid CONVAI-API-KEY provided by the user in the Request.
Server Side Failure. Please reach out to support.
Response Field Descriptions
character_name: Name of the character.
user_id: User ID of the user / character owner.
character_id: Unique ID of the character.
voice_type: Voice set for the character.
model_type: Model (Avatar) used by the character.
timestamp: Timestamp when the character was created.
character_actions: Set of actions described by the user for the character.
character_emotions: Set of emotions described by the user for the character.
personalised_prompt_config: Information regarding the model and prompt used by the character at the backend.
language_codes: List of languages supported by the character.
pronunciation_metadata: Information related to the custom pronunciations set for the character.
Sample Code Snippet
import requests
# URL of the API endpoint
url = 'https://api.convai.com/character/list'
# creating the header
headers = {
'CONVAI-API-KEY': '<your api key>',
}
# Make the request
response = requests.post(url, headers=headers)
# Check if the request was successful
if response.status_code == 200:
# Print the response content
print(response.json())
else:
print(f"Failed to retrieve data. Status code: {response.status_code}")
Character List API
API to retrieve the list of characters, created by a user.
