Endpoint
Authentication
All requests require a Bearer token in the Authorization header:Request
Supported File Formats
| Format | Extensions |
|---|---|
| WAV | .wav |
| MP3 | .mp3 |
| MP4 | .mp4 |
| M4A | .m4a |
| OGG | .ogg |
| WebM | .webm |
| FLAC | .flac |
use category options
- file_category_general
- file_category_telehealth
- file_category_procedure
- file_category_call_center
- file_category_legal
- file_category_meeting_notes
Headers
| Header | Value | Required |
|---|---|---|
Authorization | Bearer YOUR_API_KEY | Yes |
Content-Type | multipart/form-data | Yes |
Request Body form-data
| Field | Type | Description | Required | Options | Default |
|---|---|---|---|---|---|
audio_file_name | String | non-unique file name | yes | ||
audio_file_blob | String | url to a readable file | yes | ||
| Post processing options | |||||
use_diarization | String | get the transcript text as a diarized response | no | TRUE | FALSE | |
use_template_id | String | use a custom prompt id for the transcript post-processing | no | ||
use_category | String | set the category of post-processing to use on the file | no | file_category_telehealth |
Post processing options for the file categories
- General
- Telehealth
- Procedure
- Call center
- Legal
- Meeting notes
| Field | Type | Description | Required | Options | Default |
|---|---|---|---|---|---|
get_summary | String | get a summary of the transcript | no | TRUE | FALSE |
Basic request and response sample
Request and response with custom template id
Next Steps
After uploading a file, use the Get File Status endpoint to check the transcription progress and retrieve results.For real-time transcription, consider using the Widget Integration instead.
