Send message (streaming)

Send a message and receive a streaming response using Server-Sent Events (SSE).

The response is a stream of newline-delimited JSON events. Use this endpoint for both initial messages and follow-up messages - conversation context is automatically preserved.

Access Control:

• For shared conversations, only the creator or admins can send messages
• Other project members can view shared conversations but cannot send messages

Impersonation:

• When using impersonation, the message is sent as the impersonated user

Streaming Event Types

Type	Description
streaming_in_progress	Intermediate event during response generation
streaming_error	Error occurred during streaming
streaming_completed	Final event with complete chat history

Payload Types (within streaming_in_progress)

Payload Type	Description
start_token_streaming	Stream is starting
token_streaming	Text token being streamed
tool_call_request	Tool is being invoked
tool_call	Tool execution results
reasoning	Reasoning step

POST /projects/{project_id}/playground-conversations/{conversation_id}/send_message_stream

Send message (streaming)

Python

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/playground-conversations/{conversation_id}/send_message_stream/"

payload = { "message": "What information do you have about product pricing?" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

"data: {\"type_streaming\": \"streaming_in_progress\", \"payload\": {\"type\": \"start_token_streaming\", \"content\": \"\"}}\n\ndata: {\"type_streaming\": \"streaming_in_progress\", \"payload\": {\"type\": \"token_streaming\", \"content\": \"The\"}}\n\ndata: {\"type_streaming\": \"streaming_in_progress\", \"payload\": {\"type\": \"token_streaming\", \"content\": \"The document\"}}\n\ndata: {\"type_streaming\": \"streaming_in_progress\", \"payload\": {\"type\": \"tool_call\", \"tool_type\": \"semantic_chunks\", \"results\": [...]}}\n\ndata: {\"type_streaming\": \"streaming_completed\", \"payload\": {\"conversation_id\": \"uuid\", \"chat_history\": [...]}}\n"

Authorizations

BearerAuthTokenAuth

Authorization · string · header · required

Use Authorization: Bearer

Headers

X-Impersonate-Email · string<email>

Email of the user to impersonate. Requires CAN_IMPERSONATE_OTHER_USERS permission. If the target user is not found or does not have access to the project, the request proceeds as the authenticated user. Contact Clarifeye to enable this permission.

Path Parameters

project_id · string<uuid> · required

UUID of the project

conversation_id · string<uuid> · required

UUID of the conversation

Body

application/json

message · string · required

The user message to send

Example:

"What information do you have about product pricing?"

Response

200

text/event-stream

Server-Sent Events stream

The response is of type string.