Skip to main content
POST
Steer a processing thread with streaming.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Path Parameters

id
string
required

Body

application/json
content
string
required

Content of the message, validated up to 100000 tokens.

Minimum string length: 1
preflightMessageId
string<uuid>

Optional hidden draft user message id created before attachment uploads. When provided, the send operation finalizes that draft instead of creating a new user message.

model
string

Optional execution model identifier enabled for this instance.

reasoningEffort
enum<string>

Optional assistant reasoning effort override: low, medium, high, or xhigh. Defaults to low.

Available options:
low,
medium,
high,
xhigh
reasoning
enum<string>

Alias for reasoningEffort used by assistant preferences. Prefer reasoningEffort for new clients.

Available options:
low,
medium,
high,
xhigh
backgroundProcessing
boolean
default:false

Allow the Assistant turn to continue after the client disconnects. Defaults to false unless the operation states otherwise.

interruptActive
boolean
default:false

Optional flag for send-message endpoints. When true, an active streamed assistant turn for the thread is interrupted before appending this message.

goal
string

Optional durable turn goal for non-plan execution. Agent runtime carries this goal across tool loops, compaction, and follow-up turns without forcing visible plan review.

Minimum string length: 1
executionMode
enum<string>
default:interactive

Execution mode for the turn. Interactive may pause for approval or clarification. Background and automation should avoid user-blocking pauses.

Available options:
interactive,
execute,
background,
automation
planningPolicy
enum<string>
default:standard

Planning policy for the turn. standard can create and show progress; review_required creates a user-reviewed plan before execution.

Available options:
standard,
review_required
permissions
enum<string>
default:default

Per-turn approval policy. default requires approval for side-effecting tool calls, auto_review uses conditional safe auto-review, and full skips normal approval gates.

Available options:
default,
auto_review,
full
toolPermissions
object

Optional per-tool approval policy overrides. Runtime sanitizes keys and enum values before persisting them.

toolNames
string[]

Optional allowlist of operational tool names for this turn. Omit to allow the gateway default surface; pass an empty array to admit no tools for direct-answer turns.

pluginIds
string<uuid>[]

Optional registry plugin ids attached to this assistant turn.

Response

Thread steer streamed.

Last modified on September 5, 2026