🔐 Bundle plugin only: This is exclusive to the Video, Audio & Live Bundle. Get the bundle plugin here.

Fields

preset
dropdown

The type of job to run. Options: transcript, soap-notes, summarize. Default: transcript

source type
dropdown

The type of the input media. Options: uri, recordingId. Default: recordingId

uri
text

The actual URL when using “uri” as sourceType. Required if source type is uri.

recording id
text

The recording ID when using recordingId as sourceType. Required if source type is recordingId.

language
text

The BCP-47 language tag of the spoken audio for transcription. Default: en

s3 key template
text

The filename of the output (e.g., “my-soap-note”). Default: my-daily-job

use replacement
boolean

Whether to use template replacement in s3KeyTemplate. Default: true

⚠️ Important Notes:

  • If using uri as the source type, you must fill out the URI field
  • If using recordingId as the source type, you must fill out the Recording ID field
  • Missing required fields will result in an error

Return Values

id
text

Unique identifier for the submitted job.

error
boolean

Indicates if an error occurred during the request.

error message
text

Description of any error that occurred.

error status
number

Numeric error status code.