You need to enable JavaScript to run this app.
创作Agent

创作Agent

复制全文
API对接相关
智能创作云-AI特效模板消费OpenAPI
复制全文
智能创作云-AI特效模板消费OpenAPI
版本变更记录
版本修改时间变更内容备注
v1.02025-11-251. 初始化文档
公共字段

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}

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

  • 签名Demo详见下面 3. 代码样例

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计算完毕的签名。

3. 代码样例

JavaGolangPython
  • 鉴权 : 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

  • 请求参数

参数类型参数类型是否必填描述
ActionStringQuerySubmitAiTemplateTaskAsync
VersionStringQuery2025-11-25

ServerId

Int

Body

服务ID , 固定值,可以在模板的详情弹窗中查看,比如:

  • 图生图:2540571789443387

  • 图生视频:3207553646887043

  • 首尾帧:7809632936052886

PayloadJson

String

Body

模板填充详情,根据不同模板入参要求构建的JSON字符串
【详情需请参照具体模板填充信息要求】

  • 响应参数
参数类型描述
ResponseMetadataResponseMetadata公共响应体
ResultAsyncTaskResult任务结果
  • 请求示例 - ResourceList是URL 数组
{
    "ServerId": 2540571789443387,
    "PayloadJson": "{\"ResourceList\":[\"https://lfxx1.jpg\"],\"TemplateId\":\"冷冬叙事拼图\"}"
}
  • 请求示例 - ResourceList是DataUri 数组

应对海外CDN提供的URL服务访问不稳定, 可以自行转换成Base64编码, 每张图编码后的字符串大小不要超过8M

{
    "ServerId": 2540571789443387,
    "PayloadJson": "{\"ResourceList\":[\"data:image/jpeg;base64,/9j/4QKGRXhpZgAATU0AKgAAAAgACAEOAAIAAAGZAAAAbgESAAMAAAABAAEAAAEaAAUAAAABAAACCAEbAAUAAAABAAACEAEoAAMAAAABAAIAAAE7AAIAAAAKAAACGAITAAMAAAABAAEAAIdpAAQAAAABAAACIgAAAABBIHZlcnkgYmVhdXRpZnVsIHNtaWxpbmcgd29tYW4gY2FsbGVkIEVsbGUgd2VhcmluZyBhIGxvbmcgd2hpdGUgc2F0aW4gZHJlc3Mgc2l0dGluZyBvbiBhIGJyZWF0aHRha2luZyBuaWNlIGJlYWNoIHNvbWV3aGVyZSBpbiBHcmVlY2UgYXQgc3Vuc2V0LCBibHVycnkgYmFja2dyb3VuZCB3aXRoIG1vdW50YWlucywgd2hpdGUgaG91c2VzIGFuZCBibHVlIHJvb2ZzLCBzaWRlIHZpZXcsIGZhbnRhc3ksIGRyZWFtaW5nLCBjaW5lbWF0aWMsIHRyZW5kaW5nIG9uIEFydFN0YXRpb24sIGF3YXJk...\"],\"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

  • 请求参数

参数类型参数类型是否必填描述
ActionStringQueryQueryAiTemplateTaskResult
VersionStringQuery2025-11-25

TaskId

String

Body

任务提交的ID
来源于异步任务结果

  • 响应参数
参数类型描述
ResponseMetadataResponseMetadata公共响应体
ResultAsyncTaskResult任务结果
  • 请求示例
{
    "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,具体数量由所选用模板指定

  • 图片格式要求
  1. 支持格式:JPG/JPEG、PNG
  • 图片规格要求
  1. 宽高尺寸范围:300px ~ 6000px(像素)

  2. 文件大小限制:≤ 8MB

  • 媒资URL要求
  1. 需为公网可直接访问的有效地址(无访问权限限制、链路稳定)

例:[ "https://lf-/obj/1xxx.jpg", "https://lf-/obj/2xxx.jpg" ]

Resolution

String

作品分辨率
仅当生成的作品为视频时,该字段生效。不同分辨率所消耗的创点不同,具体创点消耗明细可查看 SaaS 页面
取值范围:480p、720p、1080p
默认值:720p

  • 构造示例【需要将对象序列化为JSON字符串】
"{\"ResourceList\":[\"https://lf-xxx.jpg\"],\"TemplateId\":\"3D卡通绘\"}"
数据结构

1. ResponseMetadata

参数类型描述
RequestIdStringHTTP请求日志ID
ActionString请求接口标识
VersionString请求接口版本
ServiceString请求接口服务
RegionString请求接口服务地域
CodeInt任务状态码 详细见:错误码

2. AsyncTaskResult

参数类型描述
TaskIdStringAI模板异步消费任务ID,用于结果查询

3. QueryTaskResult

参数类型描述
TaskIdString任务ID
CodeInt任务状态码 详细见:错误码

Progress

Int

任务进度
取值范围:0 - 100

ResultUrlString模板结果媒资URL
StartTimeString任务开始时间
UpdateTimeString任务结束时间
错误码
{
    "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"
    }
}
CodeNameMessage
0Success任务执行成功
1000AsyncTaskRunning异步任务已在运行中
1400ParamErr参数错误
1401ConcurrentErr并发数超过限额
1402InsufficientPoints创点不足
1403QuotaErr无OpenAPI权限
1500InternalErr服务端内部错误
1600AsyncTaskNotExist任务不存在
2000AsyncTaskFailed任务执行失败
其他报错说明

使用子账号的AK/SK在调用AI特效模板接口时报错"Message": "User is not authorized to perform:

报错表现

{
    'CodeN':100013,
    "Code":"AccessDenied",
    "Message":"User is not authorized to perform:iccloud_muse:SubmitAilemplateTaskAsync on resource: "
    }
}

解决办法
需要主账户在https://console.volcengine.com/iam/policymanage里新建自定义参数配置。 iam 给子账号添加鉴权

步骤操作截图
step1点击「新建自定义策略」

step2

输入策略名,点击JSON编辑器填写Action,然后点击提交


{
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "iccloud_muse:SubmitAiTemplateTaskAsync",
                "iccloud_muse:QueryAiTemplateTaskResult"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

step3

点击「添加权限」,用户找到对应的子账号勾选上,然后点击提交


注意:自定义策略时,Action 可以直接填*,不列明具体接口,这样可以兼容其他接口。

{
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "*"
      ],
      "Resource": [
        "*"
      ]
    }
  ]
}
最近更新时间:2026.01.14 17:53:19
这个页面对您有帮助吗?
有用
有用
无用
无用