IBibm
Orchestrate Agent

Chat With Orchestrate Assistant As Stream

post/v1/orchestrate/runs/stream

Request

  • Base URL
    https://{api_endpoint}
  • Auth
    HTTP bearer

Query parameters

stream_timeoutinteger
multiple_contentboolean

Request body

thread_idstring uuid nullable
contextobject nullable
agent_idstring nullable
additional_parametersobject nullable
environment_idstring nullable
versioninteger nullable
context_variablesobject nullable

Context variables for the agent execution (e.g., {'wxo_email_id': 'user@domain.com', 'wxo_user_name': 'John Doe'})

Response

Successful Response

idstring required
event'run.started' | 'run.completed' | 'run.failed' | 'run.expired' | 'run.cancelled' | 'run.step.started' | 'run.step.completed' | 'run.step.failed' | 'run.step.delta' | 'message.created' | 'message.started' | 'message.delta' | 'message.completed' | 'run.step.thinking' | 'message.interrupt' | 'transcription' | 'summary' | 'error' | 'done' | 'planning' | 'flow.slot.listen' required
dataobject required

Changes

No recorded changes to this operation across all 1 revision of this API.