RenderVoice Jobs
Create and manage RenderVoice text-to-speech synthesis jobs
List RenderVoice job history
Returns a list of jobs for the authenticated user, ordered by creation date descending.
Use GET /rendervoice/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 RenderVoice job history › Responses
A list of jobs
Create a RenderVoice job
Enqueues an asynchronous text-to-speech synthesis job.
Upload your text file via POST /files first, then submit the file_id here.
Choose a voice and a locale from 'supported_voices' in GET /rendervoice/engines: the locale must be one of the selected voice's 'locales'.
Returns 202 Accepted immediately with a job_id.
Poll GET /rendervoice/jobs/{job_id} to check completion.
When completed, download the synthesized audio (16-bit mono WAV) via GET /files/{output_file_id}/content.
Supported input format: plain text (UTF-8 recommended). The maximum length depends on the engine; see the engine's 'description'.
The request is rejected with 400 if the voice is not available on the engine, the voice does not speak the specified locale, or speaking_rate is set to a value other than 1.0 on an engine that does not list it in 'supported_options'. Some voices accept a narrower speaking_rate range, noted in the engine's 'description' (e.g. Google Chirp 3: HD voices accept 1.0 to 2.0); a job with a rate outside the voice's range is accepted but then fails with invalid_parameter.
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 RenderVoice job › Request Body
engineEngine ID obtained from GET /rendervoice/engines
file_idFile ID of the input text file to synthesize, obtained from POST /files. Supported input format: plain text (UTF-8 recommended). The maximum length depends on the engine; see the engine's 'description'.
localeLanguage of the input text. Must be one of the 'locales' of the selected voice in GET /rendervoice/engines.
voiceVoice code obtained from 'supported_voices' in GET /rendervoice/engines.
output_formatOutput audio format. Use 'wave' for WAV.
speaking_rateSpeaking rate as a multiplier of the voice's normal speed (e.g. 1.15 for 15% faster). Supported only by engines that list 'speaking_rate' in 'supported_options'; other engines accept only 1.0. Some voices accept a narrower range, noted in the engine's 'description' (e.g. Google Chirp 3: HD voices accept 1.0 to 2.0); a job with a rate outside the voice's range fails with 'invalid_parameter'.
Create a RenderVoice job › Responses
Job accepted
job_idfile_idInput file ID
enginestatusprogressoutput_file_idFile ID of the synthesized audio (WAV). 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 RenderVoice job status and results
Returns the current status of a RenderVoice job.
Poll this endpoint until status is completed or failed.
Recommended polling interval: 15-30 seconds (synthesis can take several minutes depending on the text length).
When status is completed, use output_file_id to download the synthesized audio (WAV)
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 RenderVoice job status and results › Responses
Job details
job_idfile_idInput file ID
enginestatusprogressoutput_file_idFile ID of the synthesized audio (WAV). 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
