New Consult
POST /api/v2/consultation/uploadReturns a response containing the case note summary, transcript, and diagnosis . This endpoint is ideal for cases where granular calls to separate endpoints are not required, offering a more streamlined way to access the core functionalities of the Scrubs API.
Optional parameter patientData can be provided as a JSON string in the form data to incorporate additional structured patient data, such as past medical history, medications, or previous examination findings, into the generated SOAP note.
Customisation of the returned fields to suit your organisation's needs is available on request.HEADER PARAMETERS
Optional parameter patientData can be provided as a JSON string in the form data to incorporate additional structured patient data, such as past medical history, medications, or previous examination findings, into the generated SOAP note.
Customisation of the returned fields to suit your organisation's needs is available on request.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
BODY PARAMETERSOther required headers depending on your organisation's provider ID.
REQUIREDaudiofile
Audio data file. We support: MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4A, Ogg, Opus, and WebM encoded audio files.
OPTIONALpatientDataobject
An optional object containing structured patient data that will be incorporated into the output to provide additional context. This can include past medical history, medications, allergies, previous examination findings, or other relevant patient information.
Error Codes7 cases
Endpoint validation
| 400 | Audio input is missing or invalid. | The multipart body must include a valid audio file or audio_url. Invalid audio buffers and non-string audio_url values are rejected. |
| 400 | Organisation configuration is missing. | The authenticated provider has no consultation upload configuration. |
| 422 | Transcript is too short. | The generated or supplied transcript has fewer than 20 words. |
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
Sample Request
CURL
NodeJS
Python
Go
Sample Response