End Ambient Session

Complete ambient session and trigger clinical note generation

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

Ends ambient session.

cURL

curl --request POST \
  --url https://sdp.suki-stage.com/api/v1/ambient/session/{ambient_session_id}/end \
  --header 'sdp_suki_token: <sdp_suki_token>'

200

This response has no body data.

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

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

Code Examples

Python

import requests

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

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

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.ai/api/v1/ambient/session/${ambientSessionId}/end`,
  {
    method: 'POST',
    headers: {
      'sdp_suki_token': '<sdp_suki_token>'
    }
  }
);

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);
}

Headers

sdp_suki_token · string · required

sdp_suki_token

Path Parameters

ambient_session_id · string · required

ambient_session_id

Response

200