Skip to main content
The Form filling session management APIs provide endpoints to create and manage Form filling sessions. These endpoints are used to create a Form filling session, seed the session context, update the session context, stream visit audio over the shared Partner WebSocket, and end the session when the visit is complete.

​
Usage scenarios

  • Create a new Form filling ambient session for your patient encounter during in-person visits or virtual visits
  • Seed the session context with form template metadata and encounter details
  • Update the session context during an active visit
  • Stream visit audio over GET /ws/stream using your Form filling ambient_session_id
  • End the session when the patient encounter is complete

​
Endpoints

Create Form Filling Session

Create a Form filling session and obtain an ambient session identifier for subsequent calls

Seed Form Filling Session Context

Seed Form filling session context for a Form filling session using the Form filling URL binding

Update Form Filling Session Context

Partially update Form filling session context using the Form filling URL binding

Form Filling Audio Streaming

WebSocket endpoint for streaming visit audio during Form filling sessions

End Form Filling Session

End a Form filling session

Last modified on June 30, 2026