Suki home pagelight logodark logo
  • Support
Documentation
API
Mobile SDK
Web SDK
Documentation
  • Getting Started
Capabilities
  • Multilingual
  • Personalization
  • Problem-Based Charting
FAQs
  • Authentication
  • Audio Capture & Streaming
  • Technical Constraints & Risks
  • Miscellaneous
API Reference
  • Authentication
  • Ambient Session Management
  • Ambient Content Retrieval
  • Webhook
  • Info
FAQs

Technical Constraints & Risks

1. What are the exact list of whitelisted domains?

No we don’t have such pre-approved domains. In order to register to our webhook, you just need to give your call back URL so we can notify you there. This step is currently via manual sharing, in future we decided to upgrade this system

2. What is the specific IP range or proxy traversal configs?

N/A, we can share the IP of our system which calls callback URL if need be

3. What is the webhook transmission protocol?

A POST call will be made to the webhook hosted by the partner using the HTTPS protocol.

4. Is Webhook configured at Partner level?

Yes, the Webhook URL should be configured at the partner level during partner onboarding. We currently do not support session-based webhook callbacks or similar configurations, also webhook support is only for APIs and not for WebSDK.

5. Who creates encounter_id, for managing the encounter (encounter is made up of multiple ambient sessions)?

The client is responsible for creating and managing the encounter_id. We support combining sessions and generating the note based on the provided encounter_id.

6. What are prerequisites or steps to get started with Suki APIs?

  1. Obtain a developer platform test license (POC: Commercials team).
  2. Complete partner onboarding:
    • Share required details for partner creation in our system → you will receive a partner_id.
    • Let us know the unique identifier you will use in the OAuth 2.0 JWT token to identify the user (provider).
      Example: user_id, email_id, sid, pid, etc. (need not be actual id from your system, can be Hash value as well)
    • Provide your JWKS endpoint for accessing your public key.
    • Test authentication with Suki.

7. What is the basic flow for getting started with Suki Ambient APIs?

Here’s a minimal flow for your reference:

/login → /session/create → /context (optional) → /stream → /end

This flow automatically triggers note generation.

You can either:

  1. Use /status to poll the note generation status, then call /content to retrieve the note.
  2. Receive a notification through our webhook.

8. Discuss what happens for long duration call (duration > 30 mins)

As long as the stream is active, there is no upper limit on call duration. The system allows a maximum pause of 30 minutes during the streaming. If the user gets disconnected and then rejoins or loses websocket connection, we stitch the sessions together using the same session ID if sent

Note: Although there is no strict lower limit, we need a minimum amount of data to generate recommendations. For calls shorter than 1 minute, we may not have enough meaningful data to provide accurate recommendations and returns empty content

Assistant
Responses are generated using AI and may contain mistakes.
Audio Capture & StreamingMiscellaneous
Suki home pagelight logodark logo
xlinkedin
System Status

About

Contact UsTerms of UsePrivacy PolicyTrust Center
xlinkedin
xlinkedin
Powered by Mintlify