Skip to main content
GET
https://superadmin.voiceaura.ai/api/
/
v1
/
convo_pathway
/
{pathway_id}
Get Single Pathway Information
curl --request GET \
  --url https://superadmin.voiceaura.ai/api/v1/convo_pathway/{pathway_id} \
  --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

​
authorization
string
required
Your API key for authentication.

​
Path Parameters

​
pathway_id
string
required
The unique identifier of the conversational pathway for which you want to retrieve detailed information.

​
Response

​
name
string
The name of the conversational pathway.
​
description
string
A description of the conversational pathway.
​
nodes
array of objects
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 node
  • isStart — whether the node is the start node. There can only be 1 start node in a pathway. Either true or false.
  • isGlobal — whether the node is a global node. Global nodes are nodes that can be used in multiple pathways. Either true or false.
  • globalLabel — the label of the global node. Should be present if isGlobal is true.
  • type — Type of the node. Can be Default, End Call, Transfer Node, Knowledge Base, or Webhook.
  • 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 node
    • temperature — 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"]]
​
edges
array of objects
Data about all the edges in the pathway.
  • id — unique id of the edge
  • source — id of the source node
  • target — id of the target node
  • label — 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"
    }
  ]
}