New sign-ups for the Free plan are temporarily paused. Paid plans remain available.
LDX hub API

RenderVoice Jobs

Create and manage RenderVoice text-to-speech synthesis jobs


List RenderVoice job history

GET
https://gw.ldxhub.io
/rendervoice/jobs

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.

List RenderVoice job history › Headers

Authorization
​string · required

The 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

POST
https://gw.ldxhub.io
/rendervoice/jobs

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.

Create a RenderVoice job › Headers

Authorization
​string · required

The 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

engine
​string · required

Engine ID obtained from GET /rendervoice/engines

file_id
​string · required

File 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'.

locale
​string · required

Language of the input text. Must be one of the 'locales' of the selected voice in GET /rendervoice/engines.

voice
​string · required

Voice code obtained from 'supported_voices' in GET /rendervoice/engines.

output_format
​string · enum · required

Output audio format. Use 'wave' for WAV.

Enum values:
wave
speaking_rate
​number · min: 0.5 · max: 2

Speaking 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'.

Default: 1

Create a RenderVoice job › Responses

Job accepted

Full job details. Returned by GET /rendervoice/jobs/{job_id}.
job_id
​string
file_id
​string

Input file ID

engine
​string
status
​string · enum
Enum values:
queued
processing
completed
failed
progress
​number · float
output_file_id
​string

File ID of the synthesized audio (WAV). Present only when status is completed. Download via GET /files/{output_file_id}/content.

​JobError

Job-level error. Present only when job status is failed.

created_at
​string · date-time
updated_at
​string · date-time
completed_at
​string · date-time
expires_at
​string · date-time
​Usage

Get RenderVoice job status and results

GET
https://gw.ldxhub.io
/rendervoice/jobs/{job_id}

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.

Get RenderVoice job status and results › path Parameters

job_id
​string · required

The unique identifier of the job

Get RenderVoice job status and results › Headers

Authorization
​string · required

The 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

Full job details. Returned by GET /rendervoice/jobs/{job_id}.
job_id
​string
file_id
​string

Input file ID

engine
​string
status
​string · enum
Enum values:
queued
processing
completed
failed
progress
​number · float
output_file_id
​string

File ID of the synthesized audio (WAV). Present only when status is completed. Download via GET /files/{output_file_id}/content.

​JobError

Job-level error. Present only when job status is failed.

created_at
​string · date-time
updated_at
​string · date-time
completed_at
​string · date-time
expires_at
​string · date-time
​Usage