Chat

Chat with Agent

Send a message to an agent over HTTP and receive its reply. Uses the same prompt, tools, and channel profile as production text channels, without delivering to WhatsApp/SMS. Ideal for custom web chat widgets: call this from your backend with your API key. Omit session_id on the first turn; reuse the returned value for multi-turn conversations.

Authentication

X-API-Keystring
Your API key from [Dashboard → Settings → API Keys](https://dashboard.signalcore.ai/settings)

Path parameters

agent_idstringRequired
Agent ID to chat with

Request

This endpoint expects an object.
messagestringRequired
User message to send to the agent
channelenumRequired

Channel profile to use for prompt, tools, and model. Use the same channel you configured for WhatsApp/SMS so behavior matches that channel.

session_idstringOptionalformat: "uuid"

Omit on the first turn to create a session. Pass the returned session_id on later turns to keep conversation context.

learn_from_conversationbooleanOptionalDefaults to false

When true, read/write business agent memory for this session

contactobjectOptional

Optional contact identity for the chat session (used by scheduling and similar tools)

Response

Agent reply
responsestringOptional
The agent's generated reply
session_idstringOptional
Session ID. Store this and send it on the next request.
conversation_historylist of objectsOptional
Conversation history for this session
tool_callslist of objectsOptional
Tools the agent executed while generating the reply
usageobjectOptional
Token usage for billing
business_memoryobject or nullOptional

Present when learn_from_conversation is true

Errors

404
Not Found Error