Submit a job
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 Name | Type | Description | Default | Example | Required? |
|---|---|---|---|---|---|
preset | string | The type of job to run | null | [transcript, soap-notes, summarize] | Yes |
inParams | object | The input configuration | null | {...} | Yes |
outParams | object | The output configuration | null | {...} | Yes |
transformParams | object | The output configuration | null | {...} | No |
Input configuration (inParams)
| Attribute Name | Type | Description | Default | Example | Required? |
|---|---|---|---|---|---|
sourceType | string | The type of the input media: [uri, recordingId] | null | One of [uri, recordingId] | Yes |
uri | string | The actual URL when using "uri" as sourceType | null | "https://direct-url-to/file.mp4" | When using uri as sourceType |
transcriptUri | string | The actual URL when using "transcriptUri" as sourceType | null | "https://direct-url-to/file.mp4" | When using transcriptUri as sourceType |
recordingId | string | The recording ID when using recordingId as sourceType | null | "uuiasdfe-8ba2-4ee6-bd15-003a92c18245" | When using recordingId as sourceType |
language | string | The BCP-47 language-tag of spoken the audio for the transcription | en | "fr" | No |
Transform configuration (transformParams)
| Attribute Name | Type | Description | Default | Example | Required? |
|---|---|---|---|---|---|
transcript | object | The type of transform to run | null | {...} | Yes |
params | object | The modifier on the tranform object | null | {...} | Yes |
Language Support
Note: The language in inParams is only supported for the transcript preset.
The supported languages using the language parameter are:
| Language | BCP-47 tag |
|---|---|
| Danish | da |
| Dutch | nl |
| English | en |
| English Australia | en-AU |
| English UK | en-GB |
| English India | en-IN |
| English NewZealand | en-NZ |
| English USA | en-US |
| French | fr |
| French Canada | fr-CA |
| German (DE) | de |
| Hindi | hi |
| Hindi Roman | hi-Latn |
| Indonedian | id |
| Italian | it |
| Japanese | ja |
| Korean | ko |
| Norwegian | no |
| Polish | pl |
| Portuguese | pt |
| Portuguese Brazil | pt-BR |
| Portuguese Portugal | pt-PT |
| Russian | ru |
| Spanish | es |
| Spanish Latin America | es-419 |
| Swedish | sv |
| Turkish | tr |
| Ukrainian | uk |
Output configuration (outParams)
| Attribute Name | Type | Description | Default | Example | Required? |
|---|---|---|---|---|---|
s3config.s3KeyTemplate | string | The filename of the output | null | "my-soap-note" | Yes |