---
title: "Chat With Orchestrate Assistant As Stream"
method: POST
path: "/v1/orchestrate/runs/stream"
tags: ["Orchestrate Agent"]
---

# Chat With Orchestrate Assistant As Stream

`POST /v1/orchestrate/runs/stream`

## Query parameters

- `stream_timeout` integer
- `multiple_content` boolean

## Request body

- RunOrchestrate
  - `message` CreateMessage
    - `role` string, required
    - `content` union, required
      - AssistantContent[]
        - `response_type` 'conversational_search' | 'text' | 'image' | 'option' | 'pause' | 'iframe' | 'connect_to_agent' | 'suggestion' | 'channel_transfer' | 'search' | 'user_defined' | 'video' | 'audio' | 'date' | 'inline_error' | 'chat_with_docs_upload' | 'disconnected_apps' | 'forms' | 'form_operation' | 'document_processing_response', required
        - `json_schema` object, nullable
        - `ui_schema` object, nullable
        - `form_data` object, nullable
        - `id` string, nullable
        - `form_operation` string, nullable
        - `sub_type` string, nullable
        - `event_type` string, nullable
        - `dps_payload_id` string, nullable
      - string
    - `mentions` union[], nullable
      - union
        - Mention
          - `type` string, required
          - `id` string, uuid, required
          - `name` string, required
        - AssistantMention
          - `assistant_id` string, uuid, required
          - `assistant_name` string, required
    - `document_ids` string[], nullable
    - `parent_message_id` string, uuid, nullable
    - `additional_properties` AdditionalProperties
      - `wxa_message` object, nullable
      - `display_properties` DisplayProperties
        - `skip_render` boolean
        - `is_async` boolean
        - `form_operation` string
      - `tool_calls` object[], nullable
      - `tool_call_id` string, nullable
      - `tool_name` string, nullable
      - `wxo_connection_status` WxoConnectionStatus
        - `connection_status` string
        - `connection_message` string
    - `assistant_id` string, uuid, nullable
    - `context` Context
      - `values` ContextKV[]
        - `key` string, required
        - `value` unknown
    - `step_history` object[], nullable
    - `message_state` object, nullable
  - `thread_id` string, uuid, nullable
  - `llm_params` TextGenerationParameters
    - `beam_width` integer, nullable
    - `decoding_method` 'greedy' | 'sample'
    - `include_stop_sequence` boolean, nullable
    - `length_penalty` LengthPenalty
      - `decay_factor` number, nullable
      - `start_index` integer, nullable
    - `max_new_tokens` integer, nullable
    - `min_new_tokens` integer, nullable
    - `random_seed` integer, nullable
    - `repetition_penalty` number, nullable
    - `return_options` TextGenerationReturnOptions
      - `generated_tokens` boolean, nullable
      - `input_parameters` boolean, nullable
      - `input_text` boolean, nullable
      - `input_tokens` boolean, nullable
      - `token_logprobs` boolean, nullable
      - `token_ranks` boolean, nullable
      - `top_n_tokens` integer, nullable
    - `stop_sequences` string[], nullable
    - `temperature` number, nullable
    - `time_limit` integer, nullable
    - `top_k` integer, nullable
    - `top_p` number, nullable
    - `truncate_input_tokens` integer, nullable
    - `typical_p` number, nullable
  - `guardrails` GuardrailsInput
    - `hap` Guardrail
      - `input` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `output` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `mask` MaskProperties
        - `remove_entity_value` boolean
    - `social_bias` Guardrail
      - `input` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `output` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `mask` MaskProperties
        - `remove_entity_value` boolean
    - `pii` Guardrail
      - `input` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `output` GuardrailConfig
        - `enabled` boolean
        - `threshold` number
      - `mask` MaskProperties
        - `remove_entity_value` boolean
  - `context` object, nullable
  - `agent_id` string, nullable
  - `additional_parameters` object, nullable
  - `environment_id` string, nullable
  - `version` integer, nullable
  - `context_variables` object, nullable — Context variables for the agent execution (e.g., {'wxo_email_id': 'user@domain.com', 'wxo_user_name': 'John Doe'})

## Response `200`

Successful Response

- RunEvent
  - `id` string, 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
  - `data` object, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/ibm/apis/wxo-server-api.md) · [All operations](https://skmtc.net/ibm/apis/wxo-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ibm/wxo-server-api/revisions/82c114c37196/schema)