Get Note Content

Retrieve accumulated Ambient note section content, including the latest edits

GET /api/v1/ambient/note/{note_id}/content

Gets the content for a note.

cURL

curl --request GET \
  --url https://sdp.suki.ai/api/v1/ambient/note/{note_id}/content \
  --header 'sdp_suki_token: <api-key>'

200

{
  "summary": [
    {
      "content": "Asthma exacerbation",
      "loinc_code": "18776-5",
      "source_transcripts": [
        "asthma",
        "exacerbation"
      ],
      "title": "ASSESSMENT AND PLAN"
    }
  ]
}

Use this endpoint to get accumulated section content across ambient sessions in a note.

If clinicians edit sections in a headed product such as the Web SDK, the response returns the latest edited section content. Use composition_id from Create ambient session as note_id.

• Call this endpoint from your app when you need the full clinical note by note_id, including section edits clinicians made in a headed product such as the Web SDK, and content from every ambient session on that note.

• Use Session content APIS only when you need content for one ambient session. For when to use session, note, or encounter APIs in your product, refer to Work with shared notes.

Code examples

Python

import json
import requests

BASE_URL = "https://sdp.suki.ai"

# Use composition_id from Create Ambient Session as note_id
note_id = "<composition_id>"

# Get sdp_suki_token from Login: POST /api/v1/auth/login
sdp_suki_token = "<sdp_suki_token>"

# Required for single_auth partners
sdp_provider_id = "<sdp_provider_id>"

url = f"{BASE_URL}/api/v1/ambient/note/{note_id}/content"

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

response = requests.get(url, headers=headers, timeout=60)

print("HTTP status:", response.status_code)

try:
    response_body = response.json()
except ValueError:
    print("Response was not JSON:")
    print(response.text)
    raise SystemExit(1)

print("Response body:")
print(json.dumps(response_body, indent=2))

if response.status_code == 200:
    summary = response_body.get("summary") or []
    print(f"Sections found: {len(summary)}")

    for section in summary:
        print("title:", section.get("title"))
        print("loinc_code:", section.get("loinc_code"))
        print("content:", section.get("content"))
        print("source_transcripts:", section.get("source_transcripts"))
else:
    print("Get Note Content failed.")
    if isinstance(response_body, dict):
        print("code:", response_body.get("code"))
        print("message:", response_body.get("message"))

TypeScript

const BASE_URL = "https://sdp.suki.ai";

// Use composition_id from Create Ambient Session as note_id
const noteId = "<composition_id>";

// Get sdp_suki_token from Login: POST /api/v1/auth/login
const sdpSukiToken = "<sdp_suki_token>";

// Required for single_auth partners
const sdpProviderId = "<sdp_provider_id>";

type ContentBlock = {
  title?: string;
  loinc_code?: string;
  content?: string;
  source_transcripts?: string[];
};

type GetNoteContentResponse = {
  summary?: ContentBlock[];
};

type ApiErrorResponse = {
  code?: number;
  message?: string;
};

const response = await fetch(
  `${BASE_URL}/api/v1/ambient/note/${noteId}/content`,
  {
    method: "GET",
    headers: {
      sdp_suki_token: sdpSukiToken,
      sdp_provider_id: sdpProviderId,
    },
  }
);

const responseText = await response.text();
let responseBody: GetNoteContentResponse | ApiErrorResponse | unknown;

try {
  responseBody = responseText ? JSON.parse(responseText) : {};
} catch {
  console.error("Response was not JSON:");
  console.error(responseText);
  throw new Error("Get Note Content returned non-JSON response");
}

console.log("HTTP status:", response.status);
console.log("Response body:", JSON.stringify(responseBody, null, 2));

if (response.status === 200) {
  const payload = responseBody as GetNoteContentResponse;
  const summary = payload.summary || [];
  console.log(`Sections found: ${summary.length}`);

  for (const section of summary) {
    console.log("title:", section.title);
    console.log("loinc_code:", section.loinc_code);
    console.log("content:", section.content);
    console.log("source_transcripts:", section.source_transcripts);
  }
} else {
  const error = responseBody as ApiErrorResponse;
  console.error("Get Note Content failed.");
  console.error("code:", error.code);
  console.error("message:", error.message);
}

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

note_id · string · required

Note identifier. Use the composition_id returned from Ambient session create (same value as note ID for note-level APIs).

Response

200

application/json

Success Response

Accumulated note content across sessions in the note. For sections that were edited (for example in Web SDK), returns the latest edited section content.

summary · object[]

Summary of the note (section content blocks rendered from the composition).

Show child attributes