New to Suki?Consider following our comprehensive Learning path for a structured, step-by-step journey from onboarding to production deployment with progress tracking and time estimates.
- Set up authentication with Suki developer tools
- Choose and integrate your preferred SDK or API
- Create your first ambient session with patient information
- Record and stream audio for at least 1 minute
- Retrieve a fully structured with
Before you begin: Prerequisites
To integrate your application with Suki developer tools, you must meet the following requirements:OAuth-Compliant Authentication System
For secure user management
JWT Tokens with Consistent User Identifiers
For user authentication
Publicly Accessible JWKS Endpoint
For token validation
ES6 Compatible Browser
Modern browser support (for Web SDK)
- : Unique identifier provided by Suki that you will use to authenticate our SDKs and APIs.
How authentication works
Suki supports the following public key sharing authentication mechanisms. You will use your own identity provider to issue the token.- Stored Secret - You provide your public key to Suki, and we store it securely in our database as an encrypted file.
- JWKS URL: You host your public keys at a public JSON Web Key Set () endpoint, and Suki fetches them dynamically to verify tokens.
- Okta - You use Okta as your Identity Provider, and Suki obtains the public key from your Okta issuer URL.
- JWT Assertion - You share your public key as a signed JWT that follows the RFC 7523 standard. Suki then verifies this JWT using our public key.
Choose your integration path
Select the integration method that best fits your application requirements. Refer to the Integration paths overview to help you decide.Pick a workflow
Select a workflow below to get started. For ambient workflows, choose Web SDK, Mobile SDK, or Ambient APIs. For Form filling workflows, choose Form filling SDK or Form filling APIs.Ambient workflows are interoperable. You can start, continue, or review the same clinical note across Ambient APIs, Web SDK, and Mobile SDK. Refer to Ambient interoperability for more information.
- Ambient Workflow
- Form Filling Workflow
Web SDK Quickstart
Best for: React or JavaScript web applicationsPre-built UI components with automatic state management. Follow the Web SDK quickstart.
Mobile SDK Quickstart
Best for: Native iOS applicationsNative framework optimized for mobile audio capture. Start with the Mobile SDK overview.
Ambient APIs Quickstart
Best for: Custom implementationsMaximum flexibility with direct API control. Follow the Ambient API quickstart.
Headless Web SDK Quickstart
Ambient hooks without prebuilt UI for React apps. Follow the Headless Web SDK quickstart.
Dictation SDK Quickstart
Real-time Dictation for web apps. Follow the Dictation SDK quickstart.