语音合成

描述

本接口用于发起语音合成任务。任务投递成功后开始异步执行;用户可通过查询接口主动查询算法执行结果,也可通过请求时配置的回调地址获取算法结果。

版本

1.0

图片要求

语音合成算法本身不需要输入图片或其他多媒体文件。统一网关的 init_images 字段需提供媒体元素,示例使用原文图片格式栏列出的 JPG;该媒体不作为语音合成的算法参数。

调用 URL

    正式环境:https://openapi.meitu.com
    任务提交接口:https://openapi.meitu.com/api/v1/sdk/sync/push
    任务名称(task):/v1/tts_synthesis/481979
    任务类型(task_type):formula

调用方法

POST

Content-Type: application/json

权限

开放平台接口签名

请求参数

是否必选参数名类型参数说明
必选paramsstring算法参数(JSON 字符串)
必选init_imagesobject[]多媒体文件列表;统一网关要求提供媒体元素,算法本身不使用该媒体
必选taskstring固定 /v1/tts_synthesis/481979
必选task_typestring固定 formula
可选sync_timeoutint默认 30;-1 表示不等待。同步超时后 status 返回 9,需使用查询接口查询

init_images 多媒体文件参数,结构说明如下。语音合成算法本身不需要多媒体输入,但统一网关要求提供媒体元素。

是否必选参数名类型参数说明
必选urlstring多媒体 URL 或 base64;示例使用 JPG URL
必选profileobject属性信息描述

profile 属性信息描述

是否必选参数名类型参数说明
必选media_profilesobject媒体属性信息
必选versionstring固定 v1

media_profiles 媒体属性信息

是否必选参数名类型参数说明
必选media_data_typestringurl 表示 URL;jpg 等类型表示 base64

params 推理参数是 JSON 字符串,其结构说明如下

是否必选字段类型说明
可选rsp_media_typestring默认 urljpg 表示 base64
必选parameterobject算法核心参数对象

parameter 算法参数详情

是否必选字段类型说明
必选timbre_idInteger音色 ID
必选textString合成语音的源文本
可选speedString语速,支持 0.5~2.0,传入一位小数;仅支持 SSML 标签的音色支持此功能
可选styleString情感风格;仅支持 SSML 标签的音色支持此功能
可选emotion_scaleInteger情感情绪值,必须为整数,支持 1~5

输入值示例

{
  "task": "/v1/tts_synthesis/481979",
  "task_type": "formula",
  "init_images": [
    {
      "url": "https://example.com/input.jpg",
      "profile": {
        "media_profiles": {
          "media_data_type": "url"
        },
        "version": "v1"
      }
    }
  ],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"timbre_id\":17,\"text\":\"测试接口连通性\"}}",
  "sync_timeout": 30
}

返回值说明

注意,生成的结果,会定期清理,请及时下载保存
字段类型说明
request_idstring请求标识
trace_idstring链路追踪标识
codeint业务状态码,0 表示请求受理成功
error_codeint错误码,成功时为 0
messagestring业务信息
tipsany补充提示,可为 null
dataobject任务状态和算法结果

data 中单个元素的字段说明

字段类型说明
statusint状态码:-1 未找到任务;0 创建成功;1 执行中;2 失败;9 超时,使用查询接口查询;10 成功
resultobject算法结果
progressnumber任务进度
predict_elapsedint预计耗时,毫秒
create_timeint64创建时间戳,毫秒
task_idstring任务 ID
custom_task_idstring客户自定义任务 ID
trace_idstringdata 内链路标识
client_infostring客户端信息
init_imagesobject[]/null输入媒体回显

result 中单个元素的字段说明

字段类型说明
idstring算法任务 ID
urlsstring[]合成语音 URL 列表
parametersobject算法返回的参数信息
dataobject算法返回的数据对象
msgstring算法处理信息
msg_idstring算法消息 ID
imagesstring[]算法返回的媒体 URL 列表;本接口示例中为合成语音 URL
media_info_listobject[]算法返回的媒体信息列表
codeint算法错误码,失败时返回

parameters 字段说明

字段类型说明
bypass_cacheint返回的 bypass_cache 参数
channelstring返回的 channel 参数
client_idint返回的 client_id 参数
emotion_scaleint返回的 emotion_scale 参数
ext_voice_idstring返回的 ext_voice_id 参数
idint返回的 id 参数
is_emoint返回的 is_emo 参数
is_support_ssmlint返回的 is_support_ssml 参数
is_syncint返回的 is_sync 参数
repost_urlstring返回的 repost_url 参数
speedstring返回的 speed 参数
stat_gidint返回的 stat_gid 参数
stylestring返回的 style 参数
textstring合成语音的源文本
timbre_idint音色 ID
uidint返回的 uid 参数
versionstring返回的 version 参数
volumeint返回的 volume 参数
with_timestampint返回的 with_timestamp 参数

media_info_list 中单个元素的字段说明

字段类型说明
media_datastring合成语音 URL
media_extraobject媒体扩展信息
media_profilesobject媒体属性信息,示例中的 media_data_typeurl

算法特有错误代码与信息

错误码错误信息说明
20001PROCESS_ERROR处理错误

返回值示例

请求成功返回示例

{
  "request_id": "",
  "trace_id": "",
  "code": 0,
  "error_code": 0,
  "message": "success",
  "tips": null,
  "data": {
    "status": 10,
    "result": {
      "id": "t_mt1a3i5n7ba95988c3-7e15-427e-b7e3-ad599217c282",
      "urls": [
        "http://voice.meitudata.com/audio/1759221923c5584b63582de6cb639aa97392454f4b100.mp3"
      ],
      "parameters": {
        "bypass_cache": 0,
        "channel": "",
        "client_id": 0,
        "emotion_scale": 0,
        "ext_voice_id": "",
        "id": 0,
        "is_emo": 0,
        "is_support_ssml": 0,
        "is_sync": 0,
        "repost_url": "https://koios-gateway-api.meitu.com/api/v1/task/notify?task_id=t_mt1a3i5n7ba95988c3-7e15-427e-b7e3-ad599217c282\u0026trace_id=a71d1ea3-874c-47b8-8f9c-da5a972af8c1",
        "speed": "",
        "stat_gid": 0,
        "style": "",
        "text": "测试接口连通性",
        "timbre_id": 17,
        "uid": 0,
        "version": "",
        "volume": 0,
        "with_timestamp": 0
      },
      "data": {},
      "msg": "success",
      "msg_id": "voice-cf80bdff-c0bc-4579-aac9-15bad1b97bb8",
      "images": [
        "http://voice.meitudata.com/audio/1759221923c5584b63582de6cb639aa97392454f4b100.mp3"
      ],
      "media_info_list": [
        {
          "media_data": "http://voice.meitudata.com/audio/1759221923c5584b63582de6cb639aa97392454f4b100.mp3",
          "media_extra": {},
          "media_profiles": {
            "media_data_type": "url"
          }
        }
      ]
    },
    "progress": 1,
    "predict_elapsed": 10000,
    "create_time": 1759222172863,
    "task_id": "t_mt1a3i5n7ba95988c3-7e15-427e-b7e3-ad599217c282",
    "custom_task_id": "",
    "trace_id": "a71d1ea3-874c-47b8-8f9c-da5a972af8c1",
    "client_info": "",
    "init_images": null
  }
}

需要查询返回示例

使用 查询接口 接口查询

Response Status:200

content-type 为 application/json; charset=utf-8

{
  "request_id": "",
  "trace_id": "",
  "code": 0,
  "error_code": 0,
  "message": "success",
  "tips": null,
  "data": {
    "status": 9,
    "result": {
      "id": "t_mt1a3i5n7b3da6d589-46b5-4f66-a0bb-8dd22f2a172e"
    },
    "progress": 0,
    "predict_elapsed": 10000,
    "create_time": 1759202368761,
    "task_id": "t_mt1a3i5n7b3da6d589-46b5-4f66-a0bb-8dd22f2a172e",
    "custom_task_id": "",
    "trace_id": "9129a3a2-99c4-46ce-8731-0e100e2fbee7",
    "client_info": "",
    "init_images": null
  }
}

请求失败返回示例

Response Status:400

content-type 为 application/json; charset=utf-8

{
  "request_id": "",
  "trace_id": "",
  "code": 20001,
  "error_code": 20001,
  "message": "ALGO_MODEL_CRASH",
  "tips": null,
  "data": {
    "status": 2,
    "result": {
      "id": "t_mt1a3i5n7be8d575cc-2ffb-4e0c-85a8-1824110e31b8",
      "code": 20001,
      "data": {
        "duration": {
          "alg_process_time": 0,
          "created_timestamp": 1759201989,
          "pull_timestamp": 1759201989,
          "repost_time": 0,
          "upload_time": 0,
          "waiting_time": 0
        },
        "error_code": 20001,
        "error_msg": "ALGO_MODEL_CRASH",
        "extra": {},
        "media_info_list": [],
        "msg_id": "c1b09cb2-6e05-4d21-55ab-r007b1f21bec",
        "parameter": null
      },
      "msg": "ALGO_MODEL_CRASH",
      "msg_id": "c1b09cb2-6e05-4d21-55ab-r007b1f21bec"
    },
    "progress": 1,
    "predict_elapsed": 10000,
    "create_time": 1759201989444,
    "task_id": "t_mt1a3i5n7be8d575cc-2ffb-4e0c-85a8-1824110e31b8",
    "custom_task_id": "",
    "trace_id": "",
    "client_info": "",
    "init_images": null
  }
}

通用的错误代码与信息

详见 API 错误码

SDK 调用示例

Python

import json

import requests
from sign_sdk import sign

def api_call_example():
    key = "your_api_key"
    secret = "your_api_secret"
    url = "https://openapi.meitu.com/api/v1/sdk/sync/push"
    method = "POST"

    headers = {
        "Content-Type": "application/json",
        sign.HeaderHost: "openapi.meitu.com",
    }
    inner_params = {
        "rsp_media_type": "url",
        "parameter": {
            "timbre_id": 17,
            "text": "测试接口连通性",
        },
    }
    payload = {
        "task": "/v1/tts_synthesis/481979",
        "task_type": "formula",
        "init_images": [
            {
                "url": "https://example.com/input.jpg",
                "profile": {
                    "media_profiles": {"media_data_type": "url"},
                    "version": "v1",
                },
            }
        ],
        "params": json.dumps(inner_params, ensure_ascii=False),
        "sync_timeout": 30,
    }
    body = json.dumps(payload, ensure_ascii=False)

    signer = sign.Signer(key, secret)
    signed_request = signer.sign(url, method, headers, body)
    response = requests.Session().send(signed_request)
    print(f"Status: {response.status_code}")
    print(f"Response: {response.text}")

if __name__ == "__main__":
    api_call_example()

Go

package main

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

	"github.com/mtlab/api/signer"
)

func main() {
	key := "your_api_key"
	secret := "your_api_secret"
	signObj := signer.NewSigner(key, secret)

	url := "https://openapi.meitu.com/api/v1/sdk/sync/push"
	method := http.MethodPost
	headers := make(http.Header)
	headers.Set(signer.HeaderHost, "openapi.meitu.com")
	headers.Set("Content-Type", "application/json")

	body := `{
  "task": "/v1/tts_synthesis/481979",
  "task_type": "formula",
  "init_images": [{
    "url": "https://example.com/input.jpg",
    "profile": {
      "media_profiles": {"media_data_type": "url"},
      "version": "v1"
    }
  }],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"timbre_id\":17,\"text\":\"测试接口连通性\"}}",
  "sync_timeout": 30
}`

	req, err := signObj.Sign(url, method, headers, body)
	if err != nil {
		fmt.Println("Failed to sign request:", err)
		return
	}

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		fmt.Println("Failed to send request:", err)
		return
	}
	defer resp.Body.Close()

	responseBody, err := io.ReadAll(resp.Body)
	if err != nil {
		fmt.Println("Read response failed:", err)
		return
	}
	fmt.Println("Response:", resp.StatusCode, string(responseBody))
}

PHP

<?php
require 'signer.php';

$key = 'your_api_key';
$secret = 'your_api_secret';
$signer = new Signer($key, $secret);

$url = 'https://openapi.meitu.com/api/v1/sdk/sync/push';
$method = 'POST';
$headers = ['Content-Type' => 'application/json'];

$innerParams = json_encode([
    'rsp_media_type' => 'url',
    'parameter' => [
        'timbre_id' => 17,
        'text' => '测试接口连通性',
    ],
]);

$body = json_encode([
    'task' => '/v1/tts_synthesis/481979',
    'task_type' => 'formula',
    'init_images' => [
        [
            'url' => 'https://example.com/input.jpg',
            'profile' => [
                'media_profiles' => ['media_data_type' => 'url'],
                'version' => 'v1',
            ],
        ],
    ],
    'params' => $innerParams,
    'sync_timeout' => 30,
]);

$curl = $signer->sign($url, $method, $headers, $body);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);

if ($status === 0) {
    echo 'Error: ' . curl_error($curl);
} else {
    echo "Status: {$status}\n";
    echo "Response: {$response}\n";
}
curl_close($curl);
?>

Java

package com.meitu.openai.common;

import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;

public class Main {
    public static void main(String[] args) throws Exception {
        Signer signer = new Signer("your_api_key", "your_api_secret");
        String url = "https://openapi.meitu.com/api/v1/sdk/sync/push";
        String method = "POST";

        Map<String, String> headers = new HashMap<>();
        headers.put("Content-Type", "application/json");
        headers.put(Signer.HeaderHost, "openapi.meitu.com");

        String body = "{\n" +
                "  \"task\": \"/v1/tts_synthesis/481979\",\n" +
                "  \"task_type\": \"formula\",\n" +
                "  \"init_images\": [{\n" +
                "    \"url\": \"https://example.com/input.jpg\",\n" +
                "    \"profile\": {\n" +
                "      \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
                "      \"version\": \"v1\"\n" +
                "    }\n" +
                "  }],\n" +
                "  \"params\": \"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"timbre_id\\\":17,\\\"text\\\":\\\"测试接口连通性\\\"}}\",\n" +
                "  \"sync_timeout\": 30\n" +
                "}";

        Map<String, String> signedHeaders = signer.sign(url, method, headers, body);
        HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
        connection.setRequestMethod(method);
        for (Map.Entry<String, String> entry : signedHeaders.entrySet()) {
            connection.setRequestProperty(entry.getKey(), entry.getValue());
        }
        connection.setDoOutput(true);
        connection.getOutputStream().write(body.getBytes(StandardCharsets.UTF_8));

        int status = connection.getResponseCode();
        InputStream stream = status >= 400
                ? connection.getErrorStream()
                : connection.getInputStream();
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(stream))) {
            StringBuilder response = new StringBuilder();
            String line;
            while ((line = reader.readLine()) != null) {
                response.append(line);
            }
            System.out.println("Response: " + status + " " + response);
        }
    }
}