Skip to main content
The agent stream endpoint is the primary way to interact with Compose agents. Send a message, receive a real-time SSE stream with text, tool calls, and receipts.

Send a message

Parameters

Iterate events

The stream yields events in order. See Stream Protocol for every event type.

Get the final result

After the stream ends, access the complete result:

Stop a running stream

Approve a plan

When an agent proposes a plan in swarm mode, approve or reject it:

Attachments

Send images or files alongside the message:

Multiple attachments