GET
/
v1
/
convo_pathway
curl --request GET \
  --url https://api.bland.ai/v1/convo_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

authorization
string
required

Your API key for authentication.

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,
      },
  
edges
array of objects

Data about all the edges in the pathway.

{
  "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"
    }
  ]
}