v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

sessions

Update Session

Update a session's metadata before it is committed. Use this to attach or correct patient_details, change the requested templates, adjust language_hint, or switch session_mode / model. session_mode and model can only be changed while the session is still open (before End Session) — attempting to change them afterwards returns 409. Unknown fields are rejected.

patch/voice/v1/sessions/{session_id}

Path parameters

session_idstring required

Example:ses_abc123def456

Session ID returned by Create Session

Request body

patient_detailsobject

Patient demographic / identifier metadata. The oid key is promoted to patient_oid for indexing.

templatesstring[]

Replace the requested template IDs (up to 2).

language_hintstring[]

ISO 639-1 code(s) hinting the spoken language(s).

additional_dataobject

Arbitrary pass-through metadata merged into the session.

session_mode'consultation' | 'dictation'

Updatable only before the session is committed (End Session).

model'pro' | 'lite'

Updatable only before the session is committed (End Session).

user_statusstring

Client-side session status marker.

processing_statusstring

Processing status override (advanced use).

Response

Session updated

session_idstring

statusstring

messagestring

Example response

{
  "status": "success",
  "message": "Session updated successfully"
}