v44

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-192301780.0 KB

Voice

Create transcription job

Creates an asynchronous transcription job for audio files. Supports two modes:

Vault-based (recommended): Pass vault_id and object_id to transcribe audio from your vault. The transcript will automatically be saved back to the vault when complete.

Direct URL (legacy): Pass audio_url for direct transcription without automatic storage.

post/voice/transcription

Request body

vault_idstring

Vault ID containing the audio file (use with object_id)

object_idstring

Object ID of the audio file in the vault (use with vault_id)

format'json' | 'text'

Output format for the transcript when using vault mode

audio_urlstring

URL of the audio file to transcribe (legacy mode, no auto-storage)

language_codestring

Language code (e.g., 'en_us', 'es', 'fr'). If not specified, language will be auto-detected

speaker_labelsboolean

Enable speaker identification and labeling

speakers_expectedinteger

Expected number of speakers (improves accuracy when known)

auto_highlightsboolean

Automatically extract key phrases and topics

content_safetyboolean

Enable content moderation and safety labeling

language_detectionboolean

Enable automatic language detection

speech_modelsstring[]

Priority-ordered speech models to use

punctuateboolean

Add punctuation to the transcript

format_textboolean

Format text with proper capitalization

word_booststring[]

Custom vocabulary words to boost (e.g., legal terms)

boost_param'low' | 'default' | 'high'

How much to boost custom vocabulary

Response

Transcription job created successfully

idstring

Unique transcription job ID

status'queued' | 'processing' | 'completed' | 'error'

Current status of the transcription job

vault_idstring

Vault ID (only for vault-based transcription)

source_object_idstring

Source audio object ID (only for vault-based transcription)