Conversational Pathways
Get All Pathways Information
Calls
Intelligence
Conversational Pathways
- GETGet All Pathways Information
- GETGet Single Pathway Information
- POSTCreate Pathway
- POSTUpdate Pathway
- DELDelete Pathway
- Pathway Chat
- Pathway Versions
- Pathway Folders
Vector Knowledge Bases
Voices
Custom Tools
Web Agents
Custom Twilio Accounts
Batches
SMS
Account
Organizations
- POSTCreate Organization
- DELDelete Organization
- GETGet Organization
- GETGet Organization Members
- GETGet Organization's Current Service Version
- GETList Organization's Service Versions
- PATCHUpdate Organization's Service Version
- PATCHUpdate Organization Members
- PATCHUpdate Organization Member Permissions
- PATCHUpdate Organization Properties
- GETGet User Organization Memberships
- DELLeave Organization
- GETGet Organization Billing Information
- GETGet Organization Billing Refill Information
Conversational Pathways
Get All Pathways Information
Returns a set of information about all the conversational pathways in your account - including the name, description, nodes and edges.
GET
/
v1
/
pathway
curl --request GET \
--url https://api.bland.ai/v1/pathway \
--header 'authorization: <authorization>'{
"name": "Default Demo Pathway",
"description": null,
"nodes": [
{
"id": "1",
"data": {
"name": "Start",
"text": "Hey there, how are you doing today?",
"isStart": true,
},
"type": "Default"
},
{
"id": "randomnode_1710288752186",
"data": {
"name": "End call",
"prompt": "Click 'Add New Node' on the right to add a new node",
},
"type": "End Call"
},
{
"id": "randomnode_1710288871721",
"data": {
"name": "New Node",
"text": "Select a node or edge and press backspace to remove it",
},
"type": "Default"
},
{
"id": "randomnode_test123",
"data": {
"name": "Testing node",
"text": "Hello there"
},
"type": "Default"
}
],
"edges": [
{
"id": "reactflow__edge-1-randomnode_1710288752186",
"label": "greeted",
"source": "1",
"target": "randomnode_1710288752186"
},
{
"id": "reactflow__edge-1-randomnode_1710288871721",
"label": "New Edge",
"source": "1",
"target": "randomnode_1710288871721"
}
]
}
Headers
Your API key for authentication.
Response
The name of the conversational pathway.
A description of the conversational pathway.
Data about all the nodes in the pathway.
Examples of JSON objects for nodes (Horizontal scroll the tab bar to see more examples)
{
"id": "1",
"type": "Default"
"data": {
"name": "Start",
"text": "Hey there, how are you doing today?",
"isStart": true,
},
name— name of the nodeisStart— whether the node is the start node. There can only be 1 start node in a pathway. Eithertrueorfalse.isGlobal— whether the node is a global node. Global nodes are nodes that can be used in multiple pathways. Eithertrueorfalse.globalLabel— the label of the global node. Should be present ifisGlobalis 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.
modelOptionsinterruptionThreshold— 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. [[
Data about all the edges in the pathway.
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.
{
"name": "Default Demo Pathway",
"description": null,
"nodes": [
{
"id": "1",
"data": {
"name": "Start",
"text": "Hey there, how are you doing today?",
"isStart": true,
},
"type": "Default"
},
{
"id": "randomnode_1710288752186",
"data": {
"name": "End call",
"prompt": "Click 'Add New Node' on the right to add a new node",
},
"type": "End Call"
},
{
"id": "randomnode_1710288871721",
"data": {
"name": "New Node",
"text": "Select a node or edge and press backspace to remove it",
},
"type": "Default"
},
{
"id": "randomnode_test123",
"data": {
"name": "Testing node",
"text": "Hello there"
},
"type": "Default"
}
],
"edges": [
{
"id": "reactflow__edge-1-randomnode_1710288752186",
"label": "greeted",
"source": "1",
"target": "randomnode_1710288752186"
},
{
"id": "reactflow__edge-1-randomnode_1710288871721",
"label": "New Edge",
"source": "1",
"target": "randomnode_1710288871721"
}
]
}
curl --request GET \
--url https://api.bland.ai/v1/pathway \
--header 'authorization: <authorization>'{
"name": "Default Demo Pathway",
"description": null,
"nodes": [
{
"id": "1",
"data": {
"name": "Start",
"text": "Hey there, how are you doing today?",
"isStart": true,
},
"type": "Default"
},
{
"id": "randomnode_1710288752186",
"data": {
"name": "End call",
"prompt": "Click 'Add New Node' on the right to add a new node",
},
"type": "End Call"
},
{
"id": "randomnode_1710288871721",
"data": {
"name": "New Node",
"text": "Select a node or edge and press backspace to remove it",
},
"type": "Default"
},
{
"id": "randomnode_test123",
"data": {
"name": "Testing node",
"text": "Hello there"
},
"type": "Default"
}
],
"edges": [
{
"id": "reactflow__edge-1-randomnode_1710288752186",
"label": "greeted",
"source": "1",
"target": "randomnode_1710288752186"
},
{
"id": "reactflow__edge-1-randomnode_1710288871721",
"label": "New Edge",
"source": "1",
"target": "randomnode_1710288871721"
}
]
}