Submit a job

POST /batch-processor

This endpoint is used to submit jobs to the batch processor.

A job request includes three components: a preset (preset), an input configuration (inParams), an output configuration (outParams).

The preset defines the type of job to run. This is a required attribute and available presets are: transcript, soap-notes, summarize.

The inParams defines where the inputs for the job are coming from. An existing recordingId or a URL to a video/audio file are the two possible configurations.

The outParams defines how the outputs for the job are configured like the filename of the output.

Request Template (json)

Top-level configuration

Attribute NameTypeDescriptionDefaultExampleRequired?
presetstringThe type of job to runnull[transcript, soap-notes, summarize]Yes
inParamsobjectThe input configurationnull{...}Yes
outParamsobjectThe output configurationnull{...}Yes

Input configuration (inParams)

Attribute NameTypeDescriptionDefaultExampleRequired?
sourceTypestringThe type of the input media: [uri, recordingId]nullOne of [uri, recordingId]Yes
uristringThe actual URL when using "uri" as sourceTypenull"https://direct-url-to/file.mp4"When using uri as sourceType
recordingIdstringThe recording ID when using recordingId as sourceTypenull"uuiasdfe-8ba2-4ee6-bd15-003a92c18245"When using recordingId as sourceType
languagestringThe BCP-47 language-tag of spoken the audio for the transcriptionen"fr"No

Note: The language in inParams is only supported for the transcript preset.

The supported languages using the language parameter are:

LanguageBCP-47 tag
Danishda
Dutchnl
Englishen
English Australiaen-AU
English UKen-GB
English Indiaen-IN
English NewZealanden-NZ
English USAen-US
Frenchfr
French Canadafr-CA
German (DE)de
Hindihi
Hindi Romanhi-Latn
Indonedianid
Italianit
Japaneseja
Koreanko
Norwegianno
Polishpl
Portuguesept
Portuguese Brazilpt-BR
Portuguese Portugalpt-PT
Russianru
Spanishes
Spanish Latin Americaes-419
Swedishsv
Turkishtr
Ukrainianuk

Output configuration (outParams)

Attribute NameTypeDescriptionDefaultExampleRequired?
s3config.s3KeyTemplatestringThe filename of the outputnull"my-soap-note"Yes

Example requests

Example responses