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.

Suki provides REST APIs that let you add structured medical form workflows to your application. The APIs give you full control over your application workflows and user experience while enabling you to capture visit conversations and generate completed forms. The Form Filling APIs support sessions for both in-person and virtual encounters. During a session, clinicians collect patient information and receive structured form output based on Suki-defined templates. Most operations use endpoints and return standard HTTP status codes. Visit audio is streamed over the shared Partner (GET /ws/stream) by using your form-filling session ID. notify your application when processing is complete, which removes the need for continuous polling.

​
Key capabilities

The Form Filling APIs expose the capabilities below so you can run voice-driven medical form workflows from template selection through structured output in your EHR or internal systems.

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.
  • 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.

​
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 or telehealth visits etc.
Implement your own logic for session lifecycle, structured field review, editing before save, and downstream handoff, and connect to your EHR, telehealth stack, or internal systems using the Form Filling REST APIs, the Partner WebSocket stream, and optional webhooks.

​
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.

​
Available APIs

The following groups cover authentication, session lifecycle, retrieval, feedback, and template discovery for form-filling integrations.

Authentication

Endpoints for authentication and authorization.

Session Management

Endpoints for creating, managing, and ending form-filling sessions.

Content Retrieval

Endpoints for polling session status and retrieving structured medical-form output.

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.

​
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 authentication token also called suki_token.

Create a form-filling session

Create a form-filling session to start a new visit.

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 session when the visit is complete

End the session when the visit is complete.

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.
Best practices
  • Store partner_id, partner_token, and issued tokens securely; rotate credentials per your security policy.
  • Send API traffic over HTTPS and validate webhook signatures when your integration receives callbacks.
  • Read HTTP status and error bodies from REST responses; handle auth expiry by refreshing sdp_suki_token as documented.

​
Next steps

Refer to the Form Filling APIs quickstart to get started.
Last modified on May 22, 2026