Suki Ambient APIs

The Suki Ambient APIs generate clinical notes from real-time conversations between providers and patients. Most operations use standard REST endpoints and return HTTP status codes. For streaming audio, the APIs use WebSocket endpoints for real-time transmission and event notifications.

What You Can Do

With the Suki Ambient API, you can:

• Send provider and encounter data to initiate a session.

• Retrieve the AI-generated clinical note at the end of the conversation.

• Access the complete conversation transcript for review or storage.

By integrating these capabilities, you can automate and enhance clinical documentation workflows in your healthcare application.

API Versions

The Suki Platform APIs use version v1, which is the stable version. All endpoints use the /api/v1/ prefix in the URL.

v1: The stable API version. Features in v1 are fully supported for the lifetime of the major version. If breaking changes are introduced, a new major version will be created and the existing version will be deprecated after a reasonable period. Non-breaking changes may be added without changing the major version.

Early Access: Some features are available in Early Access. These features are under development and may change. Early Access features use the v1 API version but may receive updates based on feedback.

All features in this documentation are available in v1. For versioning policies, backward compatibility, and migration strategies, see the API Reference Guidelines.

Postman Collection

Download the Postman collection below to test the Suki Ambient APIs.

Postman is an API client that displays requests and responses in structured formats. You can explore and integrate the Suki Ambient API through Postman.

Before You Begin: Access and Credentials

You need partner credentials to use the Suki Ambient API.

Contact our partnership team to get your credentials. They will guide you through the onboarding process and provide what you need to get started.

Prerequisites

You must have an OAuth-compliant authentication system, JWT tokens with consistent user identifiers, and a publicly accessible JWKS endpoint (or Okta authorization server) for token validation. See Partner Onboarding and Partner Authentication for details.

Environments

Use https://sdp.suki.ai for production. For testing, use https://sdp.suki-stage.com (staging). Your partnership team will confirm which environment and credentials to use.

Ambient APIs Workflow

To integrate with the Suki Ambient APIs, you follow a session-based workflow.

Getting Started With Suki Ambient APIs

curl -X POST https://sdp.suki.ai/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "partner_id": "your-partner-id",
    "partner_token": "your-jwt-token",
    "provider_id": "provider-123"
  }'

curl -X POST https://sdp.suki.ai/api/v1/ambient/session/create \
  -H "sdp_suki_token: YOUR_SUKI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ambient_session_id": "123dfg-456dfg-789dfg-012dfg",
    "encounter_id": "123dfg-456dfg-789dfg-012dfg"
  }'

curl -X POST "https://sdp.suki.ai/api/v1/ambient/session/YOUR_SESSION_ID/end" \
  -H "sdp_suki_token: YOUR_SUKI_TOKEN"

# Get clinical note
curl -X GET "https://sdp.suki.ai/api/v1/ambient/session/YOUR_SESSION_ID/content?cumulative=false" \
  -H "sdp_suki_token: YOUR_SUKI_TOKEN"

# Get transcript
curl -X GET "https://sdp.suki.ai/api/v1/ambient/session/YOUR_SESSION_ID/transcript" \
  -H "sdp_suki_token: YOUR_SUKI_TOKEN"