Convai Agent Authoring

Delete a narrative decision edge, optionally matching its criteria.

delete_narrative_decision

Permanently delete a narrative section from an owned character.

delete_narrative_section

Permanently delete a narrative trigger from an owned character.

delete_narrative_trigger

Deprecate or restore an immutable character version.

deprecate_character_version

Detach a function from a character draft.

detach_function

Compare immutable versions, latest, or draft using raw or semantic changes.

diff_character_versions

Discard saved draft changes and restore the released parent.

discard_character_draft

Disconnect one knowledge document from an owned character.

disconnect_knowledge_document

Edit a narrative decision and its destination update data.

edit_narrative_decision

Replace the editable draft with an immutable version.

fork_character_version

Generate backstory or description text without modifying a character.

generate_character_backstory

Generate up to four suggested user messages for a character.

generate_starter_conversation

Get one ordered chat transcript; third-party tool results are opt-in.

get_chat_history

Get the user prompt and response for one authorized interaction.

get_chat_interaction

Get one character owned by the authenticated Convai account.

get_character

Get one stored function definition: name, description, language and input contract. Returns stored data only; it does not run the function.

get_function

Get one narrative section from an owned character.

get_narrative_section

Get one narrative trigger from an owned character.

get_narrative_trigger

List bounded chat sessions visible for a character or version reference.

list_chat_history

List immutable versions and the editable draft for a character.

list_character_versions

List 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_supported_models

List characters owned by the authenticated Convai account.

list_characters

List public function templates, optionally filtered by language.

list_function_templates

List 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_functions

List 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_languages

List 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.

list_voices

List narrative sections for an owned character.

list_narrative_sections

List narrative triggers for an owned character.

list_narrative_triggers

Make one immutable version the character's latest version.

promote_character_version

Create an immutable semantic version from the current saved draft.

release_character_version

Revert one semantic draft change to an immutable version.

revert_character_draft_change

Choose 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.

set_narrative_start_section

Update 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_character

Update selected fields on a Workspace function.

update_function

Update selected fields on a narrative section.

update_narrative_section

Update selected fields on a narrative trigger.

update_narrative_trigger