Message

Create Message

post

Generate a streaming response based on the user message and knowledge base provided.

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Header parameters

Accept-LanguagestringOptionalDefault: en

X-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

multipart/form-data

chatbot_idstringRequired

messagestring · min: 1Required

parent_idany ofOptional

stringOptional

or

nullOptional

sourceany ofOptional

stringOptional

or

nullOptional

quoteany ofOptional

stringOptional

or

nullOptional

user_idany ofOptional

stringOptional

or

nullOptional

conversation_idany ofOptional

stringOptional

or

nullOptional

user_message_idany ofOptional

stringOptional

or

nullOptional

assistant_message_idany ofOptional

stringOptional

or

nullOptional

chat_historyany ofOptional

stringOptional

or

nullOptional

filesstring · binary[]OptionalDefault: []

stream_idany ofOptional

stringOptional

or

nullOptional

metadataany ofOptional

stringOptional

or

nullOptional

model_nameany ofOptional

stringOptional

or

nullOptional

anonymize_emany ofOptional

booleanOptional

or

nullOptional

anonymize_lmany ofOptional

booleanOptional

or

nullOptional

use_cacheany ofOptional

booleanOptional

or

nullOptional

search_typeany ofOptional

string · enumOptional

The type of search to perform.

Attributes: NORMAL: Get answer from chatbot knowledge. SEARCH: Get answer from various connectors. SQL_SEARCH: Get answer from SQL-based database. WEB: Get more relevant information from the web. (DEPRECATED) Web Search uses real-time data. Agent selection isn't available in this mode. DEEP_RESEARCH: Get answer from Deep Research Agent. ESSENTIALS_DEEP_RESEARCH: Get answer from Deep Research with Essentials mode. Provides key points and core insights without noise, optimized for speed and clarity. Ideal for quick decision-making support and fast orientation. COMPREHENSIVE_DEEP_RESEARCH: Get answer from Deep Research with Comprehensive mode. Delivers the full picture with depth and thoroughness, covering all relevant angles, details, and supporting data. Suitable for professional research tasks where precision matters more than speed.

Possible values:

or

nullOptional

connectorsstringOptionalDefault: []

agent_idsstringOptionalDefault: []

is_regeneratedbooleanOptionalDefault: false

is_editedbooleanOptionalDefault: false

is_retriedbooleanOptionalDefault: false

stream_message_onlybooleanOptionalDefault: false

exclude_prefixbooleanOptionalDefault: false

include_statesbooleanOptionalDefault: false

filtersany ofOptionalDefault: []

stringOptional

or

nullOptional

Responses

200

Streaming response with full accumulated messages

text/event-stream

400

Bad Request - Invalid input parameters

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/message

HTTPcURLJavaScriptPython

POST /message HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 577

{
  "chatbot_id": "text",
  "message": "text",
  "parent_id": "text",
  "source": "text",
  "quote": "text",
  "user_id": "text",
  "conversation_id": "text",
  "user_message_id": "text",
  "assistant_message_id": "text",
  "chat_history": "text",
  "files": [
    "binary"
  ],
  "stream_id": "text",
  "metadata": "text",
  "model_name": "text",
  "anonymize_em": true,
  "anonymize_lm": true,
  "use_cache": true,
  "search_type": "normal",
  "connectors": "[]",
  "agent_ids": "[]",
  "is_regenerated": false,
  "is_edited": false,
  "is_retried": false,
  "exclude_events": [
    "activity"
  ],
  "stream_message_only": false,
  "exclude_prefix": false,
  "include_states": false,
  "filters": "[]"
}

data:{"status":"response","message":"Hello","conversation_id":"550e8400-e29b-41d4-a716-446655440001","user_message_id":"550e8400-e29b-41d4-a716-446655440004","assistant_message_id":"550e8400-e29b-41d4-a716-446655440005","created_date":1757344945547}
data:{"status":"response","message":"Hello, I'm","conversation_id":"550e8400-e29b-41d4-a716-446655440001","user_message_id":"550e8400-e29b-41d4-a716-446655440004","assistant_message_id":"550e8400-e29b-41d4-a716-446655440005","created_date":1757344945559}
data:{"status":"response","message":"Hello, I'm doing well","conversation_id":"550e8400-e29b-41d4-a716-446655440001","user_message_id":"550e8400-e29b-41d4-a716-446655440004","assistant_message_id":"550e8400-e29b-41d4-a716-446655440005","created_date":1757344945631}

Delete Message

delete

Delete one or more messages by their IDs and remove associated attachments.

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Query parameters

message_idsstring[]Required

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/message

HTTPcURLJavaScriptPython

DELETE /message?message_ids=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Create Message V2

post

Generate a streaming response with delta (incremental changes) based on the user message and knowledge base provided.

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Header parameters

Accept-LanguagestringOptionalDefault: en

X-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

multipart/form-data

chatbot_idstringRequired

messagestring · min: 1Required

parent_idany ofOptional

stringOptional

or

nullOptional

sourceany ofOptional

stringOptional

or

nullOptional

quoteany ofOptional

stringOptional

or

nullOptional

user_idany ofOptional

stringOptional

or

nullOptional

conversation_idany ofOptional

stringOptional

or

nullOptional

user_message_idany ofOptional

stringOptional

or

nullOptional

assistant_message_idany ofOptional

stringOptional

or

nullOptional

chat_historyany ofOptional

stringOptional

or

nullOptional

filesstring · binary[]OptionalDefault: []

stream_idany ofOptional

stringOptional

or

nullOptional

metadataany ofOptional

stringOptional

or

nullOptional

model_nameany ofOptional

stringOptional

or

nullOptional

anonymize_emany ofOptional

booleanOptional

or

nullOptional

anonymize_lmany ofOptional

booleanOptional

or

nullOptional

use_cacheany ofOptional

booleanOptional

or

nullOptional

search_typeany ofOptional

string · enumOptional

The type of search to perform.

Attributes: NORMAL: Get answer from chatbot knowledge. SEARCH: Get answer from various connectors. SQL_SEARCH: Get answer from SQL-based database. WEB: Get more relevant information from the web. (DEPRECATED) Web Search uses real-time data. Agent selection isn't available in this mode. DEEP_RESEARCH: Get answer from Deep Research Agent. ESSENTIALS_DEEP_RESEARCH: Get answer from Deep Research with Essentials mode. Provides key points and core insights without noise, optimized for speed and clarity. Ideal for quick decision-making support and fast orientation. COMPREHENSIVE_DEEP_RESEARCH: Get answer from Deep Research with Comprehensive mode. Delivers the full picture with depth and thoroughness, covering all relevant angles, details, and supporting data. Suitable for professional research tasks where precision matters more than speed.

Possible values:

or

nullOptional

connectorsstringOptionalDefault: []

agent_idsstringOptionalDefault: []

is_regeneratedbooleanOptionalDefault: false

is_editedbooleanOptionalDefault: false

is_retriedbooleanOptionalDefault: false

stream_message_onlybooleanOptionalDefault: false

exclude_prefixbooleanOptionalDefault: false

include_statesbooleanOptionalDefault: false

filtersany ofOptionalDefault: []

stringOptional

or

nullOptional

Responses

200

Streaming response with delta (incremental) messages

text/event-stream

422

Validation Error

application/json

post

/v2/message

HTTPcURLJavaScriptPython

POST /v2/message HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 577

{
  "chatbot_id": "text",
  "message": "text",
  "parent_id": "text",
  "source": "text",
  "quote": "text",
  "user_id": "text",
  "conversation_id": "text",
  "user_message_id": "text",
  "assistant_message_id": "text",
  "chat_history": "text",
  "files": [
    "binary"
  ],
  "stream_id": "text",
  "metadata": "text",
  "model_name": "text",
  "anonymize_em": true,
  "anonymize_lm": true,
  "use_cache": true,
  "search_type": "normal",
  "connectors": "[]",
  "agent_ids": "[]",
  "is_regenerated": false,
  "is_edited": false,
  "is_retried": false,
  "exclude_events": [
    "activity"
  ],
  "stream_message_only": false,
  "exclude_prefix": false,
  "include_states": false,
  "filters": "[]"
}

data:{"status":"response","delta":"Hello","conversation_id":"550e8400-e29b-41d4-a716-446655440001","user_message_id":"550e8400-e29b-41d4-a716-446655440004","assistant_message_id":"550e8400-e29b-41d4-a716-446655440005","created_date":1757344945547}
data:{"status":"response","delta":", I'm","conversation_id":"550e8400-e29b-41d4-a716-446655440001","user_message_id":"550e8400-e29b-41d4-a716-446655440004","assistant_message_id":"550e8400-e29b-41d4-a716-446655440005","created_date":1757344945559}
data:{"status":"response","delta":" doing","conversation_id":"550e8400-e29b-41d4-a716-446655440001","user_message_id":"550e8400-e29b-41d4-a716-446655440004","assistant_message_id":"550e8400-e29b-41d4-a716-446655440005","created_date":1757344945571}
data:{"status":"response","delta":" well,","conversation_id":"550e8400-e29b-41d4-a716-446655440001","user_message_id":"550e8400-e29b-41d4-a716-446655440004","assistant_message_id":"550e8400-e29b-41d4-a716-446655440005","created_date":1757344945583}

Save Message

post

Save messages to the chat history storage for a specific conversation.

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Body

multipart/form-data

user_idstringRequired

conversation_idstringRequired

message_liststringRequired

filesstring · binary[]OptionalDefault: []

metadataany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/save-message

HTTPcURLJavaScriptPython

POST /save-message HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 102

{
  "user_id": "text",
  "conversation_id": "text",
  "message_list": "text",
  "files": [
    "binary"
  ],
  "metadata": "text"
}

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Save Feedback

post

Add user feedback to a specific message for quality tracking and improvement.

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Body

application/x-www-form-urlencoded

user_idany ofOptional

stringOptional

or

nullOptional

message_idstringRequired

conversation_idstringRequired

feedbackany ofOptional

stringOptional

or

nullOptional

is_send_conversationbooleanOptionalDefault: false

is_notify_resolutionbooleanOptionalDefault: false

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/message/feedback

HTTPcURLJavaScriptPython

POST /message/feedback HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 139

"user_id='text'&message_id='text'&conversation_id='text'&feedback='text'&is_send_conversation=false&is_notify_resolution=false"

No content

Stop Generating

post

Stop the message generation process for a specific stream ID.

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Body

application/x-www-form-urlencoded

stream_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/stop-generating

HTTPcURLJavaScriptPython

POST /stop-generating HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 20

"stream_id='text'"

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get Deanonymized Message

get

Get a deanonymized message by message ID, conversation ID, and user ID from chat history.

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Path parameters

message_idstringRequired

Query parameters

conversation_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/message/{message_id}/deanonymize

HTTPcURLJavaScriptPython

GET /message/{message_id}/deanonymize?conversation_id=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": {
    "id": "text",
    "conversation_id": "text",
    "role": "user",
    "content": "text",
    "deanonymized_content": "text",
    "created_time": "2026-01-13T03:34:11.624Z",
    "is_active": true,
    "parent_id": "text",
    "source": "text",
    "feedback": "text",
    "metadata_": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

Get Message Statistics

get

Get message statistics within a specified date range and export in requested format (CSV or XLSX).

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Query parameters

start_datestringOptional

Start date in ISO format (YYYY-MM-DD). Defaults to 30 days ago.

Default: 2025-11-08T11:50:47.241353

end_datestringOptional

End date in ISO format (YYYY-MM-DD). Defaults to today.

Default: 2025-12-08T11:50:47.241748

export_formatstringOptional

Export format ['xlsx', 'csv']

Default: csv

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/message-stats

HTTPcURLJavaScriptPython

GET /message-stats HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Create Async Message

post

Create an async message processing task

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Body

multipart/form-data

chatbot_idstringRequired

messagestring · min: 1Required

parent_idany ofOptional

stringOptional

or

nullOptional

sourceany ofOptional

stringOptional

or

nullOptional

quoteany ofOptional

stringOptional

or

nullOptional

user_idany ofOptional

stringOptional

or

nullOptional

conversation_idany ofOptional

stringOptional

or

nullOptional

user_message_idany ofOptional

stringOptional

or

nullOptional

assistant_message_idany ofOptional

stringOptional

or

nullOptional

chat_historyany ofOptional

stringOptional

or

nullOptional

filesstring · binary[]OptionalDefault: []

stream_idany ofOptional

stringOptional

or

nullOptional

metadataany ofOptional

stringOptional

or

nullOptional

model_nameany ofOptional

stringOptional

or

nullOptional

anonymize_emany ofOptional

booleanOptional

or

nullOptional

anonymize_lmany ofOptional

booleanOptional

or

nullOptional

use_cacheany ofOptional

booleanOptional

or

nullOptional

search_typeany ofOptional

string · enumOptional

The type of search to perform.

Attributes: NORMAL: Get answer from chatbot knowledge. SEARCH: Get answer from various connectors. SQL_SEARCH: Get answer from SQL-based database. WEB: Get more relevant information from the web. (DEPRECATED) Web Search uses real-time data. Agent selection isn't available in this mode. DEEP_RESEARCH: Get answer from Deep Research Agent. ESSENTIALS_DEEP_RESEARCH: Get answer from Deep Research with Essentials mode. Provides key points and core insights without noise, optimized for speed and clarity. Ideal for quick decision-making support and fast orientation. COMPREHENSIVE_DEEP_RESEARCH: Get answer from Deep Research with Comprehensive mode. Delivers the full picture with depth and thoroughness, covering all relevant angles, details, and supporting data. Suitable for professional research tasks where precision matters more than speed.

Possible values:

or

nullOptional

connectorsstringOptionalDefault: []

agent_idsstringOptionalDefault: []

is_regeneratedbooleanOptionalDefault: false

is_editedbooleanOptionalDefault: false

is_retriedbooleanOptionalDefault: false

stream_message_onlybooleanOptionalDefault: false

exclude_prefixbooleanOptionalDefault: false

include_statesbooleanOptionalDefault: false

filtersany ofOptionalDefault: []

stringOptional

or

nullOptional

Responses

201

Task created successfully

application/json

400

Bad Request - Invalid input parameters

application/json

403

Forbidden - Insufficient permissions

application/json

404

Not Found - Conversation or chatbot not found. Occurs when the provided conversation_id does not exist or the chatbot is not accessible by the user.

application/json

409

Conflict - An active task already exists for this conversation

application/json

422

Validation Error

application/json

429

Too Many Requests - Rate limit exceeded

application/json

500

Internal Server Error

application/json

post

/v3/messages

HTTPcURLJavaScriptPython

POST /v3/messages HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 577

{
  "chatbot_id": "text",
  "message": "text",
  "parent_id": "text",
  "source": "text",
  "quote": "text",
  "user_id": "text",
  "conversation_id": "text",
  "user_message_id": "text",
  "assistant_message_id": "text",
  "chat_history": "text",
  "files": [
    "binary"
  ],
  "stream_id": "text",
  "metadata": "text",
  "model_name": "text",
  "anonymize_em": true,
  "anonymize_lm": true,
  "use_cache": true,
  "search_type": "normal",
  "connectors": "[]",
  "agent_ids": "[]",
  "is_regenerated": false,
  "is_edited": false,
  "is_retried": false,
  "exclude_events": [
    "activity"
  ],
  "stream_message_only": false,
  "exclude_prefix": false,
  "include_states": false,
  "filters": "[]"
}

{
  "task_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "pending",
  "created_at": "2024-11-05T10:00:00Z"
}

List Tasks

get

List async message tasks with filtering and pagination

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Query parameters

statusany ofOptional

Filter by task status(es)

or

nullOptional

chatbot_idany ofOptional

Filter by chatbot ID

stringOptional

or

nullOptional

conversation_idany ofOptional

Filter by conversation ID

stringOptional

or

nullOptional

cursorany ofOptional

Pagination cursor (ISO 8601 datetime string)

stringOptional

or

nullOptional

limitany ofOptional

Number of tasks per page (max 100)

integer · min: 1 · max: 100Optional

or

nullOptional

Responses

200

Tasks retrieved successfully

application/json

400

Bad Request - Invalid cursor format

application/json

403

Forbidden - Insufficient permissions

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get

/v3/messages/tasks

HTTPcURLJavaScriptPython

GET /v3/messages/tasks HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "tasks": [
    {
      "task_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "completed",
      "created_at": "2024-11-05T10:00:00Z",
      "updated_at": "2024-11-05T10:00:30Z",
      "completed_at": "2024-11-05T10:00:30Z",
      "chatbot_id": "chatbot-123",
      "conversation_id": "conv-456",
      "user_message_id": "550e8400-e29b-41d4-a716-446655440004",
      "assistant_message_id": "550e8400-e29b-41d4-a716-446655440005"
    }
  ],
  "cursor": "2024-11-05T09:00:00Z",
  "tasks_count": 1
}

Cancel Task

delete

Cancel an ongoing async message task

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Path parameters

task_idstringRequired

Task ID to cancel

Responses

200

Task cancelled successfully

application/json

400

Bad Request - Task cannot be cancelled (already completed or failed)

application/json

403

Forbidden - Insufficient permissions

application/json

404

Task not found or unauthorized access

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

delete

/v3/messages/tasks/{task_id}

HTTPcURLJavaScriptPython

DELETE /v3/messages/tasks/{task_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "task_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "cancelled",
  "cancelled_at": "2024-11-05T10:00:15Z"
}

Stream Task Events

get

Stream async message task events via Server-Sent Events (SSE)

Authorizations

OAuth2PasswordBearerAPIKeyHeader

OAuth2passwordRequired

Token URL:

cookie

__Secure-next-auth.session-tokenany ofOptional

stringOptional

or

nullOptional

Path parameters

task_idstringRequired

Task ID to stream events for

Query parameters

user_idany ofOptional

User ID to use when current_user.id is None

stringOptional

or

nullOptional

Responses

200

Streaming response with task events

text/event-stream

403

Forbidden - Insufficient permissions

application/json

404

Task not found or unauthorized access

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get

/v3/messages/tasks/{task_id}/stream

HTTPcURLJavaScriptPython

GET /v3/messages/tasks/{task_id}/stream HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

data:{"status":"response","message":"Hello","conversation_id":"550e8400-e29b-41d4-a716-446655440001",
"user_message_id":"550e8400-e29b-41d4-a716-446655440004","assistant_message_id":"550e8400-e29b-41d4-a716-446655440005",
"created_date":1757344945547}