End Ambient Session

Complete Ambient session and trigger clinical note generation

POST /api/v1/ambient/session/{ambient_session_id}/end

cURL

cURL

curl --request POST \
  --url https://sdp.suki.ai/api/v1/ambient/session/<ambient_session_id>/end \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --header 'sdp_provider_id: <sdp_provider_id>'

200

This response has no body data.

Use this endpoint to end an ambient session and trigger the clinical note generation process.

Ending an ambient session closes that recording so Suki can process it. It does not close the patient encounter. Create another ambient session for the same encounter when the visit needs more capture.

If you get a skipped status, it means that the note was not generated because the conversation transcript was empty or the session was too short.

• When building the Stop Ambient flow, send RU9G, end the session, and then poll for the final status. For guidance on what your UI should show at each step, see End an ambient session.

• For a request-level example of ending an Ambient session after streaming, refer to End Ambient after streaming guide.

Code examples

Python

import requests

ambient_session_id = "123dfg-456dfg-789dfg-012dfg"
url = f"https://sdp.suki-stage.com/api/v1/ambient/session/{ambient_session_id}/end"

headers = {
    "sdp_suki_token": "<sdp_suki_token>",
    "sdp_provider_id": "<sdp_provider_id>"
}

response = requests.post(url, headers=headers)

if response.status_code == 200:
    print("Session ended successfully. Clinical note generation triggered.")
else:
    print(f"Failed to end session: {response.status_code}")
    print(response.json())

TypeScript

const ambientSessionId = '123dfg-456dfg-789dfg-012dfg';
const response = await fetch(
  `https://sdp.suki-stage.com/api/v1/ambient/session/${ambientSessionId}/end`,
  {
    method: 'POST',
    headers: {
      'sdp_suki_token': '<sdp_suki_token>',
    'sdp_provider_id': '<sdp_provider_id>'
    }
  }
);

if (response.ok) {
  console.log('Session ended successfully. Clinical note generation triggered.');
} else {
  const error = await response.json();
  console.error(`Failed to end session: ${response.status}`, error);
}

Authorizations

sdp_suki_token · string · header · required

Suki access token (suki_token) from Login or Register. Expires after one hour.

Headers

sdp_provider_id · string

Optional for standard partners.

Required for:

• Bearer authentication. Use the same provider_id returned by the Login or Register API.
• Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Example:

"provider-123"

Path Parameters

ambient_session_id · string · required

UUID for the ambient session. Use the ambient_session_id returned from Create Ambient Session, or the UUID you supplied in that request.

Response

200

Request succeeded.