POST
/
v1
/
pathway
/
chat
/
create
Create Pathway Chat
curl --request POST \
  --url https://us.api.bland.ai/v1/pathway/chat/create \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "pathway_id": "<string>",
  "start_node_id": "<string>"
}'
{
  "status": "success",
  "chat_id": "1234567890",
  "message": "Chat instance created successfully"
}

Headers

authorization
string
required
Your API key for authentication.

Body

pathway_id
string
Pathway ID of the pathway to create a chat instance for.
start_node_id
string
The start node ID of the pathway.

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.
message
string
If the status is success, the message will say “Chat instance created successfully.” Otherwise, if the status is error, the message will say “Error creating chat instance.”
{
  "status": "success",
  "chat_id": "1234567890",
  "message": "Chat instance created successfully"
}