Start Agent Chat

Starts a chat agent session in a conversation.

Agent must be active and use an active LLM. The agent cannot access past messages unless the conversation_history placeholder is included in the prompt. Be sure to include it if past messages are important for the use case.

Accepts an optional schedule_at parameter to schedule the chat session instead of placing it immediately, but attention, the API responds with 202 Accepted instead of 201 Created in this case. Scheduled accepted responses include data.id, the stable ID that the eventual chat agent session will use when the scheduled job creates it. Acceptance does not guarantee downstream chat agent session creation succeeds.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

ID of the agent to be used in the chat session.

Agent must:

  • Be active.
  • Use an active LLM.
Body Params

Start Agent Chat Request

Request schema for starting a chat agent session.

string
required

Channel identifier (phone number or email) to be used for the chat session.

Channel must:

  • Be enabled.
  • Be of type phone, whatsapp, or email.
date-time

Scheduling time for the agent chat session.

When informed, must:

  • Be in the ISO 8601 format, e.g. "2026-04-25T10:00:00Z".
  • Be a valid time strictly in the future.

Attention, even when scheduled, the API responds with 202 Accepted instead of 201 Created.

boolean
Defaults to false

Whether the agent should send an initial message to the contact after starting the chat session.

When set to true, the agent will automatically send the first message without waiting for the contact to message first. When set to false or not provided, only the chat session will be created and the agent will only send a message after the contact messages first.

string
required

Contact phone number or email address

string
enum
required

Type of chat communication

Allowed:
Responses

Callback
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json