Sessions
Sessions

Set Session Stream

Changed on
post/sessions/streams/

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/sessions/streams/
  • Auth
    API key in header Authorization

Request body

session_idstring required
forceboolean
detachedboolean
expected_execution_idstring nullable

Response

Successful Response

mode'send' | 'steer' | 'cancel' | 'attach' required

Derived from the inputs/data × force matrix.

session_idstring required
turn_idstring nullable
watcher_idstring nullable
detachedboolean
cancelled_turn_idsstring[]

Changes

  • 2f5818dfac1fRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • fc532d6dc820Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property