Update a session

​

Updates a running session in place: swap its configuration_id or toggle transcript_events. In-flight operator executions finish normally; operators added by the new configuration start, and removed operators stop cleanly after their current run. Only applies while the session is live: a session that is ending, ended, failed, or timed out returns 409, and a request with no updatable fields returns 422.

Required scope: intelligence:write

Path Parameters
  • session_id
    Type: string · Session Id
    required

    The session identifier returned when the session was created.

Body·
required
application/json

Fields that can be changed on a running session. Omitted fields are left unchanged.

  • configuration_id
    Type: string · Configuration Idnullable

    Swap the configuration in force from this point in the conversation onward.

  • transcript_events
    Type: boolean · Transcript Eventsnullable

    Turn transcript event streaming on or off for the rest of the session.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for patch/sessions/{session_id}
curl 'https://api.simwood.com/intelligence/v1/sessions/{session_id}' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "configuration_id": "",
  "transcript_events": true
}'

null

Successful Response

Simwood API Documentation