Skip to main content
POST
Run one of the caller's workflows now.

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

id
string
required

Response

Started, or an already-running session was returned.

success
boolean
outcome
enum<string>
Available options:
started,
reused
workflowId
string
runId
string
sessionId
string
workspaceId
string
status
string
agent
object | null
reused
boolean

True when an existing session for this agent was returned instead of a new one. Never presented as a fresh start.

instruction
string

The saved instruction. Also delivered to the session when outcome is started; see instructionDelivered.

instructionDelivered
boolean

True only when the saved instruction was actually accepted by the agent session. Independent of outcome.

deliveryState
enum<string>

n/a — nothing to deliver, or delivery deliberately not attempted (empty instruction, or outcome reused). delivered — the prompt frame was accepted. not_ready — the session was not promptable within the bounded in-request retry budget. failed — the guest agent rejected or errored on the send.

Available options:
n/a,
delivered,
not_ready,
failed
deliveryCode
string

Machine-readable reason when not delivered, e.g. REUSED_SESSION, SESSION_INCOMPLETE, NO_CONTROL_KEY, SEND_FAILED.

deliveryMessage
string

User-safe reason when not delivered.

message
string