Stream agent or network response
Build and stream responses from an agent or network of agents. Provide either agentId or copilotId (the id of a network).
Authorizations
API key generated in studio.sidenet.ai. Scopes the request to its organization.
Headers
Organization to scope the request to.
End-user identity for the request. Required by endpoints that read or write user-scoped resources (threads, messages, memory). A userId query param (or body field, where documented) is accepted as a fallback.
Body
1Agent id — runs the agent's active published version
Optional override: run a specific agent version (e.g. preview a draft or an earlier published version) instead of the active one
Network id to route through (alternative to agentId)
Conversation thread id
Optional stable caller-supplied group id. When sent, group matching is by this id; a differing groupName renames the group.
1 - 255Optional group name. Without groupId this matches by name; alongside groupId it is display-only (rename on change).
Runtime authentication map: { [providerNameOrId]: { credentials } }
Additional context messages to provide to the agent.
AI SDK trigger type
submit-message, regenerate-message AI SDK client-side tools
AI SDK session metadata
Default true. When the request targets an orchestrator agent, routing picks whether to stream the orchestrator (multi-step / synthesis) or a single subagent directly (domain-specific ask). No effect when the resolved agent is not an orchestrator. Pass false to disable.
Response
AI SDK v6 UIMessageStream response
The response is of type string.