Sign in

v1

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

Get ambient session transcript

Returns completed transcripts for the ambient session after speech recognition finishes.

get/api/v1/ambient/session/{ambient_session_id}/transcript

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.

Example response

{
  "final_transcript": [
    {
      "end_offset": {
        "minutes": 6,
        "nanos": 80000000,
        "seconds": 42
      },
      "end_time": "2024-12-04T09:40:48.792948332Z",
      "lang_id": "en",
      "recording_id": "c9d59aa8-cd48-4f5a-be81-5d0c9d2a5885",
      "start_offset": {
        "minutes": 6,
        "nanos": 80000000,
        "seconds": 42
      },
      "start_time": "2024-12-04T09:40:42.393948332Z",
      "transcript": "The patient has shown an allergy to pollen",
      "transcript_id": "01JE8GP4RTHH0KDEGRSTRVPMGH"
    }
  ]
}