Headers
Your API key for authentication.
Path Parameters
The unique identifier of the conversational pathway you want to update.
Body
The name of the conversational pathway
A description of the pathway
An array of node objects representing the conversation flow points in your pathway. Each node contains:Common Node Structure:Available Node Types:
Update the pathway’s global prompt by adding an object to the array of nodes.
Default
, End Call
, Transfer Call
, Webhook
, Knowledge Base
, SMS
, Custom Code
, Press Button
, Wait for Response
, Transfer Pathway
, Scheduling
, and more.Node Examples:Node Data Object Parameters
Node Data Object Parameters
name
— name of the nodeisStart
— whether the node is the start node. There can only be 1 start node in a pathway. Eithertrue
orfalse
.isGlobal
— whether the node is a global node. Global nodes are nodes that can be used in multiple pathways. Eithertrue
orfalse
.globalLabel
— the label of the global node. Should be present ifisGlobal
is true.type
— Type of the node. Can beDefault
,End Call
,Transfer Node
,Knowledge Base
, orWebhook
.text
— If static text is chosen, this is the text that will be said to the user.prompt
— If dynamic text is chosen, this is the prompt that will be shown to the user.condition
— The condition that needs to be met to proceed from this node.transferNumber
- If the node is a transfer node, this is the number to which the call will be transferred.
kb
- If the node is a knowledge base node, this is the knowledge base that will be used.
pathwayExamples
- The fine-tuning examples for the agent at this node for the pathways chosen
conditionExamples
- The fine-tuning examples for the condition at this node for the condition chosen
dialogueExamples
- The fine-tuning examples for the dialogue at this node for the dialogue chosen.
modelOptions
modelName
— The name of the model to be used for this node.interruptionThreshold
— The sensitivity to interruptions at this nodetemperature
— The temperature of the model.
extractVars
- An array of array of strings. [[
varName
,varType
,varDescription
]] e.g[["name", "string", "The name of the user"], ["age", "integer", "The age of the user"]]
- An array of array of strings. [[
Global Prompt
An array of edge objects that define the connections and flow between nodes in your pathway. Each edge contains:Common Edge Structure:
Edge Object Parameters
Edge Object Parameters
id
— unique id of the edgesource
— id of the source nodetarget
— id of the target nodelabel
— Label for this edge. This is what the agent will use to decide which path to take.
Complete JSON Structure Example
For a comprehensive example of how pathways are structured with multiple nodes and edges in a realistic use case, download our example template: Download pathway example This example contains a complete car rental pathway with:- Multiple node types (Default, Transfer Call, Webhook, End Call, etc.)
- Complex edge routing and conditions
- Variable extraction and model configuration
- Real-world conversation flow patterns
Response
Can be
success
or error
.A unique identifier for the pathway (present only if status is
success
).Data about all the nodes in the pathway.
Data about all the edges in the pathway.