Transcription

POST /api/v2/consultation/transcriptionReturns a transcription in string format. This endpoint accepts a public URL hosting an audio file. Utterances are prefixed with SPEAKER: S1 or SPEAKER: S2 within the transcription.HEADER PARAMETERS

REQUIREDX-Scrubs-Clinic-Codestring

Clinic code or identifier of the clinic making the API request.

REQUIREDX-Scrubs-Clinic-Providerstring

Provider ID associated with your EHR application.

REQUIREDX-Scrubs-<any-other-header>any

Other required headers depending on your organisation's provider ID.

BODY PARAMETERS

REQUIREDaudio_urlstring

A publicly accessible or pre-authed URL hosting an audio file. We support: MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4A, Ogg, Opus, and WebM encoded audio files.

Domain

BASE URL

1https://proxy.usescrubs.com

Sample Request

CURL

NodeJS

Python

CURL

1curl --location 'https://proxy.usescrubs.com/api/v2/consultation/transcription' \
2--header 'X-Scrubs-Clinic-Code: 00A123' \
3--header 'X-Scrubs-Clinic-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}