CastVoice Jobs
Create and manage CastVoice speech-to-text transcription jobs
List CastVoice job history
Returns a list of jobs for the authenticated user, ordered by creation date descending.
Use GET /castvoice/jobs/{job_id} to retrieve full details for a specific job.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List CastVoice job history › Responses
A list of jobs
Create a CastVoice job
Enqueues an asynchronous speech-to-text transcription job.
Upload your audio file via POST /files first, then submit the file_id here.
Returns 202 Accepted immediately with a job_id.
Poll GET /castvoice/jobs/{job_id} to check completion.
When completed, download the transcription via GET /files/{output_file_id}/content.
Supported input formats: WAV, MP3. The input format is automatically detected from the uploaded file.
Note: For multi-channel audio, only the first channel is transcribed. If speakers are recorded on separate channels, mix the audio down to mono before uploading.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Create a CastVoice job › Request Body
engineEngine ID obtained from GET /castvoice/engines
file_idFile ID of the input audio file to process, obtained from POST /files. Supported input formats: WAV, MP3. The input format is automatically detected from the uploaded file.
recognizerRecognizer code obtained from 'supported_recognizers' in GET /castvoice/engines. The format depends on the engine (e.g. 'ja-JP', or 'ja-JP|long' for engines that combine a language and a model).
output_formatOutput format. Use 'srt' for subtitles with timecodes, or 'text' for plain text.
split_by_sentenceIf true, each recognized segment is split at sentence boundaries where possible, with timecodes rebuilt from word-level timestamps. Segments where no sentence boundary is found are left as is. Engines that do not list 'split_by_sentence' in 'supported_options' ignore this parameter.
Create a CastVoice job › Responses
Job accepted
job_idfile_idInput file ID
enginestatusprogressoutput_file_idFile ID of the transcription output (SRT or plain text). Present only when status is completed. Download via GET /files/{output_file_id}/content.
Job-level error. Present only when job status is failed.
created_atupdated_atcompleted_atexpires_atGet CastVoice job status and results
Returns the current status of a CastVoice job.
Poll this endpoint until status is completed or failed.
Recommended polling interval: 15-30 seconds (transcription can take several minutes depending on the audio length).
When status is completed, use output_file_id to download the transcription
via GET /files/{output_file_id}/content.
Results are retained for a limited period after completion (expires_at).
If status is failed, check error.code: upstream_service_error and internal_server_error are usually temporary, so submit a new job later. Most other codes, such as invalid_parameter or unsupported_file, mean the input or settings must be fixed first.
path Parameters
job_idThe unique identifier of the job
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get CastVoice job status and results › Responses
Job details
job_idfile_idInput file ID
enginestatusprogressoutput_file_idFile ID of the transcription output (SRT or plain text). Present only when status is completed. Download via GET /files/{output_file_id}/content.
Job-level error. Present only when job status is failed.
created_atupdated_atcompleted_atexpires_at
