NewThe Ambient APIs are now with other Suki products that support Ambient workflows. Pass
emr_encounter_id when you create an ambient session so clinicians can continue the same clinical note across Ambient APIs, Mobile SDK, and Web SDK.Refer to Ambient interoperability for the platform overview.GET /ws/stream) using the ambient session ID. When note generation is complete, Suki sends a notification to your application, so you don’t need to continuously poll for results.
The same APIs also support Dictation when you need transcription without the full clinical note workflow. You create a Dictation session, stream audio, and retrieve the transcript in real time. To learn more, refer to Audio Dictation.
Key capabilities
The Ambient APIs provide the following capabilities, so you can control audio capture, note quality, and how generated outputs reach your product and downstream systems.Real-Time Visit Capture
Create ambient sessions, stream encounter audio over the Partner WebSocket, and pause, resume, or end capture when the visit is complete.
Clinical Notes & Transcripts
Turn provider-patient conversations into structured clinical notes and full transcripts, then retrieve draft content and metadata after processing finishes.
Multilingual Support
Let patients speak in 80+ languages while Suki generates English notes and transcripts that fit standard EHR workflows.
Personalization
Set provider-level verbosity and section formats through the User Preferences API so generated notes match how each clinician documents care.
Problem-Based Charting (PBC)
Organize documentation by patient problems, merge existing diagnoses from context, and retrieve ICD10, IMO, SNOMED, and HCC structured output for EHR integration.
Structured Clinical Data
Extract diagnoses, medications, and other encounter-level artifacts from the conversation for charting, orders, and analytics in your application.
Custom Note Sections
Configure which LOINC-based sections appear in generated notes so output aligns with your specialty templates and compliance requirements.
Dictation
Run speech-to-text sessions when you need transcription without the full ambient clinical note workflow.
Webhooks & Feedback
Receive webhook callbacks when processing completes, and submit feedback on transcripts or generated content to track quality over time.
Requirements
Before you can use the ambient & Dictation 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.
- HTTP/2.0 compliant authentication system (e.g. OAuth 2.0, JWT, etc.).
- JWT tokens with consistent user identifiers (e.g.
sub,email,userId, etc.). - Publicly accessible JWKS endpoint for token verification.
Common integration patterns and use cases
The Ambient APIs provide REST and WebSocket endpoints to create ambient sessions, stream audio, complete sessions, and retrieve clinical outputs. Your application owns the capture UI, session orchestration, and how notes are reviewed or persisted. The following examples show common ways to integrate the Ambient APIs into your application.Capture Ambient Audio in Your Own UI
Create the session through REST, stream encounter audio over the Partner WebSocket, and expose recording controls in your own interface.
Complete Sessions Asynchronously
End the session, receive a completion webhook or poll status, then retrieve the generated clinical note and related outputs when processing completes.
Hand Off Content to Your EHR
Map LOINC-based note sections, transcripts, and available structured data into your review and EHR persistence workflow after the session completes.
Capture Dictation without Ambient Notes
Use Dictation APIs when your application needs real-time transcription without running the ambient note-generation workflow.
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.
Available Partner APIs for Ambient and Dictation workflows
The following set of Partner APIs are available for the Ambient and Dictation workflows. 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 ambient session management.
Dictation
Endpoints for Dictation.
Content Retrieval
Endpoints for content retrieval after the session is completed.
Preferences
Endpoints for managing the user preferences.
Feedback
Endpoints for managing user feedback.
Notifications
Endpoints for managing notifications to your service.
Information
Endpoints for retrieving information about the encounter type, visit type, and provider role.
Medication Orders Info
Endpoints for retrieving information about the medication orders.
Suki Ambient APIs workflow
To integrate with the Suki , you follow a session-based workflow.Developer workflow
Authenticate with Suki
Authenticate with Suki to get a Suki authentication token also called
suki_token.Create an Ambient Session
Create an ambient session to start a new visit.
Stream Visit Audio over WebSocket
Stream visit audio over WebSocket to the Suki backend.
End the Session When the Visit Is Complete
End the session when the visit is complete.
Retrieve Generated Outputs Through REST Endpoints
Retrieve generated outputs through REST endpoints.
If webhooks are enabled for your partner account, your application will receive automatic completion notifications instead of relying only on polling.