Skip to main content
POST
/
agent
/
chat
/
{agent_id}
Send Chat Message
curl --request POST \
  --url https://api.getoutbox.ai/agent/chat/{agent_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "thread_id": "<string>",
  "contact_id": "<string>",
  "phone_number": "<string>",
  "full_name": "<string>",
  "platform": "<string>",
  "external_customer_id": "<string>",
  "stream": false,
  "testing": false,
  "visitor_session_id": "<string>"
}
'
{
  "response": "<string>",
  "thread_id": "<string>",
  "thread_message_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.getoutbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Company API Key

Path Parameters

​
agent_id
string
required

The ID of the chatbot agent

Body

application/json

Chat message details

​
message
string
required

The message to send to the chatbot

​
thread_id
string

Thread ID for continuing an existing conversation

​
contact_id
string

Contact ID

​
phone_number
string

Phone number of the user

​
full_name
string

Full name of the user

​
platform
string

Platform where the message originated (e.g., sms, email, instagram, facebook)

​
external_customer_id
string

External customer ID

​
stream
boolean
default:false

When true, returns an SSE stream of the assistant response.

​
testing
boolean
default:false

Testing mode: skips contact persistence for unauthenticated requests. Aliases: test, is_test, test_mode.

​
visitor_session_id
string

Stable per-browser session ID used to reuse the same guest contact across turns when no thread_id is supplied. Alias: session_id.

Response

Message sent successfully

​
response
string

The agent's reply message

​
thread_id
string

Conversation thread ID

​
thread_message_id
string | null

ID of the message, null if no message created