You need to enable JavaScript to run this app.
导航
智能创作云-图文转视频OpenAPI
最近更新时间:2024.07.30 20:47:45首次发布时间:2024.07.30 20:47:45
版本变更记录
版本修改时间变更内容备注
v1.02022-08-11初始化文档
v1.12023-07-111. 新增替换模板固定文案字段FixedText
公共字段
  1. 请求Host:https://icp.volcengineapi.com

  2. 请求Header

描述:http请求中header需增加的字段

参数名参数类型是否必填描述
X-DateString使用UTC时间,精确到秒。请使用格式:YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z

Authorization

String

HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

  • 签名完整过程详见:签名示例

  • Java版签名Demo详见如下附件

    暂时无法在飞书文档外展示此内容

Content-TypeStringMIME类型,固定值: application/json

X-Content-Sha256

String

对完整请求Body的加密结果,HexEncode(Hash(RequestPayload))

HexEncodeHexEncode代指转16进制编码
Hash代指SHA256算法
RequestPayload代指完整的请求的body。

Authorization中的信息含义:

名称类型备注

AccessKeyId

String

请求的AccessKey。

  • AK/SK获取说明

    • 说明:在调用火山引擎视觉智能控制台的各个能力之前,确保您已生成访问密钥(AccessKey)。AccessKey包括AccessKeyID(AK)和AccessKeySecret(SK),其中AccessKeyID用于标识用户,AccessKeySecret是用来验证用户的密钥,请妥善保管。

    • 获取方式:点击右上角账号,下拉列表选择【密钥管理】,点击【新建密钥】按钮,可获取AK/SK,可以此为凭证调用上述已接入应用的接口。

    注:安全起见,建议新建子账户,并使用子账户的AK/SK

ShortDateString请求的短时间,使用UTC时间,精确到日。请使用格式:YYYYMMDD,例如:20221101
RegionString请求的地域,固定值: cn-north-1
ServiceString请求的服务,固定值: iccloud_muse
SignedHeadersString参与签名的Header,用分号分隔。
SignatureString计算完毕的签名。
HTTP接口详情

支持使用图片文字智能生成视频,扩大视频创作的方式,丰富平台视频的多样性,降低创作门槛。
图文转视频内含业界领先的语义理解算法,图文匹配算法,并辅以真实亲切的语音播报,生动的模板效果,提供便捷、智能、高效的视频生产体验。

  1. SubmitText2VideoTaskAsync

描述: 提交图文转视频任务

Method: POST

请求参数

类别参数类型位置是否必填描述
通用参数ActionStringQuerySubmitText2VideoTaskAsync
VersionStringQuery2022-08-01

视频内容

Type

Int

Body

生成视频的方式,0表示传入文章链接,1表示传入文章标题和文章内容,2表示传入word文档

ArticleUrl

String

Body

当type=0时必填,表示文章链接,目前支持头条文章域名

ArticleTitleStringBody当type=1时必填,表示文章标题

ArticleContent

String

Body

当type=1时必填,表示文章内容,字数≤3000

FileUrl

String

Body

当type=2时必填,表示word文档链接,仅支持.docx格式,大小≤15MB

FixedText

String

Body

替换模板中固定文案,不替换不传,无需文案传空字符串

视频配置

TargetDuration

Int

Body

视频时长的种类,目前有三种,0表示短(约15s),1表示中等(约30s),2表示长(约60s)。不传该字段表示全文生成。

ScreenRatio

Int

Body

屏幕比例的种类,0表示9:16(默认),1表示16:9

ResolutionIntBody视频分辨率,0为720P,1为1080P
TemplateIdIntBody模板ID,不传该字段为自动匹配

MaterialSource

Int[]

Body

素材来源(可选择多个),0:链接/word中的素材,1:素材库中的素材,2:商用版权素材,4:无版权素材,5:免费版权素材

CoverType

Int

Body

封面样式,0(默认):非黑首帧,1:在封面模板库中随机选取

语音播报

ToneId

Int

Body

语音播报音色ID,不传该字段为无需播报

TtsSpeedIntBody语音播报速度,100为原速度,区间50-200
TtsVolumeIntBody语音播报音量,100为原音量,区间0-200
TtsPitchIntBody语音播报音调,100为原音调,区间50-200

背景音乐

BgmType

Int

Body

背景音乐类型,0:智能匹配(默认),1:手动选择,2:传入自定义Url

BgmSourceStringBodyBgmType=0时,此值可不填 BgmType=1时,请传入背景音乐ID BgmType=2时,请传入自定义的http链接
BgmVolumeIntBody背景音乐音量,默认为10(10%音量),区间0-100

请求参数示例:

{
   // 播报内容,三种输入方式任选其一
     
     // 输入文章链接
     "Type": 0,
     "ArticleUrl": "https://www.toutiao.com/a7005198875711586820",
     "FixedText":"固定文案",
     
     // 输入文章内容
     "Type": 1,
     "ArticleTitle": "测试标题",
     "ArticleContent": "测试内容",
     
     // 输入Word文档
     "Type": 2,
     "FileUrl": "https://xxx.docx",
     
   // 通用参数
     
     // 视频配置
     //"TargetDuration": 0,
     "ScreenRatio": 1,
     "Resolution": 1,
     //"TemplateId": 1,
     "MaterialSource": [1],
     "CoverType": 1,
     
     // 语音播报
     "ToneId": 0,
     "TtsSpeed": 100,
     "TtsVolume": 100,
     "TtsPitch": 100,
     
     // 背景音乐
     "BgmType": 1,
     "BgmSource": "1",
     "BgmVolume": 10
}

返回参数

{
    // 网关统一相应元信息
    "Code": 0,
    "Message": "成功", // 请求、网关错误信息
    "ResponseMetadata": {
        "RequestId": "xxxxx",
        "Action": "SubmitText2VideoTaskAsync",
        "Version": "2022-08-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": {
        // 业务返回信息
        "Status": 0,
        "VideoKey": "ff04ad42-ca34-11ed-a86b-3436ac1200a4" //任务唯一标识
    }
}
  1. QueryText2VideoTasks

描述: 根据任务key查询图文转视频
Method: GET
请求参数

参数类型参数类型是否必填描述
ActionStringQueryQueryText2VideoTasks
VersionStringQuery2022-08-01
VideoKeysStringQuery任务唯一标识,多个任务通过","间隔,例如"aaa,bbb"

返回参数

{
    // 网关统一相应元信息
    "Code": 0,
    "Message": "成功",
    "ResponseMetadata": {
        "RequestId": "20211213140257010225133143062CC07B",
        "Action": "QueryText2VideoTask",
        "Version": "2022-08-01",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
    },
    "Result": [
        // 业务返回信息
         {
             "VideoKey": "xxx",                        //任务Key
             "Museid": "xxx",                          //成片ID
             "DownloadUrl": "xxx",                     //下载Url,24h有效期
             "CoverUrl": "https://xxx",                //封面Url,24h有效期
             "TaskStatus": 0,                          //生成状态,0:成功,1:算法中,2:渲染中,3:失败
             "Progress": 100,                          //生成进度
             "Createdat": "2020-01-02 15:04:05",       //任务创建时间
             "Updatedat": "2020-01-02 15:04:07",       //任务更新时间
             "Message": "xxx",                         //错误信息
         },
    ]
}

数据结构

错误码
CodeDomain错误说明
0Ok成功
4001Parameter参数错误
4002InvalidAccess无权限使用,可能是使用次数/存储容量已达上限
4003InvalidUser无效账户信息
4004TooManyTasks并行任务数超出上限
4005RequestError请求Header信息缺失
4006TaskNotFound任务不存在或已被删除
5001ServerError服务器错误
物料

模板

竖版(9:16)

ID名称类别封面备注
0红色经典模板【资讯播报】
1黑色经典模板【资讯播报】
2科技紫曲线模板【股市行情】
3紫色渐变几何模板【重磅新闻】
4蓝色未来感模板【股市行情】
5炫彩追光动感模板【资讯播报】
6深蓝地图模板【资讯播报】
7朱红创意模板【赛事播报】
8熊猫卡通模板【赛事播报】
9毛玻璃雾感模板【资讯播报】
10新虚拟女主播模板【新闻播报】
11天蓝概念模板【重磅新闻】
12深蓝几何模板【资讯播报】

13

蓝紫动感模板

【股市行情】

14白色轻透感模版【热点洞察】
15深蓝光感模板【功能操作指引】
16新虚拟男主播模板【新闻播报】
17虚拟主播资讯模板【兴业专属】
183D机智猫模板【兴业专属】
19大红k线模板【股市行情】
20深蓝k线模板【股市行情】
21紫色炫光模板【资讯播报】

22

雅金炫光模板

【资讯播报】

23简约动态几何模板【资讯播报】
24蓝色简约动态几何模板【资讯播报】
25暗红动态模板【热点资讯】
26蓝金动态模板【热点资讯】
27蓝金网格模板【热点资讯】
28天蓝网格模板【热点资讯】
29深蓝网格模板【热点资讯】
30大红网格模板【资讯播报】
31褐金质感模板【热点要闻】
32红金质感模板【热点要闻】
33None
34None
35None
36None
37None
38None
39None
40None
41None
42None
43None
44None
45None
46None
47None
48None
49None
50None
51None
52None
53None
54None
55None
56None
57None
58None
59None
60None
61None
62None
63None
64None
65None
66None
67None
68None
69None
70None
71None
72None
73None
74None
75None
76None
77None
78None
79None
80None
81None
82None
83None
84None
85None
86None
87None
88None

横版(16:9)

ID名称类别封面备注
0横画幅模板【商务经典】
1新虚拟女主播模板【资讯播报】
2毛玻璃雾感模板【资讯播报】
3新虚拟女主播模板【热点洞察】
4新虚拟男主播模板【资讯播报】

5

沉浸式播报模板

【兴业专属】

6虚拟主播资讯模板【兴业专属】
7镭射蓝金模板【热点要闻】
8暗红镭射模板【热点资讯】
9None
10None
11None
12None
13None
14None
15None
16None

背景音乐

ID名称类别试听链接备注
1通用1通用https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/tongyong2.mp3

2

通用2

通用

https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/80f9c6ac3fca3e48db20e7ed71f669ce.mp3

3通用3通用https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/98d742f4553ab48de4cbea30d0140d64.mp3
4通用4通用https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/17ce131155593e2a07ade85a9930e515.mp3
5通用5通用https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/e75e034ae34f7e22733c28723683789f.mp3
7通用6通用https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/1610151788908546.mp3
8诙谐1诙谐https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/d6c730beedffa920f9e690399230d409.mp3
9诙谐2诙谐https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/42ac4c60af5c38b7eb74ba15c0a33e13.mp3
10诙谐3诙谐https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/1605055098898449.mp3
11紧张1紧张https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/1641382351167563.mp3
12紧张2紧张https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/33920000013e7de9b503
13激昂1激昂https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/1605057721351170.mp3
14激昂2激昂https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/53110004702ff4b1ec99
15Canyons轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/1631506921947144.mp3
16Pebbles轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/1628704623287300.mp3
17Flute piccolo轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/66d3528eb6171c38e5766620b40351f5.mp3
18WHAT轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/05d7aa0210a02ceaeb2fd0dd69ec1608.mp3
19是夏天啊轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/a347257d5cb59edbe965f21adc9be859.mp3
20Kikoshin轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/93760002a1a034e4a5fa
21电流急急棒BGM Pt.2轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/a44369e38ad40b9ee3615175fd32dcf1.mp3
22Suns轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/1634856217690113.mp3
23Left Right轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/f2a943e1524377b1fa70f1188d4de34d.mp3
24di feel(pt1)轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/e656ad893f2e12d75a00488347a174b7.mp3
25Play轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/85c90000a05bbd908086
26lets go play轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/1605054142787585.mp3
27跳跳跳!轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/42ac4c60af5c38b7eb74ba15c0a33e13.mp3
28调皮轻快https://lf-iccloud-muse.volcmusecdn.com/obj/labcv-tob/muse/3f93554218e8c45be13a01a0e5fd911b.mp3

音色

可以在智能创作云SaaS平台【智能配音】功能,体验多种不同音色的播报效果,可以自由调节语速、音调等数据。

ID名称描述试听链接备注
0抖音IP小姐姐机械女声,适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_new_BV001.mp3
1抖音IP小哥哥机械男声,适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV002.mp3
2成熟女声成熟女声,适用于零售,金融场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV009_DPE.mp3
3青年女声客服女声,适用于零售,金融场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV007.mp3
4稳重大叔大气男声, 适用于广告,零售场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV006.mp3
5青年男声客服男声,适用于零售,金融场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV008_DPE.mp3
6新闻女声新闻女声, 适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV011.mp3
7可爱少女活泼女声,适用于广告,零售场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV005.mp3
8新闻男声新闻男声, 适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV012.mp3
9活力青年活力男生,适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV056.mp3
10中英男声中英温柔男声,适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV033_ParaTaco.mp3
11东北老铁东北方言,适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV021.mp3
12西安掌柜西安方言,适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV210.mp3
13港剧男神粤语方言,适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV026.mp3
14甜美台妹台湾方言,适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV025.mp3
15相声演员天津方言,适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV212.mp3
16重庆小伙重庆方言,适用于泛互场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV019.mp3
17二次元萝莉萝莉童声,适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV064.mp3
18海绵宝宝卡通童声,适用于通用场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV063.mp3

19

萌娃童声

温柔童声,适用于泛互场景

https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV051.mp3

20说书大叔说书京腔,适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV110.mp3
21阳光青年阳光积极,适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV123.mp3
22憨厚青年憨厚老实,适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV120.mp3
23散漫赘婿慵懒男声,适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV119.mp3
24霸气青叔高冷霸气,适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV107.mp3
25质朴青年明朗男声,适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV100.mp3
26儒雅青年稳重男声,适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV102.mp3
27开朗青年男声,适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV004.mp3
28温和少御温柔女声,适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV114.mp3
29平缓少御平缓女声,适用于小说场景https://sf1-cdn-tos.huoshanstatic.com/obj/labcv-tob/muse/tts_BV113.mp3