Sign in

v106

OpenAPI 3.1.0raw.githubusercontent.com2026-08-02160524464.6 KB
Human-in-the-Loop

Steer Run

Send a mid-run steering message to the live agent session(s) of a running run. Set interrupt=true to atomically interrupt the active steerable agent round first, then deliver this message as the next user turn. Without interrupt=true, the message is appended to the steering queue and may buffer until the next steerable agent session.

post/api/v1/runs/{id}/steer

Path parameters

idstring required

Unique run identifier (ULID).

Request body

textstring required

The steering message text to deliver as a user turn.

interruptboolean

When true, apply a worker-control interrupt first, then deliver this text as steering in the same control operation. When false (default), append to the steering queue and let the agent pick it up at the next turn boundary.

Example request

{
  "text": "Try a different approach"
}

Response

Steer accepted and forwarded to the worker