Are you a Suki partner?To use any Suki API or SDK, you must be a Suki partner. Contact the partnership team to begin the onboarding process. They help you set up your authentication system and get started with the Suki APIs and SDKs.
GET /ws/stream) using the Form filling session ID. When processing is complete, Suki sends a notification to your application, so you don’t need to continuously poll for results.
Available APIs
The following set of APIs are available for the Form filling workflow. View each card below to learn more about the endpoints that are available and how to use them.Authentication
Endpoints for authentication and authorization.
Session Management
Endpoints for creating, managing, streaming audio, and ending Form filling sessions.
Content Retrieval
Endpoints for polling session status, retrieving structured medical-form output, and session recordings.
Notifications
Webhook specification for asynchronous Form filling session completion events.
Feedback
Endpoints for submitting feedback for Form filling session entities.
Form Filling Info
Endpoints for listing Suki-defined Medical form templates for Form filling sessions.
Authentication
For an overview of Suki’s supported authentication mechanisms refer to Authentication mechanisms. We recommend using OAuth 2.0 with JWT tokens for your authentication system. If you know what your authentication model is, refer to the following guides to get started:Single Auth Token Authentication
Standard Provider Authentication
Bearer Partner Authentication
If you’re using a Suki SDK, the SDK manages authentication and sends the required headers automatically after authentication is configured.
Key capabilities
The Form filling APIs provide the following capabilities, so you can run voice-driven medical form workflows from template selection through structured output in your EHR or internal systems.Suki provides templates for common medical forms. Refer to the Form filling API templates section to learn more.
Voice-Driven Form Capture
Stream visit audio through the shared Partner WebSocket to generate structured medical forms during in-person and virtual visits.
Session Lifecycle Management
Create and manage Form filling sessions, update session context, end visits, and monitor processing status until completion.
Medical Form Templates
Retrieve available Suki Medical form templates to support form selection, validation, and clinician workflows in your application.
Structured Form Output
Retrieve generated medical form instances and structured outputs for EHR and downstream clinical workflows.
Encounter Context
Pass patient, provider, and template information as session context when creating or updating active sessions.
In-Person and Virtual Visits
Use the same Form filling workflow for in-person and telehealth encounters while keeping control of the capture experience in your UI.
Webhook Notifications
Receive webhook events when form processing is complete so your backend can respond without relying only on polling.
Session Feedback
Collect clinician feedback and optional ratings for generated structured data to help measure form quality and user satisfaction.
Requirements
Before you can use the Form filling APIs, you need to meet the following requirements:- You must be a Suki partner. Learn more about how to become a Suki partner in the Partner onboarding documentation.
- A standards-based authentication system (for example OAuth 2.0 or OpenID Connect with JWTs).
- JWT tokens with consistent user identifiers (for example
sub,email, oruserId). - A publicly accessible JWKS endpoint for token verification.
What you can build
Use the Form filling APIs to build custom workflows for voice-driven medical form capture. Control how sessions are created and ended, how context is supplied, how audio is streamed, and how structured outputs are presented or saved in your product. You can align capture with:- Intake and assessments.
- Nursing and clinician workflows.
- Medication reviews.
- In-person and telehealth visits.
Common use cases
Capture Forms During In-Person Visits
Clinicians select a form type, start recording, conduct the visit in the room, then generate a populated form for review and save to the patient record.
Fill Forms in Virtual Video Visits
Clinicians join a telehealth visit, start recording, collect verbal responses, then generate a digital form for verification and submission.
Run Template-Driven Sessions
Discover Suki-defined templates via the Medical form templates API, bind template choices in session context, and retrieve structured instances after processing.
API versioning
All endpoints use the/api/v1/ prefix. v1 is the stable version. Non-breaking changes may ship without a major version jump. For policies and migration, refer to API guidelines.
These APIs may include Early Access features. If you are unsure what is enabled for your account, contact your Suki representative.
Suki Form filling APIs workflow
To integrate with the Form filling APIs, you follow a session-based workflow.Developer workflow
Authenticate with Suki
Authenticate with Suki to get a Suki Token, returned as
suki_token.Create a Form Filling Session
Create a Form filling session for the patient visit. One encounter can include more than one session.
Seed or Update Session Context
Seed or update session context.
Stream Visit Audio over WebSocket
Stream visit audio over WebSocket to the Suki backend.
End the Form Filling Session When Recording Is Finished
End the Form filling session when that recording is finished. Ending a session is not the same as closing the encounter.
Retrieve the Structured Form Output After Processing Finishes
Retrieve the structured form output after processing finishes.
If webhooks are enabled for your partner account, your application will receive automatic completion notifications instead of relying only on polling.