add_narrative_decision
ChatGPTAdd a decision edge between two narrative sections.
attach_function
ChatGPTAttach a Workspace function to a character draft.
clone_character
ChatGPTClone a visible character into the selected Workspace.
connect_knowledge_document
ChatGPTConnect one owned knowledge document to an owned character.
create_character
ChatGPTCreate a character from a name and backstory. Omit model, visibility, voice, and asset fields to use Character API defaults: it picks a plan-eligible voice. Side effect: unless auto_select_assets is false or an experience or avatar is given, it also selects an avatar and scene and creates a draft Experience for them. Settings that create does not accept, such as language hardening, custom guardrails, pronunciations, boosted words, and the narrative flags, are set afterwards with update_character.
create_function
ChatGPTCreate a reusable function in the selected Workspace.
create_narrative_section
ChatGPTCreate a narrative section for an owned character.
create_narrative_trigger
ChatGPTCreate a narrative trigger for an owned character.
delete_character
ChatGPTPermanently delete an owned character and its active metadata.
delete_function
ChatGPTPermanently delete a Workspace function.
delete_narrative_decision
ChatGPTDelete a narrative decision edge, optionally matching its criteria.
delete_narrative_section
ChatGPTPermanently delete a narrative section from an owned character.
delete_narrative_trigger
ChatGPTPermanently delete a narrative trigger from an owned character.
deprecate_character_version
ChatGPTDeprecate or restore an immutable character version.
detach_function
ChatGPTDetach a function from a character draft.
diff_character_versions
ChatGPTCompare immutable versions, latest, or draft using raw or semantic changes.
discard_character_draft
ChatGPTDiscard saved draft changes and restore the released parent.
disconnect_knowledge_document
ChatGPTDisconnect one knowledge document from an owned character.
edit_narrative_decision
ChatGPTEdit a narrative decision and its destination update data.
fork_character_version
ChatGPTReplace the editable draft with an immutable version.
generate_character_backstory
ChatGPTGenerate backstory or description text without modifying a character.
generate_starter_conversation
ChatGPTGenerate up to four suggested user messages for a character.
get_character
ChatGPTGet one character owned by the authenticated Convai account.
get_chat_history
ChatGPTGet one ordered chat transcript; third-party tool results are opt-in.
get_chat_interaction
ChatGPTGet the user prompt and response for one authorized interaction.
get_function
ChatGPTGet one stored function definition: name, description, language and input contract. Returns stored data only; it does not run the function.
get_narrative_section
ChatGPTGet one narrative section from an owned character.
get_narrative_trigger
ChatGPTGet one narrative trigger from an owned character.
list_character_versions
ChatGPTList immutable versions and the editable draft for a character.
list_characters
ChatGPTList characters owned by the authenticated Convai account.
list_chat_history
ChatGPTList bounded chat sessions visible for a character or version reference.
list_function_templates
ChatGPTList public function templates, optionally filtered by language.
list_functions
ChatGPTList the function definitions stored in a Workspace (ID, name, description, language), optionally with whether each is attached to a character. Returns stored metadata only; it does not run any function.
list_languages
ChatGPTList language codes that have at least one public voice. Use them for update_character.language_code and language_codes, and as the list_voices lang_code filter.
list_narrative_sections
ChatGPTList narrative sections for an owned character.
list_narrative_triggers
ChatGPTList narrative triggers for an owned character.
list_supported_models
ChatGPTList supported LLM models, optionally resolved for a specific owned character. Pass an entry's model_group_name to create_character or update_character. With character_id, is_active marks the character's current model. Entries also report is_uncensored, capabilities, min_credit_cost_e8, and deprecation. Plan access is checked when the model is saved, not in this list.
list_voices
ChatGPTList plan-eligible public voices, optionally filtered by language, gender, or provider. Pass an entry's voice_value as voice_type. Workspace custom voices are not listed.
promote_character_version
ChatGPTMake one immutable version the character's latest version.
release_character_version
ChatGPTCreate an immutable semantic version from the current saved draft.
revert_character_draft_change
ChatGPTRevert one semantic draft change to an immutable version.
set_narrative_start_section
ChatGPTChoose the narrative section where a new conversation starts. get_character reports the current value as start_narrative_section_id. The change is saved to the editable draft.
update_character
ChatGPTUpdate selected settings on an owned character's editable draft. Omitted fields keep their stored value. Send null only where a field's description says null clears it: several fields reject null and others ignore it. Character API validates every value and enforces plan, model, voice, Workspace, and ownership rules, so discover options with list_supported_models, list_voices, and list_languages first. Prefer flat fields such as temperature, model_group_name, moderation_enabled, state_of_mind_enabled, and actions_enabled. personalised_prompt_config, guardrail_meta, guard_rails, metadata_filter, and memory_settings replace the stored object, and character_traits is merged with defaults rather than stored values; for those, read get_character and send the complete object. Field descriptions mark legacy settings that the current runtime does not apply. Use attach_function, connect_knowledge_document, and the narrative tools for associations and story structure, and release_character_version to publish the draft as an immutable version.
update_function
ChatGPTUpdate selected fields on a Workspace function.
update_narrative_section
ChatGPTUpdate selected fields on a narrative section.
update_narrative_trigger
ChatGPTUpdate selected fields on a narrative trigger.