跳转到主要内容
GET
/
api
/
v1
/
client
/
job
/
bytedance-templates
查询 ByteDance AI 特效模板列表
curl --request GET \
  --url https://api.crun.ai/api/v1/client/job/bytedance-templates \
  --header 'x-api-key: <api-key>'
{
  "code": 200,
  "message": "success",
  "data": {
    "total": 280,
    "templates": [
      {
        "MediaId": "7642552612302307355",
        "Title": "战斗游戏",
        "Cover": "https://muse.console.volcengine.com/api/storage/objects/media/7642552364255297590_transcode_image_jpeg_480p/example.jpeg",
        "Duration": 10123,
        "PreviewVideo": "https://muse.console.volcengine.com/api/storage/objects/media/7642552612302307355_transcode_video_mp4_480p_h264.mp4",
        "Tags": [
          "🔥Seedance2.0模型"
        ],
        "ServiceId": "217677058",
        "TemplateId": "104909826",
        "TemplateType": "BEGIN_END_FRAME",
        "InputRequirement": "SINGLE_PERSON",
        "InputNum": 1,
        "ReleaseOnlineTime": 1779421051,
        "ConsumeItems": [
          {
            "Resolution": "480p",
            "Credit": 166.5
          },
          {
            "Resolution": "720p",
            "Credit": 355.2
          }
        ],
        "Title_en": "Battle Game",
        "Tags_en": [
          "🔥Seedance2.0 Model"
        ],
        "CoverAspectRatio": "9:16",
        "SupportAspectRatio": "9:16,1:1,16:9,4:3,3:4"
      }
    ]
  }
}

概述

使用此接口查询 Crun 提供的可用 ByteDance AI 特效模板。 此接口面向希望通过单一 API 连接集成所有 ByteDance 模板的开发者。它会返回模板元数据、封面资源、预览视频、输入图片要求、支持的宽高比、支持的分辨率,以及经过 Crun 标准化后的积分消耗。
开发者可以将此接口作为 ByteDance 模板 ID 和各模板能力的可信来源,然后将选定的 TemplateId 直接传入 bytedance/template,从而一键集成所有支持的模板。

使用场景

  1. 构建 ByteDance 模板市场或模板选择器 UI
  2. 按计划同步最新模板列表
  3. 通过传入可选的 template_id 参数查询单个模板
  4. 基于 InputNumInputRequirementTemplateTypeConsumeItems 驱动动态表单渲染

官方模板库

你也可以打开 ByteDance 官方模板库,选择模板并获取模板 ID:

相关资源

ByteDance 模板视频

使用选定模板和图片输入提交 ByteDance 模板视频生成任务。

获取任务信息

任务提交后查询生成状态并获取最终结果。

授权

x-api-key
string
header
必填

所有 API 都需要通过 API Key 进行身份验证。

获取 API Key:

  1. 访问 API Key 管理页面 获取您的 API Key

使用方式: 添加到请求头:

x-api-key: YOUR_API_KEY

注意:

  • 请妥善保管您的 API Key,不要与他人共享
  • 如果怀疑 API Key 已泄露,请立即在管理页面重置

查询参数

page
integer
默认值:1

页码。提供 template_id 时忽略。

必填范围: x >= 1
page_size
integer
默认值:20

每页模板数量,最大值为 50。提供 template_id 时忽略。

必填范围: x <= 50
template_id
string
默认值:""

可选模板 ID。提供后仅返回匹配的模板。

响应

请求成功

code
enum<integer>

响应状态码

  • 200:成功,请求已成功处理
  • 401:未授权,身份验证凭证缺失或无效
  • 402:积分不足,账户积分不足以执行本次操作
  • 404:未找到,请求的资源或接口不存在
  • 422:参数校验错误,请求参数未通过校验
  • 429:触发速率限制,请求频率已超过当前资源限制
  • 455:服务不可用,系统正在维护
  • 500:服务器错误,处理请求时发生意外错误
  • 501:生成失败,内容生成任务失败
  • 505:功能已禁用,请求的功能当前不可用
可用选项:
200,
401,
402,
404,
422,
429,
455,
500,
501,
505
message
string

响应消息;失败时为错误说明

示例:

"success"

data
object