New Consult Transcription Summarisation Referral Letter Evidence Auto Field Population Clinical Decision Support Clinical Code Suggestions Ambient Dictation

Transcription

POST /api/v1/transcriptionReturns a transcription in string format. This endpoint accepts a public URL hosting a single mp3-encoded file. If diarisation is enabled, utterances are prefixed with SPEAKER: S1 or SPEAKER: S2 within the transcription.HEADER PARAMETERS

REQUIREDX-Scrubs-HCI-Codestring

HCI code of the clinic making the API request.

REQUIREDX-Scrubs-HCI-Providerstring

Provider ID associated with your EHR application.

BODY PARAMETERS

REQUIREDaudio_urlstring

A publicly accessible URL hosting an mp3-encoded file.

OPTIONALdiarisationboolean

An optional parameter for in-text diarisation. Defaults to true if omitted.

Domain

BASE URL

1https://usescrubs.com

Sample Request

CURL

NodeJS

Python

CURL

1curl --location 'https://usescrubs.com/api/v1/transcription' \
2--header 'X-Scrubs-HCI-Code: 00A123' \
3--header 'X-Scrubs-HCI-Provider: SAMPLE_EHR_1' \
4--header 'Content-Type: application/json' \
5--data '{
6    "audio_url": "https://example.com/path/to/audio.mp3"
7}'

Sample Response

JSON

1{
2  "transcript": "SPEAKER: S1\nHi, doctor, I have been having a headache ...",
3}