Get Ambient Session Content

GET

api

ambient

session

{ambient_session_id}

content

cURL

curl --request GET \
  --url https://sdp.suki.ai/api/v1/ambient/session/<ambient_session_id>/content?cumulative=<cumulative> \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --header 'sdp_provider_id: <sdp_provider_id>'

{
  "structured_data": [
    {
      "title": "MEDICATIONS",
      "data": {
        "medication": "albuterol",
        "dosage": "2 puffs"
      }
    }
  ],
  "summary": [
    {
      "content": "Asthma exacerbation",
      "loinc_code": "18776-5",
      "title": "ASSESSMENT AND PLAN"
    }
  ]
}

Updated:You can now get the structured data blocks in the response of this API, including medication orders details.

Use this endpoint to get the summary and associated with the specified . This endpoint uses the cumulative query parameter to get the cumulative summary and structured data for the specified ambient session. If the query parameter is not provided, the default value is false. You have two options for the cumulative query parameter:

cumulative

boolean

Determines whether to retrieve cumulative or snapshot data.

Show Options

true

boolean

Cumulative summary and structured data up to the specified ambient session is retrieved.

false

boolean

Snapshot summary and structured data for the specified ambient session is retrieved.

Understanding the SKIPPED StatusIf you see a session with a SKIPPED status, it means that the was not generated because the conversation was empty.This status is an expected outcome if an ambient session is started but contains no audible speech (for example, a silent recording). It does not indicate a system error.Unlike a FAILED status, which indicates a processing error, SKIPPED is a successful outcome where no action was needed. Typically filter out or ignore sessions with this status in your application’s user interface.

Code examples

Python
TypeScript

import requests

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

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

# Get snapshot content (default, cumulative=false)
response = requests.get(url, headers=headers, params={"cumulative": False})

if response.status_code == 200:
    content = response.json()
    print("Structured data blocks:")
    for block in content.get("structured_data", []) or []:
        print(f"\nBlock title: {block.get('title')}")
        data = block.get("data") or {}
        for key, value in data.items():
            print(f"  {key}: {value}")

    print("\nGenerated note (summary):")
    for section in content.get("summary", []) or []:
        print(f"\nTitle: {section.get('title')}")
        print(f"LOINC Code: {section.get('loinc_code')}")
        print(f"Content: {section.get('content')}")
else:
    print(f"Failed to get content: {response.status_code}")
    print(response.json())

const ambientSessionId = '123dfg-456dfg-789dfg-012dfg';

// Get snapshot content (default, cumulative=false)
const response = await fetch(
  `https://sdp.suki-stage.com/api/v1/ambient/session/${ambientSessionId}/content?cumulative=false`,
  {
    headers: {
      'sdp_suki_token': '<sdp_suki_token>',
    'sdp_provider_id': '<sdp_provider_id>'
    }
  }
);

if (response.ok) {
    const content = await response.json();
    console.log('Structured data blocks:');
    (content.structured_data || []).forEach((block: any) => {
        console.log(`\nBlock title: ${block.title}`);
        const data = block.data || {};
        Object.entries(data).forEach(([key, value]) => {
            console.log(`  ${key}: ${value}`);
        });
    });

    console.log('\nGenerated note (summary):');
    content.summary?.forEach((section: any) => {
        console.log(`\nTitle: ${section.title}`);
        console.log(`LOINC Code: ${section.loinc_code}`);
        console.log(`Content: ${section.content}`);
    });
} else {
  const error = await response.json();
  console.error(`Failed to get content: ${response.status}`, error);
}

Headers

sdp_suki_token

string

required

sdp_suki_token

sdp_provider_id

string

Unique identifier for the provider. Optional for standard partners. Required for Single Auth Token authentication, where multiple providers share the same partner_token.

Example:

"provider-123"

Path Parameters

ambient_session_id

string

required

ambient_session_id

Query Parameters

cumulative

boolean

default:false

Optional. When true, return cumulative summary and structured data up to this session. When false (default), return snapshot data for this session only.

Response

Success Response

Response body for the /session/{ambient_session_id}/content endpoint

structured_data

object[]

Structured data extracted from the ambient session.

Show child attributes

summary

object[]

Summary of the ambient session.

Show child attributes

Last modified on June 12, 2026

Get Ambient Session Recording

Get Ambient Encounter Content

⌘I

cURL

curl --request GET \
  --url https://sdp.suki.ai/api/v1/ambient/session/<ambient_session_id>/content?cumulative=<cumulative> \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --header 'sdp_provider_id: <sdp_provider_id>'

{
  "structured_data": [
    {
      "title": "MEDICATIONS",
      "data": {
        "medication": "albuterol",
        "dosage": "2 puffs"
      }
    }
  ],
  "summary": [
    {
      "content": "Asthma exacerbation",
      "loinc_code": "18776-5",
      "title": "ASSESSMENT AND PLAN"
    }
  ]
}

​Code examples

Headers

Path Parameters

Query Parameters

Response

Code examples