You need to enable JavaScript to run this app.
文档中心
Kickart

Kickart

复制全文
下载 pdf
其他API
创点预估API
复制全文
下载 pdf
创点预估API
  1. 概述​
本文档为创作Agent OpenAPI 的官方接入指引。旨在帮助开发者通过 API 接口获取AI任务的预估创点消耗。​
  1. 快速开始​
仅需两步即可完成您的首次 API 调用:​
  1. 申请 API Key:在火山-创作Agent控制台获取用于OpenAPI请求的 API Key。​
  1. 调用接口:根据本文档的指引,构造 HTTP 请求,并通过 API Key 进行鉴权,发起接口调用。​
​
*调用 API 须确认有权使用所提交的信息及内容,承诺上传的人像素材均为已授权虚拟人像,并已阅读且同意《虚拟人像合规承诺函》与《合规承诺函》​
​
  1. 对外域名​
  1. APIKey 申请​
  1. 请通过主账号登录创作Agent首页。​
​​​​​
  1. 在左侧菜单中选择 「API Key」模块,然后点击 「+New」 按钮。​
  1. 输入 API Key 名称后,点击 「Create」按钮完成创建。​
  1. 创建成功后,您将获得一个 API Key。请妥善保管此密钥,它将作为您调用所有接口的唯一凭证。​
权限说明:在调用接口前,请确保您的账户已开通相关服务的访问权限。若在调用过程中遇到权限问题,请联系您的企业管理员或火山引擎商务代表。​
  1. 鉴权方式​
所有 API 接口均采用基于 HTTP Header 的 Bearer Token 鉴权方案。您需要在每次请求的 Header 中附带 Authorization 和 Content-Type 字段。​
​
Header​
说明​
Authorization​
认证凭证。格式必须为 Bearer {API_KEY},其中 {API_KEY} 需要替换为您在创作Agent平台申请到的真实 API Key。​
示例: Bearer 1jkdislxdsldjgeouqllsj8ko8gssccx​
Content-Type​
请求体的内容类型。固定值为 application/json。​
​
​
​​
​
  1. 模板说明(视情况需要一般只有模板ID)​
与实际任务中的模版ID一致​
  1. 接口说明​
创点预估接口​
该接口用于查询指定template_id输入场景下创点预估消耗值,返回的数据包括最小和最大预估创点消耗。​
  • 请求方法:POST​
  • 请求路径:/openapi/ai_effect/estimate_credits​
请求参数​
​
字段名​
类型​
中文​
必填​
示例​
描述​
template_id​
​
string​
模板 ID​
是​
60001​
要使用的模板 ID。请从“模板说明”表格中获取​
​
payload​
json​
​
模板任务生成参数​
​
是​
​
参考模板接入文档​
​
JSON Object,用于传递模板渲染所需的具体参数,具体可参考不同模板对应接入文档。​
​
响应参数​
​
字段名​
类型​
描述​
code​
int32​
状态码。0 表示请求成功。非 0 值表示请求失败,原因见 message 字段,具体含义请参考“错误码说明”章节。​
message​
string​
状态描述信息。​
request_id​
string​
本次请求的唯一标识符,可用于问题排查。​
data​
object​
包含字体列表数据的对象,其结构见下文 data 结构。​
​
  • data 结构​
​
字段名​
类型​
描述​
estimated_min_credits​
double​
预估最小消耗创点​
estimated_max_credits​
double​
预估最大消耗创点​
​
​​
错误码说明​
所有接口的响应体中都包含 code 和 message 字段,用于指示请求的处理结果。当 code 为 0 时,表示业务处理成功。非 0 值表示出现了异常。​
通用错误码​
​
错误码​
错误类型(标记用, 不会返回)​
描述与处理建议​
1300​
AuthFailed​
​
认证失败:API Key 无效、过期或未激活。请检查您的 API Key 是否正确,或在火山引擎控制台确认其状态。​
1400​
ParamErr​
​
参数错误:请求中包含无效或缺失的参数。请对照文档检查请求体结构、字段类型和必填项。​
1403​
QuotaErr​
无权限:您的账户没有调用此接口的权限。请联系企业管理员为您开通相关服务的访问权限。​
1418​
InvalidDurationBillingErr​
无效时长参数:入参时长参数不满足接口入参要求​
1500​
InternalErr​
​
内部错误:服务端发生未知错误。请记录 request_id 并联系技术支持。​
​
最近更新时间:2026.10.28 16:29:05
这个页面对您有帮助吗?
有用
有用
无用
无用