Technical Constraints & Risks

Technical limitations, constraints, and risk considerations for API integration

What is the exact list of whitelisted domains?

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

What is the specific IP range or proxy traversal configuration?

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

What is the webhook transmission protocol?

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

Is webhook configuration at the 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; webhook support is only for APIs and not for Web SDK.

Who creates encounter_id when an encounter has 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. An encounter can include multiple ambient sessions.

What are the prerequisites and 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 (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.
     

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.

Either:

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

What happens on long calls (longer than 30 minutes)?

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

Although there is no strict lower limit, Suki needs a minimum amount of data to generate recommendations. For calls shorter than 1 minute, Suki may not have enough meaningful data/information to provide accurate recommendations and returns empty content. The session will be marked as skipped.