The page list all the APIs needed to interact Narrative Design
POST
https://api.convai.com/character/toggle-is-narrative-driven
Enable/Disable Narrative Graph for your character.
Here are some sample codes to demonstrate the request format for the endpoint -->
POST
https://api.convai.com/character/narrate/create-section
Create new section for your Character.
Here are some sample codes to demonstrate the request format for the endpoint -->
POST
https://api.convai.com/character/narrate/edit-section
Edit section for your Character. You would send all the fields that you want to update for a section updated_character_data json. Following are the valid key.
"section_name"
"objective"
"decisions": This is a list of json. Each entry in the list should have following format.
Here are some sample codes to demonstrate the request format for the endpoint -->
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
CONVAI-API-KEY*
String
The unique api-key provided for every user. Found under the Key icon when logged into your Convai account.
character_id
String
Id of your character.
is_narrative_driven
Bool
Set it to true or false, to enable disable Narrative Graph.
CONVAI-API-KEY*
String
The unique api-key provided for every user. Found under the Key icon when logged into your Convai account.
character_id
String
Id of your character.
objective
String
Section Objective
section_name
String
Name of the Section.
updated_character_data
Json
*Ignore* Field is not used.
behavior_tree_code
String
*Ignore* Field is not used.
bt_constants
String
*Ignore* Field is not used.
CONVAI-API-KEY*
String
The unique api-key provided for every user. Found under the Key icon when logged into your Convai account.
character_id
String
Id of your character.
updated_character_data
Json
Contains fields that are updated.
section_id
String
Id of the section to update.