Transcription

POST /api/v2/consultation/transcriptionReturns a transcription in string format. This endpoint accepts either an uploaded audio file or 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.

OPTIONALX-Scrubs-Clinic-Output-Languagestring

Language for the output response. Supported ISO 639-1 codes: en, fil, th, vi, id, ms, km, lo, my, tl, zh, ja, ko, ru, hi. Defaults to English if not specified.

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

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

BODY PARAMETERS

OPTIONALaudiofile

Audio data file. Provide exactly one of audio or audio_url. Supported formats: MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4A, Ogg, Opus, and WebM.

OPTIONALaudio_urlstring

A publicly accessible or pre-authed URL hosting an audio file. Provide exactly one of audio or audio_url.

Error Codes6 cases

Endpoint validation

400	audio/audio_url is missing or invalid.	The request must include exactly one audio file or a non-empty audio_url value pointing to an accessible audio file.
413	Uploaded audio file is too large.	The multipart audio upload exceeds the configured transcription file size limit.

Common HCI and authentication errors

400	Provider or HCI configuration is invalid.	Missing or unknown provider ID, no consultation method/auth flow configured for the provider, missing or malformed clinic code, invalid CA origin, or the provider clinic limit is reached.
401	Authentication failed.	API key credentials are missing or invalid, a root clinic/key cannot be found, or no API key is linked to the authenticated clinic.
429	Usage limit reached.	Free-tier usage is exhausted, or a non-root paid API key has expired.

Common runtime errors

500

Unexpected server or upstream failure.

Unhandled JSON/form parsing errors, AI provider failures, transcription provider failures, database errors, or unexpected response parsing failures.

Domain

BASE URL

1https://proxy.usescrubs.com

Sample Request

CURL

NodeJS

Python

CURL FILE

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--form 'audio=@"/path/to/audio.mp3"'

Sample Response

JSON

1{
2  "transcript": "SPEAKER: S1\nHi, doctor, I have been having a headache ...",
3  "detected_language": "en",
4  "duration_secs": 42.5,
5  "usage_limit": 9
6}