Skip to main content
POST
/
openapi
/
v1
/
task
/
tts
/
create-async
Synthesize speech (async)
curl --request POST \
  --url https://api.vmeg.ai/openapi/v1/task/tts/create-async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "data": [
    {
      "text": "<string>",
      "voiceId": "<string>",
      "timbreRefAudio": "<string>",
      "emoWeight": 0.5,
      "emoRefAudio": "<string>",
      "emoPrompt": "<string>",
      "duration": 123
    }
  ],
  "provider": "<string>",
  "language": {
    "target": "en-US"
  },
  "trim": false,
  "outputFormat": "m4a",
  "extraData": {}
}
'
import requests

url = "https://api.vmeg.ai/openapi/v1/task/tts/create-async"

payload = {
"data": [
{
"text": "<string>",
"voiceId": "<string>",
"timbreRefAudio": "<string>",
"emoWeight": 0.5,
"emoRefAudio": "<string>",
"emoPrompt": "<string>",
"duration": 123
}
],
"provider": "<string>",
"language": { "target": "en-US" },
"trim": False,
"outputFormat": "m4a",
"extraData": {}
}
headers = {
"X-Idempotency-Key": "<x-idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'X-Idempotency-Key': '<x-idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: [
{
text: '<string>',
voiceId: '<string>',
timbreRefAudio: '<string>',
emoWeight: 0.5,
emoRefAudio: '<string>',
emoPrompt: '<string>',
duration: 123
}
],
provider: '<string>',
language: {target: 'en-US'},
trim: false,
outputFormat: 'm4a',
extraData: {}
})
};

fetch('https://api.vmeg.ai/openapi/v1/task/tts/create-async', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vmeg.ai/openapi/v1/task/tts/create-async",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
[
'text' => '<string>',
'voiceId' => '<string>',
'timbreRefAudio' => '<string>',
'emoWeight' => 0.5,
'emoRefAudio' => '<string>',
'emoPrompt' => '<string>',
'duration' => 123
]
],
'provider' => '<string>',
'language' => [
'target' => 'en-US'
],
'trim' => false,
'outputFormat' => 'm4a',
'extraData' => [

]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Idempotency-Key: <x-idempotency-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.vmeg.ai/openapi/v1/task/tts/create-async"

payload := strings.NewReader("{\n \"data\": [\n {\n \"text\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"timbreRefAudio\": \"<string>\",\n \"emoWeight\": 0.5,\n \"emoRefAudio\": \"<string>\",\n \"emoPrompt\": \"<string>\",\n \"duration\": 123\n }\n ],\n \"provider\": \"<string>\",\n \"language\": {\n \"target\": \"en-US\"\n },\n \"trim\": false,\n \"outputFormat\": \"m4a\",\n \"extraData\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.vmeg.ai/openapi/v1/task/tts/create-async")
.header("X-Idempotency-Key", "<x-idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": [\n {\n \"text\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"timbreRefAudio\": \"<string>\",\n \"emoWeight\": 0.5,\n \"emoRefAudio\": \"<string>\",\n \"emoPrompt\": \"<string>\",\n \"duration\": 123\n }\n ],\n \"provider\": \"<string>\",\n \"language\": {\n \"target\": \"en-US\"\n },\n \"trim\": false,\n \"outputFormat\": \"m4a\",\n \"extraData\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.vmeg.ai/openapi/v1/task/tts/create-async")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": [\n {\n \"text\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"timbreRefAudio\": \"<string>\",\n \"emoWeight\": 0.5,\n \"emoRefAudio\": \"<string>\",\n \"emoPrompt\": \"<string>\",\n \"duration\": 123\n }\n ],\n \"provider\": \"<string>\",\n \"language\": {\n \"target\": \"en-US\"\n },\n \"trim\": false,\n \"outputFormat\": \"m4a\",\n \"extraData\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "code": 200,
  "message": "",
  "data": {
    "taskId": "<string>",
    "createdAt": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Send your API Key in the Authorization header (Bearer <api_key>). See Authentication.

Headers

X-Idempotency-Key
string
required

Required on mutating POST requests that create tasks or change persisted data (max 64 characters). See Idempotency.

Maximum string length: 64

Body

application/json
data
object[]
required

Lines to synthesize (max 50). Each item needs text and a Voices voiceId or timbreRefAudio

Maximum array length: 50
provider
string
deprecated

Deprecated — do not send. Pass voiceId on each line instead. See Text to speech and Supported clone methods.

language
object

Target language for synthesis

trim
boolean
default:false

When true, trim leading and trailing silence from output audio

outputFormat
enum<string>
default:m4a

Output audio container: wav, mp3, or m4a

Available options:
wav,
mp3,
m4a
extraData
object

Optional client metadata on async submit; echoed in the completion webhook (extraData in callback body). Not used on sync create endpoints.

Callbacks

POST
https://{yourWebhookUrl}taskCompleted

Body

application/json

Webhook callback request body for Text to speech when event is openapi-tts. data includes synthesis results and taskId. See Webhook request body and Create TTS (async)Callbacks.

data
object
required

Product-specific results when event is openapi-tts. data includes synthesis results and taskId.

code
integer

Business outcome for this delivery

Example:

200

version
string

API version of the task (e.g. v1, v2). Matches the version in the request path (/openapi/v1/...).

Example:

"v1"

event
enum<string>

Which product completed. Route your handler by this value: openapi-tts (TTS), openapi-translate (text translation), openapi-clone-voice (voice clone), openapi-media-translation (media translation). Listed in Webhook request body.

Available options:
openapi-tts,
openapi-translate,
openapi-clone-voice,
openapi-media-translation
Example:

"openapi-tts"

pipelineKey
string

Stable ID for this async completion. Deduplicate webhook handling by this value — see Webhook request body.

Example:

"a1b2c3d4e5f6789012345678901234ab"

message
string

Detail when code is not success

extraData
object

Echo of extraData from your async submit request

Response

200

Return 2xx promptly to stop retries

Response

200 - application/json

Acceptance only (taskId, createdAt). Final results are in the Webhook callback request body.

code
integer
required

Business code; 200 means success

Example:

200

message
string

Human-readable detail when code is not success

Example:

""

data
object

Immediate response for async task submission (no task results)