> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bland.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Pathway Chat

> Send a message to a pathway and receive a response.

### Headers

<ParamField header="authorization" type="string" required>
  Your API key for authentication.
</ParamField>

### Path Parameters

<ParamField path="id" type="uuid" required>
  The chat ID created from the /pathway/chat/create endpoint.
</ParamField>

### Body

<ParamField body="message" type="string">
  The message to send to the pathway (optional)
</ParamField>

### Response

<ResponseField name="data" type="object">
  Contains the response data for the pathway chat message.

  <Expandable title="data properties">
    <ResponseField name="chat_id" type="uuid">
      The ID of the chat instance.
    </ResponseField>

    <ResponseField name="assistant_responses" type="array">
      An array of strings containing the assistant's responses to the message sent.
    </ResponseField>

    <ResponseField name="current_node_id" type="string">
      The ID of the current node in the pathway after processing the message.
    </ResponseField>

    <ResponseField name="current_node_name" type="string">
      The name of the current node in the pathway.
    </ResponseField>

    <ResponseField name="chat_history" type="array">
      An array of objects containing the role and content of each message in the external chat history.
    </ResponseField>

    <ResponseField name="pathway_id" type="string">
      The ID of the pathway the chat is associated with.
    </ResponseField>

    <ResponseField name="pathway_version" type="string | null">
      The version of the pathway being used, or null if not specified.
    </ResponseField>

    <ResponseField name="use_candidate_model" type="boolean">
      Whether the candidate model is being used for this pathway chat.
    </ResponseField>

    <ResponseField name="variables" type="object">
      The current state of variables in the pathway execution.
    </ResponseField>

    <ResponseField name="completed" type="boolean">
      Whether the pathway has completed execution.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="errors" type="null | array">
  Will be `null` on success. Contains error details if the request failed.
</ResponseField>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": {
      "chat_id": "12345678-1234-1234-1234-123456789012",
      "assistant_responses": ["Hey there, this is the Bland Bistro reservation line. Do you want to make a reservation?"],
      "current_node_id": "1",
      "current_node_name": "Start",
      "chat_history": [
        {"role": "user", "content": "hello"},
        {"role": "assistant", "content": "Hey there, this is the Bland Bistro reservation line. Do you want to make a reservation?"}
      ],
      "pathway_id": "87654321-4321-4321-4321-210987654321",
      "pathway_version": null,
      "use_candidate_model": false,
      "variables": {
        "callID": "12345678-1234-1234-1234-123456789012"
      },
      "completed": false
    },
    "errors": null
  }
  ```
</ResponseExample>

***

Docs for agents: [llms.txt](/llms.txt)