SEND Message (sync)

Synchronously send a message to an agent in a conversation and receive the response.

Endpoint

POST {base_url}/conversations/{conversation_id}/messages/sync

Parameters

| Name | Type | Description |
|------|------|-------------|
| `conversation_id` | string | The ID of the conversation in uuid |

## Request Body

| Name | Type | Description |
|------|------|-------------|
| `message` | string | The message to send to the agent |

Example request

curl -X POST '{api_endpoint}/conversations/99873177-3617-4db9-94f3-47e9c61cc434/messages/sync' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {api_token}' \
-d '{
  "message": "Hi"
}'

Advanced reasoning

To use advanced reasoning feature, user can either

1. Enable advanced reasoning from UI

1. Add "is_run_ooda": true in the chat request body.

curl -X POST '{api_endpoint}/conversations/99873177-3617-4db9-94f3-47e9c61cc434/messages/sync' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {api_token}' \
-d '{
  "message": "Hi",
  "is_run_ooda": true,
}'

Note:

• If no plan is specify yet, system will auto generate the plan from the context

• It will take longer to get the response

Multi-language support

• To get response other than English, please add language_code in the request body. List of supported language:

  • Japanese: ja

  • Chinese: ch_sim

  • Italian: it

  • Spanish: es

Example request:

{
    "message": "質問",
    "language_code": "ja",
}