Perform text to synthesized speech

Use this method to submit text to be synthesized.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

User request completion callback

When submitting a request, an optional HTTP callback can be specified which will be invoked when the request completes or fails. The callback is an HTTP POST to the exact URL provided. Only one attempt is made to reach the URL provided. The contents of the HTTP request match the response from the Query text to speech request sttus and return results method.

Headers

  • x-requestid - Contains the request_id received when the request was submitted
  • x-status - One of the following indicating the status of the request:
StatusDescription
“Completed”The request has finished processing and the user callback, if provided has been called.
"Failed"An error occurred processing the request.
  • x-error - If the request failed, this would contain an error message.
  • x-userdata - This will contain the user data supplied with the original request.

Body

If the status is “Completed” the body of the request the binary WAV file. If the status is “Failed” the body of the request contains the same error message provided in the “x-error” header.

Submitting text in the BODY of the request

Users can submit larger text for processing by submitting the text as the body of the request.

curl -v "https://api.apptek.com/api/v2/texttospeech/en.p299" -H "x-token: XXXXXXX" -H "Content-Type: text/plain" --data-binary "@input.txt"

Submitting text in a multipart FORM file field

curl -v "https://api.apptek.com/api/v2/texttospeech/en.p299" -H "x-token: XXXXXXX" -F "[email protected]"

Details

Path Params
string
required

The name of the model to use to synthesize speech. E.g., "en-US.default-en_male_35". You can use the Query available text to speech models method to determine the available models

Query Params
int32
Defaults to 50

An integer priority level between 1 (low priority) and 100 (high priority) for this request. Additional charges may be applied to jobs with higher priority values. Default value is 50.

Body Params
string
required

The text to convert to speech.

Headers
string
required

API key

string

A user HTTP callback URL which will be invoked to notify the user when the request completes. See “User request completion callback” for further description.

string

Any text data the caller wants to associate with this request. This can be used to link this request with some other external tracking information.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json