Skip to main content
POST
Stream agent or network response

Authorizations

Authorization
string
header
required

API key generated in studio.sidenet.ai. Scopes the request to its organization.

Headers

X-Organization-Id
string

Organization to scope the request to.

X-User-Id
string

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

application/json
messages
array
required
Minimum array length: 1
agentId
string

Agent id — runs the agent's active published version

agentVersionId
string

Optional override: run a specific agent version (e.g. preview a draft or an earlier published version) instead of the active one

copilotId
string

Network id to route through (alternative to agentId)

threadId
string

Conversation thread id

groupId
string | null

Optional stable caller-supplied group id. When sent, group matching is by this id; a differing groupName renames the group.

Required string length: 1 - 255
groupName
string | null

Optional group name. Without groupId this matches by name; alongside groupId it is display-only (rename on change).

runtimeAuth
object

Runtime authentication map: { [providerNameOrId]: { credentials } }

context
string[]

Additional context messages to provide to the agent.

trigger
enum<string>

AI SDK trigger type

Available options:
submit-message,
regenerate-message
tools
object

AI SDK client-side tools

metadata
object

AI SDK session metadata

use_routing
boolean
default:true

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.