POST
/
v1
/
pathway
/
chat
/
{id}
Pathway Chat
curl --request POST \
  --url https://us.api.bland.ai/v1/pathway/chat/{id} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "message": "<string>"
}'
{
  "status": "success",
  "chat_id": "1234567890",
  "Assistant Response": "Hey there, how are you doing?",
  "Current Node ID": "node_123",
  "Current Node Name": "Welcome Node",
  "Chat History": [
    {"role": "user", "content": "Hello"}, {"role": "assistant", "content":  "Hi there!"}
  ],
  "Pathway ID": "pathway_123"
}

Headers

authorization
string
required
Your API key for authentication.

Path Parameters

id
uuid
required
The chat ID created from the /pathway/chat/create endpoint.

Body

message
string
The message to send to the pathway (optional)

Response

status
string
Can be success or error.
chat_id
uuid
The ID of the chat instance created. This will be used to send and receive messages to the pathway via the /pathway/chat endpoint.
Assistant Response
string
The response from the Assistant to the message sent.
Current Node ID
string
The ID of the current node in the pathway.
Current Node Name
string
The name of the current node in the pathway.
Chat History
array
An array of objects containing the role and content of each message in the chat.
Pathway ID
string
The ID of the pathway the chat is associated with.
{
  "status": "success",
  "chat_id": "1234567890",
  "Assistant Response": "Hey there, how are you doing?",
  "Current Node ID": "node_123",
  "Current Node Name": "Welcome Node",
  "Chat History": [
    {"role": "user", "content": "Hello"}, {"role": "assistant", "content":  "Hi there!"}
  ],
  "Pathway ID": "pathway_123"
}