云点播创建AIGC生音频任务

1. 接口描述

接口请求域名： vod.tencentcloudapi.com 。

调用该接口，用于创建AI生音频任务。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateAigcAudioTask。
Version	是	String	公共参数，本接口取值：2018-07-17。
Region	否	String	公共参数，此参数为可选参数。
SubAppId	否	Integer	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：251441341
ModelName	否	String	模型名称。示例值：Kling
ModelVersion	否	String	指定模型特定版本号。默认使用系统当前所支持的模型稳定版本。示例值：1.0
SceneType	否	String	指定场景，目前支持sfx（音效）、music（音乐）。示例值：sfx
Prompt	否	String	生成音频的描述示例值：春节庆祝时的烟花声
VideoInfos.N	否	Array of AigcAudioReferenceVideoInfo	参考视频信息
AudioInfos.N	否	Array of AigcAudioReferenceAudioInfo	传入参考音频信息。比如传入音频生成音乐时需要传入。
OutputConfig	否	AigcAudioOutputConfig	输出参数
AdditionalParameters	否	String	用于传入一些模型需要的特殊场景参数，Json格式序列化成字符串。示例： {"camera_control":{"type":"simple"}} 示例值：{"bgm_prompt": "治愈系钢琴曲，轻柔的弦乐伴奏，温暖舒缓的旋律，带有淡淡的情感起伏，适合剧情类视频", "asmr_mode": true}

3. 输出参数

参数名称	类型	描述
TaskId	String	任务创建成功后，返回的任务ID。调用查询接口，轮询获取任务进度及生成结果。示例值：251441341-AigcAudioTask-ed886585de73592fca966e81b6bc2d20t
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创作音乐

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAigcAudioTask
<公共请求参数>

{
    "SubAppId": 251441341,
    "ModelName": "MiniMaxMusic",
    "ModelVersion": "2.0",
    "SceneType": "music",
    "Prompt": "一首欢乐的歌",
    "OutputConfig": {
        "StorageMode": "Temporary",
        "OutputAudioFormat": "mp3"
    },
    "AdditionalParameters": "{\"lyrics\": \"大海啊，全是水，骏马啊，四条腿,***************\"}"
}

输出示例

{
    "Response": {
        "TaskId": "251441341-AigcAudioTask-ed886585de73592fca966e81b6bc2d20t",
        "RequestId": "a9a9e323-d543-4bd3-b638-5853763e90c7"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter.ViolationContent	InvalidParameter.ViolationContent

创建AIGC生音频任务

本页目录：