Sign in

v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB
/api/v1/ambient/session

End ambient session

Ends an ambient session and triggers clinical note generation. Call this after audio streaming completes. Short or empty recordings may return a skipped status.

post/api/v1/ambient/session/{ambient_session_id}/end

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.

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.