智能创作云-AI特效模板消费OpenAPI--智能创作云-火山引擎

文档中心

导航

智能创作云-AI特效模板消费OpenAPI

最近更新时间：2025.11.25 20:58:54首次发布时间：2025.11.24 15:42:12

版本变更记录

版本	修改时间	变更内容	备注
v1.0	2025-11-25	1. 初始化文档

公共字段

1. 请求Host

https://icp.volcengineapi.com

描述：Http请求中header需增加的字段

参数名	参数类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z`
Authorization	String	是	`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}` 签名完整过程详见：签名示例签名Demo详见下面 `3. 代码样例`
Content-Type	String	是	MIME类型，固定值： `application/json`
X-Content-Sha256	String	否	对完整请求Body的加密结果，`HexEncode(Hash(RequestPayload))` `HexEncode`HexEncode代指转16进制编码 `Hash`代指SHA256算法 `RequestPayload`代指完整的请求的body。

Authorization中的信息含义：

名称	类型	备注
AccessKeyId	String	请求的AccessKey。 AK/SK获取说明说明：在调用火山引擎视觉智能控制台的各个能力之前，确保您已生成访问密钥（AccessKey）。AccessKey包括AccessKeyID（AK）和AccessKeySecret（SK），其中AccessKeyID用于标识用户，AccessKeySecret是用来验证用户的密钥，请妥善保管。获取方式：点击右上角账号，下拉列表选择【密钥管理】，点击【新建密钥】按钮，可获取AK/SK，可以此为凭证调用上述已接入应用的接口注：安全起见，建议新建子账户，并使用子账户的AK/SK
ShortDate	String	请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20221101
Region	String	请求的地域，固定值： `cn-north-1`
Service	String	请求的服务，固定值： `iccloud_muse`
SignedHeaders	String	参与签名的Header，用分号分隔。
Signature	String	计算完毕的签名。

3. 代码样例

Java	Golang	Python
鉴权 : `getSignedKey` 发起任务 : `doRequest` 并通过 TaskId 轮询结果: `queryUntilDone`	鉴权 : `func getSignedKey` 发起任务 :`func do_request` 并通过 TaskId 轮询结果: `func submitAndQuery`	鉴权 : `def get_signed_key` 发起任务 :`def do_request` 并通过 TaskId 轮询结果: `def submit_and_query`
VolcEngineApi.zip 1.11MB `java -cp "out:lib/" VolcEngineApiClient javac -encoding UTF-8 -cp "lib/" -d out src/VolcEngineApiClient.java`	api_sample_demo.go 7.10KB `go run api_sample.go`	api_sample.py 7.66KB `python api_sample.py`

HTTP接口详情

1. AI模板消费

SubmitAiTemplateTaskAsync

描述：提交AI模板消费异步任务
Method：POST
请求参数

参数	类型	参数类型	是否必填	描述
Action	String	Query	是	SubmitAiTemplateTaskAsync
Version	String	Query	是	2025-11-25
ServerId	Int	Body	是	服务ID , 固定值图生图：2540571789443387 图生视频：3207553646887043
PayloadJson	String	Body	是	模板填充详情，根据不同模板入参要求构建的JSON字符串【详情需请参照具体模板填充信息要求】

响应参数

参数	类型	描述
ResponseMetadata	ResponseMetadata	公共响应体
Result	AsyncTaskResult	任务结果

请求示例

{
    "ServerId": 2540571789443387,
    "PayloadJson": "{\"ResourceList\":[\"https://lfxx1.jpg\"],\"TemplateId\":\"冷冬叙事拼图\"}"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2025111816192007E6ED6D440FE65D0A1F",
        "Action": "SubmitAiTemplateTaskAsync",
        "Version": "2025-11-25",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
        "Code": 0
    },
    "Result": {
        "TaskId": "7573967600885514303"
    }
}

QueryAiTemplateTaskResult

描述：查询AI模板消费异步任务结果
Method：POST
请求参数

参数	类型	参数类型	是否必填	描述
Action	String	Query	是	QueryAiTemplateTaskResult
Version	String	Query	是	2025-11-25
TaskId	String	Body	是	任务提交的ID 来源于异步任务结果

响应参数

参数	类型	描述
ResponseMetadata	ResponseMetadata	公共响应体
Result	AsyncTaskResult	任务结果

请求示例

{
    "TaskId": "7574258855660486699"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20251119123339DA1F93013A210DCD16FE",
        "Action": "QueryAiTemplateTaskResult",
        "Version": "2025-11-25",
        "Service": "iccloud_muse",
        "Region": "cn-north-1",
        "Code": 0
    },
    "Result": {
        "TaskId": "7574258855660486699",
        "Code": 0,
        "Progress": 100,
        "ResultUrl": "https://ark-content-generation-v2-cn-beijing.xxxx",
        "StartTime": "2025-11-19 12:32:51",
        "UpdateTime": "2025-11-19 12:33:21"
    }
}

2. 模板填充信息

说明
- 构建发起任务时的填充信息
- 参数用于任务发起时入参，参考「模板消费请求参数」
该参数用于模板消费任务发起时的入参「PayloadJson」

参数	类型	是否必填	描述
TemplateId	String	是	模板ID 来源于创作云AI模板广场的模板详情例："3D卡通绘"
ResourceList	[ ]String	是	输入的一张或者多张图的媒资URL, 具体图片数量根据模板要求确定格式要求：jpg/jpeg、png 例：[ "https://lf-/obj/1xxx.jpg", "https://lf-/obj/2xxx.jpg" ]

构造示例【需要将对象序列化为JSON字符串】

"{\"ResourceList\":[\"https://lf-xxx.jpg\"],\"TemplateId\":\"3D卡通绘\"}"

模板消费任务发起入口

数据结构

1. ResponseMetadata

参数	类型	描述
RequestId	String	HTTP请求日志ID
Action	String	请求接口标识
Version	String	请求接口版本
Service	String	请求接口服务
Region	String	请求接口服务地域
Code	Int	任务状态码详细见：错误码

2. AsyncTaskResult

参数	类型	描述
TaskId	String	AI模板异步消费任务ID，用于结果查询

3. QueryTaskResult

参数	类型	描述
TaskId	String	任务ID
Code	Int	任务状态码详细见：错误码
Progress	Int	任务进度取值范围：0 - 100
ResultUrl	String	模板结果媒资URL
StartTime	String	任务开始时间
UpdateTime	String	任务结束时间

错误码

{
    "ResponseMetadata": {
        "RequestId"："202511221602162C79BEBEFE54155839AF"
        "Action"："SubmitAiTemplateTaskAsync"，
        "Version"： "2025-11-25"，
        "Service"： "iccloud_muse"，
        "Region"： "cn-north-1"，
        "Code"：1402，  // 错误码见下表
        "Domain"："aigc_openapi"，
        "Message"： "domain:aigc_openapi code:1402"
    }
}

Code	Name	Message
0	Success	任务执行成功
1000	AsyncTaskRunning	异步任务已在运行中
1400	ParamErr	参数错误
1401	ConcurrentErr	并发数超过限额
1402	InsufficientPoints	创点不足
1403	QuotaErr	无OpenAPI权限
1500	InternalErr	服务端内部错误
1600	AsyncTaskNotExist	任务不存在
2000	AsyncTaskFailed	任务执行失败

智能创作云

1. 请求Host

2. 请求Header

3. 代码样例

1. AI模板消费

SubmitAiTemplateTaskAsync

QueryAiTemplateTaskResult

2. 模板填充信息

1. ResponseMetadata

2. AsyncTaskResult

3. QueryTaskResult