Skip to main content
POST
Add a message to a session thread
Send a new message to a session thread and receive updates as it is processed. Responses are returned as Server-Sent Events that stream message processing updates. See the Streaming section for event types and payload formats.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-Envole-User-Id
string
header
required

External user identifier; not necessarily registered with Envole

Path Parameters

threadId
string
required

Body

application/json
content
(Text · object | Tool Approval Result · object | File · object | Image · object)[]
required

Response

SSE stream of events from the agent.

type
enum<string>
required
Available options:
CONNECTION_ESTABLISHED,
MESSAGE_RECEIVED,
AGENT_RESPONSE_CHUNK,
AGENT_RESPONSE_COMPLETE,
TOOL_EXECUTION_APPROVAL_REQUEST,
TOOL_EXECUTION_APPROVAL_RESPONSE,
NOTIFICATION_TOOL_EXECUTION_INITIATED,
NOTIFICATION_TOOL_EXECUTION_IN_PROGRESS,
NOTIFICATION_TOOL_EXECUTION_APPROVAL_REQUIRED,
NOTIFICATION_TOOL_EXECUTION_APPROVAL_ACCEPTED,
NOTIFICATION_TOOL_EXECUTION_APPROVAL_DENIED,
NOTIFICATION_TOOL_EXECUTION_APPROVAL_ABORTED,
NOTIFICATION_AGENT_THINKING_STARTED,
NOTIFICATION_AGENT_THINKING_COMPLETE,
NOTIFICATION_KNOWLEDGE_RETRIEVAL_INITIATED,
NOTIFICATION_KNOWLEDGE_RETRIEVAL_IN_PROGRESS,
NOTIFICATION_KNOWLEDGE_RETRIEVAL_COMPLETED,
NOTIFICATION_KNOWLEDGE_RETRIEVAL_FAILED,
NOTIFICATION_KNOWLEDGE_RETRIEVAL_DUPLICATED_CACHED,
NOTIFICATION_REQUEST_ORCHESTRATION_SIMPLE,
NOTIFICATION_REQUEST_ORCHESTRATION_COMPLEX,
NOTIFICATION_REQUEST_ORCHESTRATION_CAPABILITIES,
NOTIFICATION_REQUEST_ORCHESTRATION_KNOWLEDGE_BASE,
NOTIFICATION_REQUEST_ORCHESTRATION_TOOL_USAGE,
NOTIFICATION_REQUEST_ORCHESTRATION_COLLABORATION,
NOTIFICATION_PLAN_ORCHESTRATION_COMPLEX_INITIATED,
NOTIFICATION_PLAN_ORCHESTRATION_COMPLEX_IN_PROGRESS,
NOTIFICATION_PLAN_ORCHESTRATION_COMPLEX_COMPLETED,
NOTIFICATION_PLAN_ORCHESTRATION_COMPLEX_REVIEW_INITIATED,
NOTIFICATION_PLAN_ORCHESTRATION_COMPLEX_REVIEW_IN_PROGRESS,
NOTIFICATION_PLAN_ORCHESTRATION_COMPLEX_REVIEW_COMPLETED,
NOTIFICATION_PLAN_ORCHESTRATION_KNOWLEDGE_BASE_INITIATED,
NOTIFICATION_PLAN_ORCHESTRATION_KNOWLEDGE_BASE_IN_PROGRESS,
NOTIFICATION_PLAN_ORCHESTRATION_KNOWLEDGE_BASE_COMPLETED,
NOTIFICATION_PLAN_ORCHESTRATION_KNOWLEDGE_RETRIEVAL_INITIATED,
NOTIFICATION_PLAN_ORCHESTRATION_TOOL_USAGE_INITIATED,
NOTIFICATION_PLAN_ORCHESTRATION_TOOL_USAGE_IN_PROGRESS,
NOTIFICATION_PLAN_ORCHESTRATION_TOOL_USAGE_COMPLETED,
NOTIFICATION_PLAN_ORCHESTRATION_REFLECTION_INITIATED,
NOTIFICATION_PLAN_ORCHESTRATION_REFLECTION_ABORTED,
NOTIFICATION_PLAN_ORCHESTRATION_REFLECTION_FAILED,
NOTIFICATION_PLAN_ORCHESTRATION_REFLECTION_COMPLETED,
NOTIFICATION_PLAN_ORCHESTRATION_COLLABORATION_INITIATED,
NOTIFICATION_PLAN_ORCHESTRATION_COLLABORATION_IN_PROGRESS,
NOTIFICATION_PLAN_ORCHESTRATION_COLLABORATION_COMPLETED,
NOTIFICATION_MULTI_ASSISTANT_COLLABORATION_STARTED,
NOTIFICATION_MULTI_ASSISTANT_COLLABORATION_ASSISTANT_RESPONSE_IN_PROGRESS,
NOTIFICATION_MULTI_ASSISTANT_COLLABORATION_ASSISTANT_RESPONSE_COMPLETED,
NOTIFICATION_MULTI_ASSISTANT_COLLABORATION_UNIFIED_RESPONSE_STARTED,
NOTIFICATION_MULTI_ASSISTANT_COLLABORATION_NO_UNIFIED_RESPONSE_REQUIRED,
NOTIFICATION_MULTI_ASSISTANT_COLLABORATION_COMPLETED,
NOTIFICATION_MULTI_ASSISTANT_COLLABORATION_FAILED,
NOTIFICATION_CONTEXT_MEMORIES_RETRIEVAL_FAILED,
ERROR
eventId
string
required
threadId
string
required
requestId
string
required
eventMessage
object
required