跳转到主要内容
POST
/
openapi
/
v1
/
task
/
tts
/
create-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>"
  }
}

授权

Authorization
string
header
必填

Authorization 请求头中传入 API Key(Bearer <api_key>)。见 鉴权

请求头

X-Idempotency-Key
string
必填

创建任务或修改持久化数据的 POST 必填(最长 64 字符)。见 幂等

Maximum string length: 64

请求体

application/json
data
object[]
必填

待合成文本(最多 50 条)。每条需 text音色 中的 voiceIdtimbreRefAudio

Maximum array length: 50
provider
string
已弃用

已弃用 — 请勿传入。请在每行传入 voiceId。见 文本转语音支持的克隆方式

language
object

合成目标语言

trim
boolean
默认值:false

true 时裁剪输出音频首尾静音

outputFormat
enum<string>
默认值:m4a

输出音频格式:wavmp3m4a

可用选项:
wav,
mp3,
m4a
extraData
object

异步提交时的可选客户端元数据;任务完成时在 Webhook 回调体 extraData 中回显。同步创建接口不使用。

回调

POST
https://{yourWebhookUrl}taskCompleted

请求体

application/json

eventopenapi-tts 时的 TTS Webhook 请求体dataresultstaskId。见 Webhook 请求体创建 TTS(异步)Callbacks

data
object
必填

eventopenapi-tts 时的产品结果;dataresultstaskId

code
integer

本次投递的业务结果码

示例:

200

version
string

任务的 API 版本号(如 v1v2),与请求路径中的版本一致(如 /openapi/v1/...)。

示例:

"v1"

event
enum<string>

已完成的产品类型。请按此值路由:openapi-tts(TTS)、openapi-translate(文本翻译)、openapi-clone-voice(声音克隆)、openapi-media-translation(音视频翻译)。详见 Webhook 请求体

可用选项:
openapi-tts,
openapi-translate,
openapi-clone-voice,
openapi-media-translation
示例:

"openapi-tts"

pipelineKey
string

该次异步完成的稳定标识。请用此字段对接收端去重 — 见 Webhook 请求体

示例:

"a1b2c3d4e5f6789012345678901234ab"

message
string

code 非成功时的说明

extraData
object

与异步提交请求中的 extraData 一致

响应

200

请尽快返回 2xx 以停止重试

响应

200 - application/json

仅返回受理信息(taskIdcreatedAt)。最终生成结果在 Webhook 回调请求体中。

code
integer
必填

业务码;200 表示成功

示例:

200

message
string

code 非成功时的说明信息

示例:

""

data
object

异步提交后的立即响应(不含任务结果)