;
};
}
sidebar={{
tutorialHref: "/documentation/tutorials/ambient-websocket-code-example",
apiHref: "/api-reference/ambient-content/note-content",
authSections: [
{
title: "Partner API",
text: "Authenticate every REST call with Partner Token headers on each request. See",
href: "/documentation/get-started/partner-authentication",
linkLabel: "Partner authentication",
scopes: ["sdp_suki_token", "sdp_provider_id"],
},
],
glance: [
{ label: "Product", value: "Ambient" },
{ label: "Surface", value: "Partner API" },
{ label: "Time", value: "~5 min" },
{ label: "Level", value: "Beginner" },
],
}}
>
## Problem
Partners often call note content APIs with `ambient_session_id` and get the wrong scope of data or empty results. Session content reflects one recording. The shared clinical note, including Web SDK edits, is keyed by `note_id`.
Pass `note_id` from the create response to [Get note content](/api-reference/ambient-content/note-content). Wait for generation to finish first using [Wait for Ambient before fetch](/documentation/cookbooks/wait-for-status-before-retrieve).
## Architecture
```mermaid actions={false} theme={"theme":{"light":"one-light","dark":"material-theme-darker"}}
%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#FFFBDE','primaryTextColor':'#1C1C1C','primaryBorderColor':'#FFD147','lineColor':'#6F5410','secondaryColor':'#FFFDF5','tertiaryColor':'#FFEB94','fontSize':'13px'}}}%%
flowchart LR
A[Create ambient session] --> B[Store note_id]
B --> C[Stream and end session]
C --> D[Poll until completed]
D --> E["GET /note/{note_id}/content"]
```
## Prerequisites
Completed [Partner onboarding](/documentation/get-started/partner-onboarding) and have `partner_id` with a valid Partner Token flow.A `note_id` from the create ambient session response, stored before streaming starts.Session status is `completed` (or you received a success webhook) before calling note content.
## Solution
Store `note_id` from create, then wait until status is `completed`.
Call `GET /ambient/note/{note_id}/content`.
Map `summary` into your EHR or UI. Re-fetch after Web SDK edits if needed.
Pass `note_id` from create to [Get note content](/api-reference/ambient-content/note-content). Wait for generation first ([Poll status](/documentation/cookbooks/wait-for-status-before-retrieve)).
```bash theme={"theme":{"light":"one-light","dark":"material-theme-darker"}}
# Set NOTE_ID from create, after status is completed.
curl --request GET \
--url "https://sdp.suki.ai/api/v1/ambient/note/${NOTE_ID}/content" \
--header "sdp_suki_token: ${SDP_SUKI_TOKEN}" \
--header "sdp_provider_id: ${SDP_PROVIDER_ID}"
```
```python theme={"theme":{"light":"one-light","dark":"material-theme-darker"}}
# get_note_content_by_note_id.py
# pip install requests
import json
import os
import requests
BASE_URL = os.environ.get("SUKI_BASE_URL", "https://sdp.suki.ai")
SDP_SUKI_TOKEN = os.environ["SDP_SUKI_TOKEN"]
SDP_PROVIDER_ID = os.environ["SDP_PROVIDER_ID"]
NOTE_ID = os.environ["NOTE_ID"] # from create ambient session response
def rest_headers() -> dict[str, str]:
return {
"sdp_suki_token": SDP_SUKI_TOKEN,
"sdp_provider_id": SDP_PROVIDER_ID,
}
def get_note_content(note_id: str):
url = f"{BASE_URL}/api/v1/ambient/note/{note_id}/content"
response = requests.get(url, headers=rest_headers(), timeout=30)
response.raise_for_status()
return response.json()
note = get_note_content(NOTE_ID)
# note["summary"] holds section content for the shared clinical note
print(json.dumps(note, indent=2))
```
```typescript theme={"theme":{"light":"one-light","dark":"material-theme-darker"}}
// get-note-content-by-note-id.ts
const BASE_URL = process.env.SUKI_BASE_URL ?? "https://sdp.suki.ai";
const SDP_SUKI_TOKEN = process.env.SDP_SUKI_TOKEN!;
const SDP_PROVIDER_ID = process.env.SDP_PROVIDER_ID!;
const NOTE_ID = process.env.NOTE_ID!; // from create ambient session response
function restHeaders(): Record {
return {
sdp_suki_token: SDP_SUKI_TOKEN,
sdp_provider_id: SDP_PROVIDER_ID,
};
}
async function getNoteContent(noteId: string): Promise {
const response = await fetch(
`${BASE_URL}/api/v1/ambient/note/${noteId}/content`,
{ headers: restHeaders() }
);
if (!response.ok) {
throw new Error(`Get note content failed: ${response.status}`);
}
return response.json();
}
const note = (await getNoteContent(NOTE_ID)) as {
summary?: unknown;
};
// note.summary holds section content for the shared clinical note
console.log(JSON.stringify(note, null, 2));
```
Save `note_id` from the create ambient session response. You need it for every note content call on that visit.
End the ambient session, then poll until status is `completed`. See [Wait for Ambient before fetch](/documentation/cookbooks/wait-for-status-before-retrieve).
Pass `note_id` as the path parameter: `GET /api/v1/ambient/note/{note_id}/content`. See [Get note content](/api-reference/ambient-content/note-content).
The response includes `summary` with section content for the shared clinical note. Re-fetch after Web SDK edits to get the latest version.
## Try it
* **note\_id returns the shared clinical note**
Using `note_id` returns the visit note, including edits from the Web SDK. Session-scoped APIs do not substitute for this endpoint.
* **Status must be completed first**
Calling note content before status reaches `completed` often returns empty or partial data. Poll status or wait for a success webhook.
* **summary holds section content**
The JSON response `summary` field contains the generated note sections. Map these to your EHR or display layer.
## Common mistakes
* Pass `ambient_session_id` as `note_id`.
* Call note content before status is `completed` (or before a success webhook).
* Discard `note_id` after create and try to derive the note ID from the session.
## Related cookbooks
} />
} />
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.