# Suki

## Docs

- [A](https://developer.suki.ai/Glossary/a.md): Glossary terms starting with A
- [B](https://developer.suki.ai/Glossary/b.md): Glossary terms starting with B
- [C](https://developer.suki.ai/Glossary/c.md): Glossary terms starting with C
- [D](https://developer.suki.ai/Glossary/d.md): Glossary terms starting with D
- [E](https://developer.suki.ai/Glossary/e.md): Glossary terms starting with E
- [F](https://developer.suki.ai/Glossary/f.md): Glossary terms starting with F
- [G](https://developer.suki.ai/Glossary/g.md): Glossary terms starting with G
- [Suki Glossary](https://developer.suki.ai/Glossary/glossary.md): Browse glossary terms by category, letter, and search.
- [H](https://developer.suki.ai/Glossary/h.md): Glossary terms starting with H
- [I](https://developer.suki.ai/Glossary/i.md): Glossary terms starting with I
- [J](https://developer.suki.ai/Glossary/j.md): Glossary terms starting with J
- [K](https://developer.suki.ai/Glossary/k.md): Glossary terms starting with K
- [L](https://developer.suki.ai/Glossary/l.md): Glossary terms starting with L
- [M](https://developer.suki.ai/Glossary/m.md): Glossary terms starting with M
- [N](https://developer.suki.ai/Glossary/n.md): Glossary terms starting with N
- [O](https://developer.suki.ai/Glossary/o.md): Glossary terms starting with O
- [P](https://developer.suki.ai/Glossary/p.md): Glossary terms starting with P
- [R](https://developer.suki.ai/Glossary/r.md): Glossary terms starting with R
- [S](https://developer.suki.ai/Glossary/s.md): Glossary terms starting with S
- [T](https://developer.suki.ai/Glossary/t.md): Glossary terms starting with T
- [U](https://developer.suki.ai/Glossary/u.md): Glossary terms starting with U
- [V](https://developer.suki.ai/Glossary/v.md): Glossary terms starting with V
- [W](https://developer.suki.ai/Glossary/w.md): Glossary terms starting with W
- [Suki APIs Overview](https://developer.suki.ai/api-overview/overview.md): Overview of REST, WebSocket, and webhook APIs on the Suki Developer Platform, with links to Ambient APIs, Form Filling APIs, and API guidelines.
- [Suki APIs Quickstarts](https://developer.suki.ai/api-overview/quickstarts.md): Quickstarts for Suki APIs
- [Ambient Content Retrieval API](https://developer.suki.ai/api-reference/ambient-content-retrieval.md): Poll session status and retrieve transcripts, recordings, note content, and structured clinical data
- [Get Ambient Session Content](https://developer.suki.ai/api-reference/ambient-content/content.md): Retrieve generated clinical content from completed ambient session
- [Get Ambient Encounter Content](https://developer.suki.ai/api-reference/ambient-content/encounter-content.md): Retrieve generated clinical content from completed encounter
- [Get Ambient Encounter Structured Data](https://developer.suki.ai/api-reference/ambient-content/encounter-structured-data.md): Retrieve structured clinical data from completed encounter
- [Get Ambient Session Recording](https://developer.suki.ai/api-reference/ambient-content/recording.md): Get presigned URLs for ambient session recordings for streaming or download
- [Get Ambient Session Status](https://developer.suki.ai/api-reference/ambient-content/status.md): Check current status and processing state of ambient session
- [Get Ambient Session Structured Data](https://developer.suki.ai/api-reference/ambient-content/structured-data.md): Retrieve structured clinical data from completed ambient session
- [Get Session Transcript](https://developer.suki.ai/api-reference/ambient-content/transcript.md): Retrieve conversation transcript from completed ambient session
- [Dictation API](https://developer.suki.ai/api-reference/ambient-dictation.md): Create dictation sessions, stream audio for transcription, and end sessions
- [Ambient Session Management API](https://developer.suki.ai/api-reference/ambient-session-management.md): Create and manage ambient sessions, stream audio, attach metadata, and end sessions
- [Audio Streaming](https://developer.suki.ai/api-reference/ambient-sessions/audio-stream.md): WebSocket endpoint for real-time audio streaming during ambient sessions
- [Seed Ambient Session Context](https://developer.suki.ai/api-reference/ambient-sessions/context.md): Provide clinical context and patient information for ambient session
- [Create Ambient Session](https://developer.suki.ai/api-reference/ambient-sessions/create.md): Initialize a new ambient session for patient encounter documentation
- [End Ambient Session](https://developer.suki.ai/api-reference/ambient-sessions/end.md): Complete ambient session and trigger clinical note generation
- [Ambient Session Metadata](https://developer.suki.ai/api-reference/ambient-sessions/metadata.md): Add metadata to ambient session (deprecated; use context endpoint instead)
- [Update Ambient Session Context](https://developer.suki.ai/api-reference/ambient-sessions/update-context.md): Update existing session context with new clinical information
- [API Reference Guidelines](https://developer.suki.ai/api-reference/api-guidelines.md): Learn about the tags, indicators, and documentation standards we use in our API documentation
- [Asynchronous Notifications](https://developer.suki.ai/api-reference/asynchronous/webhook.md): Webhook endpoint for receiving asynchronous notifications from Suki platform
- [Create Dictation Session](https://developer.suki.ai/api-reference/audio-transcription/create-session.md): Creates a new transcription session for real-time audio transcription
- [End Dictation Session](https://developer.suki.ai/api-reference/audio-transcription/end-session.md): Ends an active transcription session and returns the final transcription results
- [Stream Audio To Dictation Session](https://developer.suki.ai/api-reference/audio-transcription/stream-transcription.md): Establishes a WebSocket connection to the transcription service for real-time audio streaming and transcription. Open only when the dictation session is READY or IDLE. Inbound frames use TranscriptionStreamResponse (partial and final transcripts, then a terminal EOF frame)
- [Authentication API](https://developer.suki.ai/api-reference/authentication.md): Learn how to register providers, obtain tokens, and retrieve JSON Web Key Set (JWKS) material for the Suki platform
- [JWKS URL](https://developer.suki.ai/api-reference/authentication/jwks.md): Public key endpoint for JWT token verification and signature validation
- [Login](https://developer.suki.ai/api-reference/authentication/login.md): Authenticate healthcare provider and obtain access token for API usage
- [Register](https://developer.suki.ai/api-reference/authentication/register.md): Register new healthcare provider or link existing provider to partner organization
- [Bearer Partner Type Authentication](https://developer.suki.ai/api-reference/bearer-partner-authentication.md): Learn how Bearer partner authentication works, when to pass provider_id, and how to integrate with REST APIs
- [Multilingual Support](https://developer.suki.ai/api-reference/capabilities/multilingual.md): Multi-language support for ambient sessions and clinical documentation
- [Personalization](https://developer.suki.ai/api-reference/capabilities/personalization.md): Customize clinical note generation based on provider preferences and specialty
- [Problem-Based Charting](https://developer.suki.ai/api-reference/capabilities/problem-based-charting.md): Problem-based clinical documentation approach with diagnosis context integration
- [Audio Capture & Streaming](https://developer.suki.ai/api-reference/faqs/audio-capture-streaming.md): Questions about audio capture, streaming, and WebSocket implementation
- [Authentication](https://developer.suki.ai/api-reference/faqs/authentication.md): Authentication and authorization questions for API access
- [Miscellaneous](https://developer.suki.ai/api-reference/faqs/miscellaneous.md): General API questions and miscellaneous topics
- [Technical Constraints & Risks](https://developer.suki.ai/api-reference/faqs/technical-constraints-risks.md): Technical limitations, constraints, and risk considerations for API integration
- [Ambient Session User Feedback](https://developer.suki.ai/api-reference/feedback/feedback.md): Submit user feedback on generated clinical content for continuous improvement
- [HTTPS Guidelines](https://developer.suki.ai/api-reference/https-guidelines.md): Learn about the standard HTTPS guidelines for APIs that Suki uses
- [Info API](https://developer.suki.ai/api-reference/info.md): Reference data for specialties, diagnoses, encounter types, visit types, LOINC codes, and provider roles
- [Supported Diagnosis Codes](https://developer.suki.ai/api-reference/info/diagnosis.md): Get list of supported diagnosis codes and medical conditions
- [Encounter Types](https://developer.suki.ai/api-reference/info/encounter-types.md): Get list of supported clinical encounter types
- [System Information](https://developer.suki.ai/api-reference/info/information.md): Get system information and supported configuration values
- [Supported LOINCs](https://developer.suki.ai/api-reference/info/loincs.md): Get list of supported LOINC codes for clinical note sections
- [Medication Order Metadata](https://developer.suki.ai/api-reference/info/orders.md): Get all supported medication order metadata in one response
- [Medication Coding Systems](https://developer.suki.ai/api-reference/info/orders-coding-systems.md): Get supported medication coding systems
- [Medication Dosage Units](https://developer.suki.ai/api-reference/info/orders-dosage-units.md): Get supported medication dosage units
- [Order Encounter Relations](https://developer.suki.ai/api-reference/info/orders-encounter-relations.md): Get supported order encounter relations
- [Medication Frequency Types](https://developer.suki.ai/api-reference/info/orders-frequencies.md): Get supported medication frequency types
- [Medication Timings](https://developer.suki.ai/api-reference/info/orders-medication-timings.md): Get supported medication timings
- [Order Origins](https://developer.suki.ai/api-reference/info/orders-origins.md): Get supported order origins
- [Medication Order Statuses](https://developer.suki.ai/api-reference/info/orders-statuses.md): Get supported medication order statuses
- [Provider Roles](https://developer.suki.ai/api-reference/info/provider-roles.md): Get list of supported healthcare provider roles
- [Supported Medical Specialties](https://developer.suki.ai/api-reference/info/specialties.md): Get list of supported medical specialties and their identifiers
- [Visit Types](https://developer.suki.ai/api-reference/info/visit-types.md): Get list of supported clinical visit types
- [Medication Orders Info API](https://developer.suki.ai/api-reference/medication-orders-info.md): Get supported medication order metadata in one response
- [Ambient APIs Overview](https://developer.suki.ai/api-reference/overview.md): Introduction to the Suki Ambient APIs: REST, Partner WebSocket audio, webhooks, sessions, clinical notes, and structured clinical output
- [API Changelog](https://developer.suki.ai/api-reference/product-updates/changelog.md): API product updates and announcements
- [Provider Authentication](https://developer.suki.ai/api-reference/provider-authentication.md): Learn how to authenticate providers and users to use the Suki ambient APIs
- [Ambient API Quickstart](https://developer.suki.ai/api-reference/quickstart.md): Step-by-step guide to authenticate, create a session, stream audio, and retrieve the clinical note
- [Security & Best Practices](https://developer.suki.ai/api-reference/security-best-practices.md): Learn about the best practices for securing your Suki APIs
- [Send Notifications API](https://developer.suki.ai/api-reference/send-notifications.md): Receive asynchronous notifications from Suki using your notification endpoint
- [User Feedback API](https://developer.suki.ai/api-reference/user-feedback.md): Submit feedback on ambient session entities such as transcripts or generated content
- [User Preferences API](https://developer.suki.ai/api-reference/user-preferences.md): Read and update end-user preferences for the Suki platform
- [User Preferences](https://developer.suki.ai/api-reference/user-preferences/preferences.md): Update user personalization preferences for clinical note generation
- [Dictation SDK Changelog](https://developer.suki.ai/dictation-sdk/changelog.md): Dictation SDK product updates and announcements
- [General](https://developer.suki.ai/dictation-sdk/faqs/general.md): General questions about the Suki Dictation SDK
- [Integration](https://developer.suki.ai/dictation-sdk/faqs/integration.md): Integration questions about the Suki Dictation SDK
- [Technical](https://developer.suki.ai/dictation-sdk/faqs/technical.md): Technical questions about the Suki Dictation SDK
- [Dictation SDK Architecture](https://developer.suki.ai/dictation-sdk/guides/architecture.md): Learn how your application, the Dictation SDK, sign-in, and Suki-hosted dictation fit together
- [Dictation SDK Authentication](https://developer.suki.ai/dictation-sdk/guides/authentication.md): Sign in to Suki before dictation opens: use SukiAuthManager with the partner ID and token Suki gives you
- [Callbacks](https://developer.suki.ai/dictation-sdk/guides/callbacks.md): Learn about Callback contract payload shape, and JavaScript vs React usage for onSubmit, onCancel, and onDraft in the Dictation SDK
- [Configuration](https://developer.suki.ai/dictation-sdk/guides/configuration.md): Learn how to configure the Suki Dictation SDK by configuring AuthConfig and ShowOptions
- [Dictation SDK Error Handling](https://developer.suki.ai/dictation-sdk/guides/error-handling.md): Learn to fix common Dictation SDK issues: auth, CSP, layout, missing callbacks, and client-only runtime requirements
- [Configuration examples](https://developer.suki.ai/dictation-sdk/guides/examples/configuration-examples.md): JavaScript and React code samples for SukiAuthManager AuthConfig and DictationClient ShowOptions
- [In-field Mode](https://developer.suki.ai/dictation-sdk/guides/in-field-mode.md): Learn how to embed Suki Dictation on a text field with in-field mode: your UI to start dictation, rootElement, fieldId, callbacks, and Suki's hosted overlay
- [Scratchpad Mode](https://developer.suki.ai/dictation-sdk/guides/scratchpad-mode.md): Learn about when to use scratchpad mode for the Suki Dictation SDK and how to configure it
- [Dictation SDK Installation](https://developer.suki.ai/dictation-sdk/installation.md): Install Suki Dictation SDK in your JavaScript or React application
- [Dictation SDK Overview](https://developer.suki.ai/dictation-sdk/introduction.md): Overview of the Suki Dictation SDK and how it works
- [Dictation SDK JavaScript Integration](https://developer.suki.ai/dictation-sdk/javaScript-integration/javaScript.md): Learn how to integrate the Dictation SDK in a JavaScript application (browser-based) using the JavaScript package provided by Suki
- [Dictation SDK Prerequisites](https://developer.suki.ai/dictation-sdk/prerequisites.md): Browser, layout, authentication, and partner setup required before you integrate the Suki Dictation SDK
- [Dictation SDK Quickstart](https://developer.suki.ai/dictation-sdk/quickstart.md): Get started with the Dictation SDK by installing the packages, creating the auth manager and client, and opening a dictation session
- [Dictation SDK React Integration](https://developer.suki.ai/dictation-sdk/react-integration/react.md): Learn how to integrate the Dictation SDK in a React application (browser-based) using the React package provided by Suki
- [AI-Optimized Documentation](https://developer.suki.ai/documentation/ai-optimized-documentation.md): Use the contextual menu on any Suki developer documentation page to copy content, open pages in AI tools, or connect the documentation MCP server
- [Ambient Audio Streaming](https://developer.suki.ai/documentation/ambient-audio-streaming.md): Learn how to stream ambient audio over WebSocket and retrieve final results with REST APIs
- [Ambient Clinical Documentation](https://developer.suki.ai/documentation/ambient-documentation.md): How Suki's AI automatically generates clinical notes from patient-provider conversations
- [Audio Streaming Overview](https://developer.suki.ai/documentation/audio-stream.md): Learn the handshake, wire format, and message order for ambient and dictation WebSockets to stream audio
- [Download Ambient Session Audio](https://developer.suki.ai/documentation/audio-streaming-download.md): Learn how to download the original audio recording from an ambient session for playback, verification, and compliance
- [Available Core Workflows](https://developer.suki.ai/documentation/core-workflows.md): Available core workflows for the Suki for Partners platform like Ambient, Dictation, and Form Filling
- [Audio Dictation](https://developer.suki.ai/documentation/dictation.md): Learn about the capabilities, common use cases, and how to choose Partner APIs, Web SDK, or Dictation SDK for Audio Dictation
- [Dictation Basic Usage](https://developer.suki.ai/documentation/dictation-basic-usage.md): Learn how to create a transcription session, stream audio, receive transcripts, and end the session when capture is finished
- [Audio Dictation Overview](https://developer.suki.ai/documentation/dictation-overview.md): Learn about Audio Dictation, when to use it, and how to integrate it into your application
- [Dictation Audio Streaming](https://developer.suki.ai/documentation/dictation-streaming.md): Learn how to stream dictation audio over WebSocket and handle real-time transcript results
- [Suki for Partners executive summary](https://developer.suki.ai/documentation/executive-summary.md): Executive summary for leaders evaluating Suki SDKs and APIs, including Web, Headless, Mobile, Dictation, ambient REST, and Form Filling: strategic value, partner proof points, integration options, business benefits, and next steps.
- [Authentication](https://developer.suki.ai/documentation/faqs/authentication.md): Authentication mechanisms and security questions for Suki platform integration
- [General](https://developer.suki.ai/documentation/faqs/general.md): Frequently asked questions about the Suki Developer Platform and integration benefits
- [Security & Compliance](https://developer.suki.ai/documentation/faqs/security.md): Security, compliance, and data retention policies for the Suki Developer Platform
- [Form Filling](https://developer.suki.ai/documentation/form-filling.md): Learn about Form filling capabilities, common use cases, and how to integrate with Form Filling Partner APIs
- [Form Filling Basic Usage](https://developer.suki.ai/documentation/form-filling-basic-usage.md): Learn how to create a form-filling session, seed context, stream audio, end the session, and retrieve structured form data
- [Form Filling Workflows - Integration Decision Guide](https://developer.suki.ai/documentation/form-filling-integration-decision-guide.md): Compare Form filling APIs to select the right integration method for form filling workflows in your healthcare application
- [Form Filling Overview](https://developer.suki.ai/documentation/form-filling-overview.md): Learn about form filling, when to use it, and how to integrate it into your application
- [Quickstart Guide](https://developer.suki.ai/documentation/getting-started.md): Step-by-step guide to integrate Suki's Ambient APIs and SDKs into your healthcare application
- [Home Page](https://developer.suki.ai/documentation/home.md): Suki Developer Documentation
- [Ambient Workflows - Integration Decision Guide](https://developer.suki.ai/documentation/integration-decision-guide.md): Compare Direct APIs, Web SDK, Headless Web SDK, and Mobile SDK to select the right integration method for your healthcare application
- [Developer Learning Path](https://developer.suki.ai/documentation/learning-path.md): Step-by-step guided journey to integrate Suki using ambient or form filling workflows with the Web SDK, Headless Web SDK, Mobile SDK, or REST APIs
- [Documentation MCP Integration](https://developer.suki.ai/documentation/mcp.md): Connect Suki developer documentation as an MCP server in your AI code editor to search guides, API reference, and SDK docs while you integrate
- [Medication Orders](https://developer.suki.ai/documentation/medication-orders.md): Learn how the Medical Orders API and Suki Medical Orders Service turn clinician conversations into structured, EHR-ready medication orders
- [Note Sections (LOINC Codes)](https://developer.suki.ai/documentation/note-sections.md): LOINC standardized clinical note sections supported by Suki for EHR integration
- [Welcome To Suki For Partners](https://developer.suki.ai/documentation/overview.md): Suki for Partners is Suki's developer platform that provides Clinical documentation, Form filling, and Dictation capabilities into your healthcare applications. With our APIs and SDKs, you can add advanced AI features without the complexity of building and maintaining a clinical AI system. Watch the…
- [Partner Authentication](https://developer.suki.ai/documentation/partner-authentication.md): JWT-based authentication implementation for Suki platform partners
- [Partner Onboarding](https://developer.suki.ai/documentation/partner-onboarding.md): Complete onboarding process to become a Suki Developer Platform partner
- [Supported Medical Specialties](https://developer.suki.ai/documentation/specialties.md): Complete list of 100+ medical specialties supported by the Suki Platform
- [Support](https://developer.suki.ai/documentation/support.md): Get help with integration issues and contact information for Suki platform support
- [Suki SDKs technical execution](https://developer.suki.ai/documentation/technical-execution.md): Partner technical execution: how integration works, what partners need, critical technical requirements for Web SDK, Mobile SDK, Suki REST APIs, and Headless Web SDK, integration timeline, and expanded phases.
- [Partner Use Cases](https://developer.suki.ai/documentation/use-case.md): Partner scenarios for EHRs, telehealth, care management, revenue cycle, and related applications: Ambient, Dictation, and Form filling. Search, filter, open a card, then use View documentation.
- [Webhook Configuration](https://developer.suki.ai/documentation/webhook/configuration.md): Register your webhook callback URL during partner onboarding and meet endpoint requirements for receiving Suki notifications
- [Webhook Event Types](https://developer.suki.ai/documentation/webhook/event-types.md): Event types your webhook endpoint receives when ambient sessions complete, fail, time out, or are cancelled
- [Notification Webhook For Partners](https://developer.suki.ai/documentation/webhook/overview.md): Learn how Suki pushes notifications to your application via Notification Webhook and how push compares to pull
- [Webhook Payload & Response](https://developer.suki.ai/documentation/webhook/payload-and-response.md): Learn about the structure of the webhook payload and response
- [Webhook Quickstart](https://developer.suki.ai/documentation/webhook/quickstart.md): Step-by-step guide to configure, implement, and test a Suki notification webhook endpoint
- [Webhook Signature Verification](https://developer.suki.ai/documentation/webhook/signature-verification.md): Learn how to verify the signature of the webhook request to ensure it is genuine
- [Integration Paths Overview](https://developer.suki.ai/documentation/workflows.md): Suki for Partners offers Ambient, Dictation, and Form Filling workflows. Learn more about each workflow and how to choose the right one for your use case
- [Authentication API](https://developer.suki.ai/form-filling-api-reference/authentication.md): Learn how to register providers, obtain tokens, and retrieve JSON Web Key Set (JWKS) material for the Form Filling APIs.
- [JWKS URL](https://developer.suki.ai/form-filling-api-reference/authentication/jwks.md): Public key endpoint for JWT token verification and signature validation
- [Login](https://developer.suki.ai/form-filling-api-reference/authentication/login.md): Authenticate healthcare provider and obtain access token for API usage
- [Register](https://developer.suki.ai/form-filling-api-reference/authentication/register.md): Register new healthcare provider or link existing provider to partner organization
- [Form Filling API Changelog](https://developer.suki.ai/form-filling-api-reference/changelog.md): Release notes for the Form Filling APIs.
- [Form Filling Content Retrieval](https://developer.suki.ai/form-filling-api-reference/form-filling-content-retrieval.md): Retrieve content from a form-filling session
- [Form Filling Feedback](https://developer.suki.ai/form-filling-api-reference/form-filling-feedback.md): Submit feedback for a form-filling session
- [Form Filling Info](https://developer.suki.ai/form-filling-api-reference/form-filling-info.md): Get info about a form-filling session
- [Form Filling Session Management](https://developer.suki.ai/form-filling-api-reference/form-filling-session-management.md): Create and manage form-filling sessions: context, status, structured data, feedback, and end session
- [Seed Form Filling Session Context](https://developer.suki.ai/form-filling-api-reference/form-filling-sessions/context.md): Seed form-filling session context for a form-filling session using the form-filling URL binding
- [Create Form Filling Session](https://developer.suki.ai/form-filling-api-reference/form-filling-sessions/create.md): Create a form-filling session and obtain an ambient session identifier for subsequent calls
- [End Form Filling Session](https://developer.suki.ai/form-filling-api-reference/form-filling-sessions/end.md): End a form-filling session
- [Form Filling Session Feedback](https://developer.suki.ai/form-filling-api-reference/form-filling-sessions/feedback.md): Submit feedback for a form-filling session entity
- [Get Form Filling Session Status](https://developer.suki.ai/form-filling-api-reference/form-filling-sessions/status.md): Poll processing status for a form-filling session
- [Get Form Filling Structured Data](https://developer.suki.ai/form-filling-api-reference/form-filling-sessions/structured-data.md): Retrieve structured medical form data for a form-filling session
- [Update Form Filling Session Context](https://developer.suki.ai/form-filling-api-reference/form-filling-sessions/update-context.md): Partially update form-filling session context using the form-filling URL binding
- [Suki Medical Form Templates](https://developer.suki.ai/form-filling-api-reference/info/suki-medical-form-templates.md): List Suki-defined medical form templates available for form-filling sessions
- [Form Filling APIs Overview](https://developer.suki.ai/form-filling-api-reference/overview.md): Introduction to the Suki Form Filling APIs: REST, shared Partner WebSocket audio, webhooks, sessions, and structured medical-form output
- [Form Filling API Quickstart](https://developer.suki.ai/form-filling-api-reference/quickstart.md): Step-by-step guide to authenticate, create a session, stream audio over WebSocket, end the session, and retrieve structured form output or use webhooks
- [Platform Client & Provider](https://developer.suki.ai/headless-web-sdk/api-reference/platform-client.md): Headless Web SDK Client and Provider reference
- [Headless Web SDK Types Reference](https://developer.suki.ai/headless-web-sdk/api-reference/types.md): React type definitions and interfaces for the Suki Headless Web SDK
- [AmbientSessionStatus Type](https://developer.suki.ai/headless-web-sdk/api-reference/types/ambient-session-status.md): Status type for ambient sessions
- [LoginResponse Type](https://developer.suki.ai/headless-web-sdk/api-reference/types/login-response.md): Response type for login method
- [RegistrationResponse Type](https://developer.suki.ai/headless-web-sdk/api-reference/types/registration-response.md): Response type for registerUser method
- [SessionContext Types](https://developer.suki.ai/headless-web-sdk/api-reference/types/session-context.md): Type definitions for session context and response
- [UpdatePartnerToken Type](https://developer.suki.ai/headless-web-sdk/api-reference/types/update-partner-token-response.md): Response type for updatePartnerToken method
- [UseAmbientSessionParams Type](https://developer.suki.ai/headless-web-sdk/api-reference/types/use-ambient-session-params.md): Parameters type for useAmbientSession hook
- [UseAmbientSessionReturn Type](https://developer.suki.ai/headless-web-sdk/api-reference/types/use-ambient-session-return.md): Return type for useAmbientSession hook
- [UseAuthParams Type](https://developer.suki.ai/headless-web-sdk/api-reference/types/use-auth-params.md): Parameters type for useAuth hook
- [Headless Web SDK Authentication](https://developer.suki.ai/headless-web-sdk/authentication.md): Learn how to authenticate with the Suki Headless Web SDK
- [Headless Web SDK Changelog](https://developer.suki.ai/headless-web-sdk/changelog.md): Headless Web SDK product updates and announcements
- [Authentication and Session Flow](https://developer.suki.ai/headless-web-sdk/example/auth-session-flow.md): Example code for the full flow from authentication to recording in one component
- [Authentication Example](https://developer.suki.ai/headless-web-sdk/example/authentication-example.md): Example code for building a component that offers manual Sign In and Register options
- [General](https://developer.suki.ai/headless-web-sdk/faqs/general.md): General questions about Headless Web SDK
- [Implementation](https://developer.suki.ai/headless-web-sdk/faqs/implementation.md): Implementation questions about the Suki Headless Web SDK
- [Technical](https://developer.suki.ai/headless-web-sdk/faqs/technical.md): Technical questions about Headless Web SDK
- [Error Handling](https://developer.suki.ai/headless-web-sdk/guides/error-handling.md): Learn how to handle errors and exceptions in the Suki Headless Web SDK
- [Create Ambient Session](https://developer.suki.ai/headless-web-sdk/guides/hooks/ambient-hook.md): Learn how to use the useAmbient hook to create an ambient session and obtain an ambientSessionId in the Headless Web SDK
- [Manage Ambient Session](https://developer.suki.ai/headless-web-sdk/guides/hooks/ambient-session-hook.md): Learn how to manage an ambient session lifecycle within your application while using the Suki Headless Web SDK
- [Authentication Hook](https://developer.suki.ai/headless-web-sdk/guides/hooks/auth-hook.md): Learn how to use the useAuth hook to manage user identity, tokens, and login state in the Headless Web SDK
- [Ambient Session Workflow Overview](https://developer.suki.ai/headless-web-sdk/guides/hooks/hooks-overview.md): Overview of React hooks available in the Suki Headless Web SDK for authentication and ambient documentation workflows
- [Headless Web SDK Integration Patterns](https://developer.suki.ai/headless-web-sdk/guides/integration-patterns.md): Learn the best practices to implement recommended pause and submit patterns for useAmbientSession, and avoid mistakes that can discard audio or conflict with the Headless Web SDK
- [Offline Mode](https://developer.suki.ai/headless-web-sdk/guides/offline-mode.md): Learn how to handle offline sessions in the Suki Headless Web SDK
- [Network Transitions](https://developer.suki.ai/headless-web-sdk/guides/online-offline-behavior.md): Understand how the Headless Web SDK handles network connectivity and transitions between online and offline states
- [Headless Web SDK Installation](https://developer.suki.ai/headless-web-sdk/installation.md): Install Suki Headless Web SDK in your React application
- [Headless Web SDK Overview](https://developer.suki.ai/headless-web-sdk/introduction.md): A collection of React hooks and core functionality to build web applications on top of Suki ambient intelligence capabilities without pre-built UI components
- [Headless Web SDK Prerequisites](https://developer.suki.ai/headless-web-sdk/prerequisites.md): Requirements and setup needed before integrating the Suki Headless Web SDK
- [Headless Web SDK Quickstart](https://developer.suki.ai/headless-web-sdk/quickstart.md): Get started with the Suki Headless Web SDK, from installation to your first recording
- [Clearing Sessions](https://developer.suki.ai/mobile-sdk/ambient-guides/clearing-sessions.md): Learn how to clear all locally stored Suki sessions from the device in the mobile SDK
- [Create Session](https://developer.suki.ai/mobile-sdk/ambient-guides/create-session.md): Learn how to create an ambient session and enrich it with detailed clinical context in the iOS SDK
- [Session Events & Delegates](https://developer.suki.ai/mobile-sdk/ambient-guides/events-and-delegates.md): Learn how to use the session events and delegates to handle the session lifecycle in the mobile SDK
- [Offline Mode](https://developer.suki.ai/mobile-sdk/ambient-guides/offline-mode.md): Learn how the Mobile SDK handles network interruptions and enters offline mode in the mobile SDK
- [Provide Additional Clinical Context](https://developer.suki.ai/mobile-sdk/ambient-guides/provide-clinical-context.md): Learn how to provide additional clinical context to the ambient session in the iOS SDK for better note generation
- [Recording Controls](https://developer.suki.ai/mobile-sdk/ambient-guides/recording.md): Learn how to manage the full lifecycle of an ambient session using the recording controls in the mobile SDK
- [Session Status & Retrieve Content](https://developer.suki.ai/mobile-sdk/ambient-guides/session-status-and-content-retrieval.md): Learn how to check the processing status and retrieve the generated content of a session in the mobile SDK
- [Mobile SDK Configuration](https://developer.suki.ai/mobile-sdk/configuration.md): How to configure the Suki Mobile SDK
- [Content Retrieval](https://developer.suki.ai/mobile-sdk/faqs/content-retrieval.md): Retrieving generated clinical content, transcripts, and structured data from sessions
- [General](https://developer.suki.ai/mobile-sdk/faqs/general.md): General questions about Mobile SDK features, compatibility, and implementation
- [Installation & Setup](https://developer.suki.ai/mobile-sdk/faqs/installation-setup.md): Mobile SDK installation requirements, setup process, and configuration questions
- [Offline & Networking](https://developer.suki.ai/mobile-sdk/faqs/offline-networking.md): Offline mode, network handling, and connectivity features in the Mobile SDK
- [Session Management](https://developer.suki.ai/mobile-sdk/faqs/session-management.md): Managing ambient sessions, lifecycle, and data handling in the Mobile SDK
- [Troubleshooting](https://developer.suki.ai/mobile-sdk/faqs/troubleshooting.md): Common Mobile SDK issues, error codes, and troubleshooting solutions
- [Mobile SDK Capabilities](https://developer.suki.ai/mobile-sdk/features.md): Core features and capabilities of the Suki Mobile SDK for iOS healthcare applications
- [Mobile SDK Installation](https://developer.suki.ai/mobile-sdk/installation.md): Learn how to install and set up the Suki Mobile SDK
- [Mobile SDK Overview](https://developer.suki.ai/mobile-sdk/overview.md): A collection of iOS libraries to build native iOS applications on top of Suki ambient intelligence capabilities
- [Mobile SDK Changelog](https://developer.suki.ai/mobile-sdk/product-updates/changelog.md): Mobile SDK product updates and announcements
- [Release notes rss](https://developer.suki.ai/scripts/release-notes-rss.md)
- [Suki SDKs Overview](https://developer.suki.ai/sdk-overview/overview.md): Overview of the Web SDK, Headless Web SDK, Mobile SDK, and Dictation SDK on the Suki Developer Platform, with links to quickstarts, changelogs, and integration guidance.
- [Suki SDKs Quickstart](https://developer.suki.ai/sdk-overview/quickstart.md): Quickstarts for the Suki SDKs
- [Announcements For Partners](https://developer.suki.ai/updates/announcements.md): Important announcements and updates about the Suki Developer Documentation site
- [April 2025](https://developer.suki.ai/updates/apr2025-release-notes.md): April 2025 release notes for Suki APIs and SDKs
- [April 2026](https://developer.suki.ai/updates/apr2026-release-notes.md): April 2026 release notes for Suki APIs and SDKs
- [December 2024](https://developer.suki.ai/updates/dec2024-release-notes.md): December 2024 release notes for Suki APIs and SDKs
- [December 2025](https://developer.suki.ai/updates/dec2025-release-notes.md): December 2025 release notes for Suki APIs and SDKs
- [February 2025](https://developer.suki.ai/updates/feb2025-release-notes.md): February 2025 release notes for Suki APIs and SDKs
- [February 2026](https://developer.suki.ai/updates/feb2026-release-notes.md): February 2026 release notes for Suki APIs and SDKs
- [January 2026](https://developer.suki.ai/updates/jan2026-release-notes.md): January 2026 release notes for Suki APIs and SDKs
- [July 2024](https://developer.suki.ai/updates/jul2024-release-notes.md): July 2024 release notes for Suki APIs and SDKs
- [July 2025](https://developer.suki.ai/updates/jul2025-release-notes.md): July 2025 release notes for Suki APIs and SDKs
- [June 2025](https://developer.suki.ai/updates/jun2025-release-notes.md): June 2025 release notes for Suki APIs and SDKs
- [June 2026](https://developer.suki.ai/updates/jun2026-release-notes.md): June 2026 release notes for Suki APIs and SDKs
- [March 2026](https://developer.suki.ai/updates/mar2026-release-notes.md): March 2026 release notes for Suki APIs and SDKs
- [May 2025](https://developer.suki.ai/updates/may2025-release-notes.md): May 2025 release notes for Suki APIs and SDKs
- [May 2026](https://developer.suki.ai/updates/may2026-release-notes.md): May 2026 release notes for Suki APIs and SDKs
- [November 2025](https://developer.suki.ai/updates/nov2025-release-notes.md): November 2025 release notes for Suki APIs and SDKs
- [October 2025](https://developer.suki.ai/updates/oct2025-release-notes.md): October 2025 release notes for Suki APIs and SDKs
- [Release & Versioning Policy](https://developer.suki.ai/updates/release-and-versioning.md): Learn how Suki versions APIs and SDKs, where release information is published, and how to plan upgrades and migrations for your integration
- [Release Notes](https://developer.suki.ai/updates/release-notes.md): Release notes by workflow (ambient clinical intelligence, form filling, dictation) and integration surface, with links to product changelogs.
- [Release Notes](https://developer.suki.ai/updates/release-notes-rss-feed.md): Stay updated with the latest releases and improvements for Suki for Partners.
- [September 2025](https://developer.suki.ai/updates/sep2025-release-notes.md): September 2025 release notes for Suki APIs and SDKs
- [Classes Reference](https://developer.suki.ai/web-sdk/api-reference/classes.md): Web SDK class definitions, constructors, and methods reference
- [Components Reference](https://developer.suki.ai/web-sdk/api-reference/components.md): Web SDK React components, props, and usage examples
- [Functions Reference](https://developer.suki.ai/web-sdk/api-reference/functions.md): Web SDK utility functions, initialization methods, and helper functions
- [Hooks Reference](https://developer.suki.ai/web-sdk/api-reference/hooks.md): Learn about Web SDK React hooks for state management and SDK integration
- [Providers Reference](https://developer.suki.ai/web-sdk/api-reference/providers.md): Web SDK React providers and context configuration
- [Web SDK Types Reference](https://developer.suki.ai/web-sdk/api-reference/types.md): Web SDK TypeScript type definitions, interfaces, and enums
- [AmbientOptions Type](https://developer.suki.ai/web-sdk/api-reference/types/ambient-options.md): AmbientOptions type represents the configuration options for ambient session functionality
- [Diagnosis Type](https://developer.suki.ai/web-sdk/api-reference/types/diagnosis.md): Diagnosis type represents the structure for clinical diagnosis information
- [EmitterEvents Type](https://developer.suki.ai/web-sdk/api-reference/types/emitter-events.md): EmitterEvents type represents the events that can be emitted by the web SDK
- [Encounter Type](https://developer.suki.ai/web-sdk/api-reference/types/encounter.md): Encounter type represents a clinical encounter with patient information
- [InitOptions Type](https://developer.suki.ai/web-sdk/api-reference/types/init-options.md): InitOptions type represents the configuration options for initializing the SDK
- [LogLevel Type](https://developer.suki.ai/web-sdk/api-reference/types/log-level.md): LogLevel type represents the available log levels for controlling debug output verbosity
- [MountOptions Type](https://developer.suki.ai/web-sdk/api-reference/types/mount-options.md): MountOptions type represents the configuration options for mounting the SDK to a DOM element
- [NoteContent Type](https://developer.suki.ai/web-sdk/api-reference/types/note-content.md): NoteContent type represents the content structure for clinical notes
- [PartnerDetails Type](https://developer.suki.ai/web-sdk/api-reference/types/partner-details.md): PartnerDetails type represents the partner authentication and provider information
- [Patient Type](https://developer.suki.ai/web-sdk/api-reference/types/patient.md): Patient type represents demographic and identification information
- [Section Type](https://developer.suki.ai/web-sdk/api-reference/types/section.md): Section type represents a clinical note section using LOINC codes for ambient sessions
- [SectionEditingOptions Type](https://developer.suki.ai/web-sdk/api-reference/types/section-editing-options.md): SectionEditingOptions type represents the configuration options for section editing features
- [Suki Error Reference](https://developer.suki.ai/web-sdk/api-reference/types/suki-error.md): SukiError type represents the structure for SDK errors
- [ThemeOptions Type](https://developer.suki.ai/web-sdk/api-reference/types/theme-options.md): ThemeOptions type represents the configuration options for customizing the SDK appearance
- [UIOptions Type](https://developer.suki.ai/web-sdk/api-reference/types/ui-options.md): UIOptions type represents the user interface configuration options for the SDK
- [Web SDK For Audio Dictation](https://developer.suki.ai/web-sdk/dictation-overview.md): Overview of audio dictation in the Suki Web SDK for JavaScript and React applications
- [Advanced Configuration](https://developer.suki.ai/web-sdk/examples/advanced-configuration.md): Learn to use the advanced JavaScript and React Web SDK configuration options and customization features
- [Ambient Events](https://developer.suki.ai/web-sdk/examples/ambient-events.md): Learn how to use ambient events in the Suki React Web SDK to track and manage ambient interactions
- [Basic Usage](https://developer.suki.ai/web-sdk/examples/basic-usage.md): Learn how to integrate the Suki React Web SDK into your application
- [Control Visibility](https://developer.suki.ai/web-sdk/examples/control-visibility.md): Learn how to control visibility of the Suki React Web SDK using the embedded close button.
- [Dynamic Encounter](https://developer.suki.ai/web-sdk/examples/dynamic-encounter.md): Learn how to dynamically set the encounter data in the Suki React Web SDK
- [Test Mode](https://developer.suki.ai/web-sdk/examples/test-mode.md): Learn how to use Suki React Web SDK in test mode for development and testing purposes before going live
- [Theming and Customization](https://developer.suki.ai/web-sdk/examples/theming-and-customization.md): Learn how to theme the Suki React SDK to match your application's design.
- [Use Suki SDK Inside an Iframe](https://developer.suki.ai/web-sdk/examples/using-inside-iframe.md): Learn how to use the Suki Web SDK inside an iframe.
- [Automatic User Onboarding](https://developer.suki.ai/web-sdk/faqs/auto-onboarding.md): Questions about automatic user registration and onboarding with Web SDK
- [General](https://developer.suki.ai/web-sdk/faqs/general.md): General questions about Web SDK features, capabilities, and browser compatibility
- [Implementation](https://developer.suki.ai/web-sdk/faqs/implementation.md): Implementation questions and best practices for Web SDK integration
- [Technical](https://developer.suki.ai/web-sdk/faqs/technical.md): Technical questions about Web SDK architecture, performance, and troubleshooting
- [Ambient Session Overview](https://developer.suki.ai/web-sdk/guides/ambient.md): Learn how to implement ambient sessions with the Web SDK
- [Create Session](https://developer.suki.ai/web-sdk/guides/ambient-implementation.md): Learn to create a session and implement controlled session management with the Suki Web SDK
- [Multilingual Sessions](https://developer.suki.ai/web-sdk/guides/ambient-multilingual.md): Use multilingual capability in ambient sessions; the SDK generates notes in English from any language
- [Offline Mode](https://developer.suki.ai/web-sdk/guides/ambient-offline-mode.md): How ambient sessions behave during network interruptions, what triggers offline mode, and recovery with the Web SDK
- [Problem-Based Charting In Web SDK](https://developer.suki.ai/web-sdk/guides/ambient-problem-based-charting.md): Enable PBC, set a PBN section, and pass existing patient diagnoses so notes merge with EMR problems
- [Re-Ambient & Session Recovery](https://developer.suki.ai/web-sdk/guides/ambient-session-recovery.md): Continue an existing note with re-ambient and recover abandoned ambient sessions with the Web SDK
- [Session Status & Events](https://developer.suki.ai/web-sdk/guides/ambient-session-status.md): Track ambient session status and lifecycle events (start, pause, resume, cancel, submit) with the Web SDK
- [Branding & Layout](https://developer.suki.ai/web-sdk/guides/branding.md): Customize Web SDK UI appearance with branding guidelines and layout options
- [Audio Dictation In Web SDK For JavaScript](https://developer.suki.ai/web-sdk/guides/dictation-javascript.md): Learn how to use dictation in the Suki Web SDK for JavaScript applications
- [Audio Dictation In Web SDK For React](https://developer.suki.ai/web-sdk/guides/dictation-react.md): Learn how to use dictation in the Suki Web SDK for React applications
- [Error Handling In Web SDK](https://developer.suki.ai/web-sdk/guides/error-handling.md): Learn how to handle errors and exceptions in the Web SDK
- [Note Management](https://developer.suki.ai/web-sdk/guides/note-management.md): Learn how to manage clinical notes, content retrieval, and note lifecycle with the Web SDK
- [Telehealth](https://developer.suki.ai/web-sdk/guides/telehealth.md): Learn how to enable the telehealth feature in the Suki Web SDK
- [Token Refresh](https://developer.suki.ai/web-sdk/guides/token-refresh.md): Learn how to implement automatic token refresh for the Suki Web SDK
- [Web SDK Installation](https://developer.suki.ai/web-sdk/installation.md): Install Suki.js Web SDK in your JavaScript or React application
- [Medication Orders Error Codes](https://developer.suki.ai/web-sdk/medication-orders/error-codes.md): Learn how to handle errors and exceptions during Medication orders generation in the Headed Web SDK
- [Medication Orders Interoperability](https://developer.suki.ai/web-sdk/medication-orders/interoperability.md): Learn how Web SDK Medication orders align with Ambient API structured data for shared ingestion and EHR mapping
- [Medication Orders Overview](https://developer.suki.ai/web-sdk/medication-orders/overview.md): Learn how Medication orders work in the Headed Web SDK, key benefits, use cases, and how to enable this capability
- [Medication Orders Payload Structure](https://developer.suki.ai/web-sdk/medication-orders/payload-structure.md): Learn about the Medication orders JSON payload structure returned on Web SDK note submission
- [Minimized Layout Implementation](https://developer.suki.ai/web-sdk/minimized-layout/implementation.md): Learn about the host responsibilities, layout signals, and validation for minimized ambient layout in the headed Web SDK
- [Minimized Layout](https://developer.suki.ai/web-sdk/minimized-layout/overview.md): Learn about the minimized layout, and when it gets enabled for the headed Web SDK in your application
- [Web SDK Overview](https://developer.suki.ai/web-sdk/overview.md): A collection of JavaScript & React libraries to build web applications on top of Suki ambient intelligence capabilities with pre-built UI components
- [Web SDK Prerequisites](https://developer.suki.ai/web-sdk/prerequisites.md): Requirements and setup needed before integrating the Suki Web SDK
- [Web SDK Changelog](https://developer.suki.ai/web-sdk/product-updates/changelog.md): Web SDK product updates and announcements
- [Migrating To Web SDK v2](https://developer.suki.ai/web-sdk/product-updates/migration-to-v2.md): Complete guide to migrate from Suki.js v1 to v2 with enhanced provider onboarding, LOINC standardization, and improved UI customization
- [Migrating To Web SDK v3](https://developer.suki.ai/web-sdk/product-updates/migration-to-v3.md): Learn how to migrate from Web SDK v2 to v3
- [Web SDK Quickstart](https://developer.suki.ai/web-sdk/quickstart.md): Get started with Suki.js Web SDK - from installation to mounting the SDK UI

## OpenAPI Specs

- [openapi](https://developer.suki.ai/api-reference/openapi.json)