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>"
    }
  ]
}

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

Authorization

string

header

required

OAuth 2.0 client-credentials tokens bounded by the source API key scope ceiling.

Path Parameters

agentId

string

required

The target agent identifier.

Minimum string length: 1

Body

application/json

message

string

required

End-user prompt sent to the agent.

Required string length: 1 - 4000

requestId

string<uuid>

Optional idempotency key for safe retries of the same chat input.

conversationId

string | null

Continue an existing API-channel conversation when present.

Response

Completed non-streaming chat response

conversationId

string

required

messageId

string

required

userMessageId

string

required

answer

string

required

citations

object[]

required

Show child attributes

mode

enum<string>

required

Available options:

ai,

human

ticketNumber

integer | null

actionName

string

Present when a workspace action produced the final answer.

followUps

string[]

Optional suggested next questions returned with the answer.

Maximum array length: 3

Authentication

Agents

Chat

Send a chat turn to an agent

Authorizations

Path Parameters

Body

Response