Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.suki.ai/llms.txt

Use this file to discover all available pages before exploring further.

Quick summary
Form filling converts visit conversation into structured medical form output using Suki templates. Use Form Filling Partner APIs for full control over session lifecycle, audio streaming, and structured data retrieval in your own UI and workflows.
Last updated:May 2026
Form filling is supported by: Form Filling APIs
  • For standalone form filling with your own UI and server logic, use the Form Filling APIs and follow Basic usage.
  • Stream visit audio on the shared Partner WebSocket GET /ws/stream. Use your form-filling ambient_session_id, not an Ambient clinical note session ID. Refer to Ambient audio streaming.
Form filling lets providers complete structured medical forms using natural conversation during a visit. You can use it for nursing workflows, intake and assessments, medication reviews, and other template-based capture without manual re-entry in your application. The form filling workflow focuses on structured output for Suki medical form templates. Unlike ambient documentation workflows, it does not generate a full clinical note or LOINC-based note sections. This makes it a good fit when you need template-driven forms that integrate directly into your own workflows and user experience. You can use form filling in both in-person and virtual care scenarios. Create a session, stream audio through the Partner WebSocket, and retrieve structured form data when processing completes. The APIs give you control over session lifecycle, context, audio capture, and downstream save logic.

​
Common use cases

Support in-person clinical form capture

Capture visit conversation during in-person encounters and retrieve structured form output for nursing and clinical workflows.

Support telehealth form workflows

Capture conversation during virtual visits and return structured form data for telehealth or remote care workflows.

Run template-driven sessions

List templates, bind form_template_id values in session context, and retrieve generated_values after processing.

Build custom form-filling pipelines

Own session lifecycle, audio streaming, structured data retrieval, and EHR handoff end to end with Partner APIs.

​
Key features

Voice-driven form capture

Stream visit audio so Suki can populate structured form fields from conversation.

Session lifecycle

Create sessions, seed or update context, end visits, and track status until completion.

Medical form templates

Use Suki-defined templates with field definitions in each template schema.

Structured retrieval

Retrieve generated_values and non_generated_values when processing finishes.

Webhooks and polling

Poll session status and structured data, or use partner webhooks when configured for your account.

​
How it works

If you use the Form Filling Partner APIs, the workflow has these steps:
  1. Create a session - Create a form-filling session and receive an ambient_session_id.
  2. Seed or update context - Provide form_template_id values for the templates in scope for the visit.
  3. Stream audio - Connect to /ws/stream and stream visit audio with that session ID.
  4. End the session - End the session when visit capture is complete.
  5. Retrieve structured data - Poll status and retrieve structured form output when processing finishes.
The form-filling ambient_session_id is not the same value as an Ambient clinical note session. Use only the ID returned from Create form filling session.

​
Workflow

​
Next steps

Refer to the Basic usage guide to get started with form filling using our Partner APIs.
Last modified on May 22, 2026