Fetching audio

When text is submitted to be converted to speech, the request is queued to ensure a stable response even under heavy load. To get the resulting sound:

Fetching conversion result as JSON

This query can be useful if you want to have full control over the text-to-speech conversion results, such as checking for errors or monitoring the status of a conversion task.

Send a GET request to the https://api.aspose.cloud/v5.0/ocr/converttexttospeech Aspose.OCR Cloud REST API endpoint. To authorize the request, pass the access token in Authorization header (Bearer authentication).

Provide the unique identifier of the conversion task in id parameter:

curl --request GET --location 'https://api.aspose.cloud/v5.0/ocr/converttexttospeech?id=TTS01232-9d40-4f2d-8eda-f1fc0b12bce6' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...DpisWjfwe5RsfNCQ9Uh7Ig' \

The conversion result is returned in JSON format in the response body.

	"id": "TTS01232-9d40-4f2d-8eda-f1fc0b12bce6",
	"responseStatusCode": "Ok",
	"taskStatus": "Completed",
	"results": [
			"type": "WavFile",
			"data": "UklGRiSJAQBXQVZFZm10IBAAAA...9p6f808/9c/f+a/P/OAgA="
	"error": null
Property Type Description
id string Unique identifier of the conversion task. Equals to the value of the id request property.
taskStatus string Current state of the conversion task in the queue.
responseStatusCode string Conversion response status.
results array Audio file. The audio is returned as a Base64 encoded string. You must decode it in order to play it or save it to a file.
error/messages string[] Conversion error messages, if any. Even if the conversion succeed, you can still get notifications and warnings about non-fatal errors.

Evaluation mode

To get the generated voice from evaluation request, send a GET request to the endpoint https://api.aspose.cloud/v5.0/ocr/ConvertTextToSpeechTrial?id={request ID}.

This endpoint does not use the Authorization header, so there is no need to generate an access token.

Task statuses

Text-to-speech conversion may take up to several seconds depending on the Aspose.OCR cloud load. The status of the conversion task is indicated in the taskStatus property of the conversion result.

Status code Description To do
Pending The text is queued for conversion to speech, but not yet processed. Try fetching the result in a couple of seconds using the same ID.
Processing The text is currently being converted to speech. Fetch the result again using the same ID.
Completed Text to speech conversion is finished. Play or save the audio from results property.
Error An error occurred during conversion. Check messages in the error property for more information.
NotExist The request with the specified ID does not exist, or the result has already been deleted from the cloud storage. Check the ID or send the text for conversion again with the same parameters.