> ## Documentation Index
> Fetch the complete documentation index at: https://developer.suki.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Ambient Session Content
> Retrieve generated clinical content from completed ambient session
**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 structured data associated with the specified ambient session.
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:
Determines whether to retrieve cumulative or snapshot data.
Cumulative summary and structured data up to the specified ambient session is retrieved.
Snapshot summary and structured data for the specified ambient session is retrieved.
**Understanding the SKIPPED Status**
If you see a session with a `SKIPPED` status, it means that the clinical note was **not generated** because the conversation transcript 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 theme={"theme":{"light":"github-dark","dark":"material-theme-darker"}}
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_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())
```
```typescript theme={"theme":{"light":"github-dark","dark":"material-theme-darker"}}
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_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);
}
```
## OpenAPI
````yaml GET /api/v1/ambient/session/{ambient_session_id}/content
openapi: 3.0.1
info:
title: Suki Developer Platform
description: >-
REST and WebSocket APIs for the Suki Developer Platform. Authenticate with
Login or Register to obtain a Suki access token, then integrate ambient
clinical documentation, form filling, transcription, and reference metadata
endpoints.
contact: {}
version: '1.0'
servers:
- url: https://sdp.suki.ai
description: >-
Production base URL for Suki Developer Platform REST APIs. WebSocket
endpoints use the same host with `wss://`.
security:
- SukiTokenAuth: []
paths:
/api/v1/ambient/session/{ambient_session_id}/content:
get:
tags:
- /api/v1/ambient/session
summary: Get ambient session content
description: >-
Returns the generated clinical note and related content for a completed
or in-progress ambient session. Poll session status if content is not
ready yet.
parameters:
- name: ambient_session_id
in: path
description: >-
UUID for the ambient session. Use the `ambient_session_id` returned
from Create Ambient Session, or the UUID you supplied in that
request.
required: true
schema:
type: string
- name: cumulative
in: query
description: >-
Optional. When `true`, return cumulative summary and structured data
up to this session. When `false` (default), return snapshot data for
this session only.
schema:
type: boolean
default: false
- $ref: '#/components/parameters/ProviderIdHeader'
responses:
'200':
description: Request succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/controllers.SessionContentResponse'
example:
structured_data:
- title: MEDICATIONS
data:
medication: albuterol
dosage: 2 puffs
summary:
- content: Asthma exacerbation
loinc_code: 18776-5
title: ASSESSMENT AND PLAN
'400':
description: Bad request. The request body or parameters failed validation.
content:
application/json:
schema:
$ref: '#/components/schemas/controllers.BadRequestError'
'401':
description: Unauthorized. The Suki access token is missing, expired, or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/controllers.AuthenticationError'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/controllers.InternalServerError'
security:
- SukiTokenAuth: []
x-codeSamples:
- lang: bash
label: cURL
source: |-
curl --request GET \
--url https://sdp.suki.ai/api/v1/ambient/session//content?cumulative= \
--header 'sdp_suki_token: ' \
--header 'sdp_provider_id: '
components:
parameters:
ProviderIdHeader:
name: sdp_provider_id
in: header
description: >-
**Optional** - Stable identifier for the active provider. Omit for
standard partners whose `partner_token` identifies the user.
**Required** for Bearer partners and Single Auth Token authentication
where multiple providers share one `partner_token`. Use the same
`provider_id` you sent on Login or Register.
required: false
schema:
type: string
example: provider-123
schemas:
controllers.SessionContentResponse:
type: object
properties:
structured_data:
type: array
description: Structured data extracted from the ambient session.
items:
$ref: '#/components/schemas/controllers.StructuredDataBlock'
summary:
type: array
description: Summary of the ambient session.
items:
$ref: '#/components/schemas/controllers.ContentBlock'
description: Response body for the /session/{ambient_session_id}/content endpoint
controllers.BadRequestError:
type: object
properties:
code:
type: integer
example: 400
description: HTTP status code for the error.
message:
type: string
example: invalid request
description: Human-readable description of the validation or request error.
description: Error response when the request fails validation.
controllers.AuthenticationError:
type: object
properties:
code:
type: integer
example: 401
description: HTTP status code for the error.
message:
type: string
example: invalid token
description: Human-readable description of the authentication failure.
description: Error response when authentication fails.
controllers.InternalServerError:
type: object
properties:
code:
type: integer
example: 500
description: HTTP status code for the error.
message:
type: string
example: internal server error
description: Human-readable description of the server error.
description: Error response when the server encounters an unexpected error.
controllers.StructuredDataBlock:
type: object
properties:
data:
type: object
additionalProperties:
type: string
description: >-
The structured data in the block. This is a key-value pair where the
key is the name of the data and the value is the data itself.
For example, for medications, the key can be the name of the
medication and the value can be the dosage.
This is kept as map since we don't know the structure of the data
that will be extracted.
example:
dosage: 2 puffs
medication: albuterol
title:
type: string
description: >-
The title of the structured data block. Usually refers to names like
Medications, Allergies, etc.
example: MEDICATIONS
controllers.ContentBlock:
type: object
properties:
content:
type: string
description: >-
The body of the content block usually refers to the content of the
section.
example: Asthma exacerbation
loinc_code:
type: string
description: The LOINC code of the content block.
example: 18776-5
title:
type: string
description: The title of the content block usually refers to section name.
example: ASSESSMENT AND PLAN
securitySchemes:
SukiTokenAuth:
type: apiKey
in: header
name: sdp_suki_token
description: >-
Suki access token for the authenticated provider. Obtain this by calling
Login or Register with a valid `partner_token`. Pass the `suki_token`
value from the JSON response as the `sdp_suki_token` header on REST
requests and non-browser WebSocket upgrades. Browser WebSocket clients
pass the token in `Sec-WebSocket-Protocol` instead. Tokens expire after
one hour; call Login again to refresh.
````