v1
latestOpenAPI 3.0.12026-07-2649123153.6 KB/api/v1/ambient/session
Get ambient session content
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.
get/api/v1/ambient/session/{ambient_session_id}/content
Path parameters
ambient_session_idstring required
UUID for the ambient session. Use the ambient_session_id returned from Create Ambient Session, or the UUID you supplied in that request.
Query parameters
cumulativeboolean
Optional. When true, return cumulative summary and structured data up to this session. When false (default), return snapshot data for this session only.
Headers
sdp_provider_idstring
Example:provider-123
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.
Response
Request succeeded.
Example response
{
"structured_data": [
{
"data": {
"dosage": "2 puffs",
"medication": "albuterol"
},
"title": "MEDICATIONS"
}
],
"summary": [
{
"content": "Asthma exacerbation",
"loinc_code": "18776-5",
"source_transcripts": [
"asthma",
"exacerbation"
],
"title": "ASSESSMENT AND PLAN"
}
]
}