Send a chat turn to an agent
curl --request POST \
--url https://app.communicate.so/api/v1/agents/{agentId}/chat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({message: '<string>'})
};
fetch('https://app.communicate.so/api/v1/agents/{agentId}/chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/agents/{agentId}/chat"
payload = { "message": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"conversationId": "<string>",
"messageId": "<string>",
"userMessageId": "<string>",
"answer": "<string>",
"citations": [
{
"sourceId": "<string>",
"title": "<string>",
"snippet": "<string>",
"url": "<string>"
}
],
"mode": "ai",
"ticketNumber": 123,
"actionName": "<string>",
"followUps": [
"<string>"
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}Chat
Send a chat turn to an agent
Creates or continues an API-channel conversation and returns one complete response payload. This endpoint does not stream. requestId is optional idempotency; reusing it with different input yields 409 request_id_conflict. Chat turns are additionally rate-limited to 60 requests per minute per key. Responses may include grounded citations and, when an action ran, actionName.
POST
/
agents
/
{agentId}
/
chat
Send a chat turn to an agent
curl --request POST \
--url https://app.communicate.so/api/v1/agents/{agentId}/chat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({message: '<string>'})
};
fetch('https://app.communicate.so/api/v1/agents/{agentId}/chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/agents/{agentId}/chat"
payload = { "message": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"conversationId": "<string>",
"messageId": "<string>",
"userMessageId": "<string>",
"answer": "<string>",
"citations": [
{
"sourceId": "<string>",
"title": "<string>",
"snippet": "<string>",
"url": "<string>"
}
],
"mode": "ai",
"ticketNumber": 123,
"actionName": "<string>",
"followUps": [
"<string>"
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}Authorizations
oauth2bearerAuth
OAuth 2.0 client-credentials tokens bounded by the source API key scope ceiling.
FlowClient Credentials
- Token URL
- https://app.communicate.so/api/v1/oauth/token
Scopes1
chat:write
Create chat turns with an agent in the authenticated workspace.
Path Parameters
The target agent identifier.
Minimum string length:
1Body
application/json
Response
Completed non-streaming chat response
Show child attributes
Show child attributes
Available options:
ai, human Present when a workspace action produced the final answer.
Optional suggested next questions returned with the answer.
Maximum array length:
3