Retrieves the result of a specific Text-to-Speech run using the provided run_id
.
SUCCESS
status and you’ve received a run_id
, you can use this endpoint to access your generated audio and incorporate it into your application.
GET
request to this endpoint with the run_id
you received when your task completed. The system will respond by providing your audio in your preferred format.
output_type
parameter:
Output Type | Description | Best For |
---|---|---|
raw_bytes | Direct streaming of audio data (default option) | Immediate playback or saving to local storage |
file_url | JSON response with a URL to download the audio file | When you need to share or store the audio URL |
raw_bytes
output type, the endpoint streams the audio data directly to your application. This approach is ideal when you want to:
output_type=file_url
. The response will be a JSON object containing a URL where the audio file can be accessed. This approach is beneficial when:
The x-api-key
is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.
The unique identifier for the run, which was generated during the creation process and returned upon task completion.
The type of the Text-to-Speech output to return. Either streamable audio bytes or a URL to the generated file.
raw_bytes
, file_url
Successful Response
The generated audio file bytes in FLAC format, representing the speech created from the Text-to-Speech task.