Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartMedicalScribeListeningSession

Starts a new Medical Scribe listening session for real-time audio transcription

Request Syntax


POST /medical-scribe-stream/ HTTP/1.1
x-amzn-medscribe-session-id: sessionId
x-amzn-medscribe-domain-id: domainId
x-amzn-medscribe-subscription-id: subscriptionId
x-amzn-medscribe-language-code: languageCode
x-amzn-medscribe-sample-rate: mediaSampleRateHertz
x-amzn-medscribe-media-encoding: mediaEncoding
Content-type: application/json

{
   "audioEvent": { 
      "audioChunk": blob
   },
   "configurationEvent": { 
      "channelDefinitions": [ 
         { 
            "channelId": number,
            "participantRole": "string"
         }
      ],
      "encounterContext": { 
         "unstructuredContext": "string"
      },
      "postStreamActionSettings": { 
         "clinicalNoteGenerationSettings": { 
            "noteTemplateSettings": { ... }
         },
         "outputS3Uri": "string"
      }
   },
   "sessionControlEvent": { 
      "type": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

domainId

The Domain identifier

Length Constraints: Minimum length of 20. Maximum length of 25.

Pattern: (hai-|dom-)[a-z0-9]+

Required: Yes

languageCode

The Language Code for the audio in the session

Valid Values: en-US

Required: Yes

mediaEncoding

The encoding for the input audio

Valid Values: pcm | flac

Required: Yes

mediaSampleRateHertz

The sample rate of the input audio

Valid Range: Minimum value of 8000. Maximum value of 48000.

Required: Yes

sessionId

The Session identifier

Length Constraints: Fixed length of 36.

Pattern: .*[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}.*

Required: Yes

subscriptionId

The Subscription identifier

Length Constraints: Fixed length of 25.

Pattern: sub-[a-zA-Z0-9]{21}

Required: Yes

Request Body

The request accepts the following data in JSON format.

audioEvent

Type: MedicalScribeAudioEvent object

Required: No

configurationEvent

Type: MedicalScribeConfigurationEvent object

Required: No

sessionControlEvent

Type: MedicalScribeSessionControlEvent object

Required: No

Response Syntax


HTTP/1.1 200
x-amzn-medscribe-session-id: sessionId
x-amzn-medscribe-domain-id: domainId
x-amzn-medscribe-subscription-id: subscriptionId
x-amzn-request-id: requestId
x-amzn-medscribe-language-code: languageCode
x-amzn-medscribe-sample-rate: mediaSampleRateHertz
x-amzn-medscribe-media-encoding: mediaEncoding
Content-type: application/json

{
   "internalFailureException": { 
   },
   "transcriptEvent": { 
      "transcriptSegment": { 
         "audioBeginOffset": number,
         "audioEndOffset": number,
         "channelId": "string",
         "content": "string",
         "isPartial": boolean,
         "segmentId": "string"
      }
   },
   "validationException": { 
   }
}