responses

Create response (streaming)

Creates a response and streams updates in real-time via Server-Sent Events (SSE). This provides a real-time alternative to creating a response and polling the GetResponse endpoint.

If the conversation is handed off to live chat, the turn is relayed to the human agent rather than the assistant, so the stream emits RESPONSE_CREATED then RESPONSE_COMPLETED with no outputs and closes, with no RESPONSE_IN_PROGRESS or RESPONSE_OUTPUT_DELTA between them. The agent's reply arrives separately, as a LIVE_AGENT message on a response of its own, and is received like a proactive notification rather than on this stream.

post/conversations/{conversation_id}/responses/stream

Request

  • Base URL: https://api.moveworks.ai/rest/v1
  • URL: https://api.moveworks.ai/rest/v1/conversations/{conversation_id}/responses/stream
  • Auth: HTTP bearer

Path parameters

conversation_idstring required

A base-62 identifier prefixed by a short resource type

Headers

Assistant-Namestring required

The Moveworks assistant identifier that was configured for your organization.

Accept'text/event-stream' required

Must be set to text/event-stream to receive Server-Sent Events

Request body

Response

Server-Sent Events stream of response updates

Changes

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