创建异步语音生成任务 - Vocu AI 开发者文档

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

contents

array [object {3}]

要生成的内容列表

必需

voiceId

string

语音角色 ID

必需

text

string

要生成的文本内容

必需

promptId

string

可选

角色风格 ID（默认为default)

默认值:

default

preset

enum<string>

可选

参数预设，默认为v2_creative

枚举值:

v2_creativev2_balancev2_stable

默认值:

v2_creative

randomness

integer

可选

多样性 (0-100，默认为100，填写后将覆盖参数预设中的对应值)

>= 0<= 100

默认值:

100

stability_boost

integer

可选

稳定性过滤 (0-1024，默认为1024，填写后将覆盖参数预设中的对应值)

>= 0<= 1024

默认值:

1024

probability_optimization

integer

可选

概率优选（0-100，默认为100，填写后将覆盖参数预设中的对应值）

>= 0<= 100

默认值:

100

break_clone

boolean

可选

启用偏向文本的情感风格（默认为true，填写后将覆盖参数预设中的对应值）

默认值:

true

sharpen

boolean

可选

音质增强（实验性，默认为false，填写后将覆盖参数预设中的对应值）

默认值:

false

flash

boolean

可选

低延迟模式（默认为false）

默认值:

false

stream

boolean

可选

是否启用流式生成（默认为false)

默认值:

false

srt

boolean

可选

是否启用字幕生成（与低延迟模式不兼容，默认为false）

默认值:

false

seed

integer <int32> | null

可选

生成种子，最大为Int32，-1或null时为随机（默认为-1）

>= -1

默认值:

-1

dictionary

array [object]

可选

读音字典，格式为：[ ["音素", [["y", "in1"],["s" "u4"]]], ["你好", [["n", "i3"],["h" "ao3"]]]]

示例

{
  "contents": [
    {
      "voiceId": "d1969f83-1891-4da0-8232-1014382428d1",
      "text": "大家好啊，今天的天气真不错啊，你觉得呢？",
      "promptId": "8c4a7d21"
    },
    {
      "voiceId": "6c69eac1-34aa-43ad-89f1-6ba1b9f5e004",
      "text": "巧了，我也觉得很不错，我们想到一块去了",
      "promptId": "e7263005"
    }
  ],
  "preset": "v2_creative",
  "randomness": 100,
  "stability_boost": 1024,
  "probability_optimization": 100,
  "break_clone": true,
  "sharpen": true,
  "flash": false,
  "stream": true,
  "srt": true,
  "seed": null,
  "dictionary": []
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://v1.vocu.ai/api/tts/generate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contents": [
        {
            "voiceId": "d1969f83-1891-4da0-8232-1014382428d1",
            "text": "大家好啊，今天的天气真不错啊，你觉得呢？",
            "promptId": "8c4a7d21"
        },
        {
            "voiceId": "6c69eac1-34aa-43ad-89f1-6ba1b9f5e004",
            "text": "巧了，我也觉得很不错，我们想到一块去了",
            "promptId": "e7263005"
        }
    ],
    "preset": "v2_creative",
    "randomness": 100,
    "stability_boost": 1024,
    "probability_optimization": 100,
    "break_clone": true,
    "sharpen": true,
    "flash": false,
    "stream": true,
    "srt": true,
    "seed": null,
    "dictionary": []
}'

返回响应

🟢200成功创建异步生成任务

application/json

Body

status

integer

状态码

可选

示例值:

200

message

string

状态信息

可选

示例值:

OK

data

object (生成任务)

可选

创建的异步生成任务详情

id

string

异步生成任务 ID

必需

userId

string

必需

创建任务的用户 ID

status

enum<string>

必需

异步任务状态，可以是 pending 等待中 / processing 处理中 / generated 已完成 / failed 任务出错

枚举值:

pendinggeneratedprocessingfailed

type

enum<string>

必需

任务所使用的模型ID

枚举值:

vocu-neural-voice-001

默认值:

vocu-neural-voice-001

metadata

object

任务元数据

必需

示例

{
  "status": 200,
  "message": "OK",
  "data": {
    "id": "ec138706-823b-420f-a78b-9c5cf2053997",
    "userId": "0bc323ca-7be4-4526-af56-3f9f3052a838",
    "status": "failed",
    "type": "vocu-neural-voice-001",
    "metadata": {
      "contents": [
        {
          "voiceId": "9946da5f-8212-48c3-8041-f56a4bb0d853",
          "text": "酥脆的炸蛇肉小块，撒上麻椒调味，配上一款黑莓酱作为蘸料。",
          "audio": "https://storage.vocu.ai/generate/7cdaabdf-b066-46c1-a05a-0f28f82a33ae/a3be0533-dec7-4a96-8c52-f46ce48b96aa-13.mp3",
          "generatedAt": "2022-12-14T11:35:53.880Z"
        },
        {
          "voiceId": "42dcfc75-0d56-45eb-9cd4-4003b0515354",
          "text": "一款令人愉悦的果挞，融合了松软的的番茄干和甜美的李子，装在一个黄油味十足的酥皮壳中，最后淋上一丝甘草提味。",
          "audio": "https://storage.vocu.ai/generate/1c96d289-fd72-441b-8979-575522fb8e56/71d9f624-ea36-4f9b-8fcf-bf850a7e1807-14.mp3",
          "generatedAt": "1964-02-04T21:19:38.944Z"
        },
        {
          "voiceId": "71741003-7260-417b-ad90-65d7ebaebe18",
          "text": "一个简单的木瓜派。不加花哨的东西，就是派。",
          "audio": "https://storage.vocu.ai/generate/300a4ed1-d313-4079-a827-13067b66fc00/35c366d9-2bf3-4fe0-9984-d25d1d55e116-15.mp3",
          "generatedAt": "1948-07-29T22:04:22.900Z"
        }
      ],
      "characters": 97,
      "voices": [
        {
          "id": "4798e410-1774-4f02-a461-efa48e430f75",
          "idForGenerate": "c5c650a2-0657-4c56-94a7-5b56ddf02232",
          "name": "柴熙瑶",
          "status": "lora-failed",
          "metadata": {
            "avatar": "https://picsum.photos/seed/adLqxCP8/623/417",
            "description": "父母，极客，美食家",
            "prompts": [
              {
                "id": "4f22aac1-1e86-4d19-b419-e7dd8b175dd0",
                "name": "鲁莽",
                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/570095/643676-playback-4bk7te.mp3",
                "description": "鲁莽的情感风格"
              },
              {
                "id": "5b7036ad-6faa-451e-9258-aef2db25f454",
                "name": "笔直",
                "promptOriginAudioStorageUrl": "https://storage.vocu.ai/prompt/845026/577993-playback-hexto7.mp3",
                "description": "笔直的情感风格"
              }
            ]
          }
        }
      ],
      "temperature": 1,
      "top_k": 1024,
      "top_p": 1,
      "isPremium": false,
      "audio": "https://storage.vocu.ai/generate/2f09e6c1-d560-483a-ade8-7b6923de4d47/851c7cf9-db66-41a7-9f26-5f27f46c7788-merged.mp3",
      "generatedAt": "1971-07-21T05:54:29.797Z",
      "regenerates": [
        {
          "contents": [
            1
          ],
          "characters": 82
        },
        {
          "contents": [
            1,
            2
          ],
          "characters": 29
        }
      ]
    }
  }
}

🟠400请求参数错误

🟠403点数不足