跳转到主要内容
POST
/
api
/
v1
/
client
/
job
/
CreateTask
使用 ByteDance AI 特效模板生成视频
curl --request POST \
  --url https://api.crun.ai/api/v1/client/job/CreateTask \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "model": "bytedance/template",
  "callback_url": "https://your-domain.com/api/callback",
  "input": {
    "template_id": "104909826",
    "img_urls": [
      "https://static.crunai.com/u/example-image.png"
    ],
    "resolution": "720p"
  }
}
'
{
  "code": 200,
  "message": "success",
  "data": {
    "task_id": "task_12345678"
  }
}

概述

使用此接口通过 Crun 的统一任务创建 API,基于 ByteDance AI 特效模板生成视频。 外层请求使用 model: "bytedance/template"input 对象包含选定的模板 ID、一个或多个输入图片 URL,以及目标输出分辨率:
{
  "model": "bytedance/template",
  "input": {
    "template_id": "104909826",
    "img_urls": [
      "https://static.crunai.com/u/example-image.png"
    ],
    "resolution": "720p"
  }
}
如需一次性集成所有 ByteDance AI 特效模板,请先调用 /api/v1/client/job/bytedance-templates,在你的应用中渲染返回的模板目录,然后将选定的 TemplateId 作为 template_id 提交到此生成接口。

模板发现

在创建任务之前,先查询 Crun ByteDance 模板列表接口:

ByteDance 模板列表

查询可用的 ByteDance AI 特效模板、预览资源、输入要求、支持分辨率和积分消耗。
列表接口可用于构建面向所有模板的一键集成流程:
  1. 查询 /api/v1/client/job/bytedance-templates
  2. 展示模板、封面、预览视频、支持的分辨率和积分消耗
  3. 使用选定的 TemplateId、图片数量要求和分辨率选项调用 bytedance/template

官方模板库

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

查询任务状态

提交任务后,使用统一查询接口检查进度并获取结果:

获取任务信息

了解如何查询任务状态并获取生成结果
在生产环境中,我们建议使用 callback_url 参数在生成完成时接收自动通知,而不是轮询状态接口。

相关资源

ByteDance 模板列表

查询所有可用的 ByteDance AI 特效模板,并支持一键模板集成。

模型概览

浏览 Crun 上所有可用的生成模型。

授权

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 已泄露,请立即在管理页面重置

请求体

application/json
model
enum<string>
必填

用于生成的模型名称,必填。

  • 此接口必须使用 bytedance/template
可用选项:
bytedance/template
input
object
必填

ByteDance AI 特效模板视频生成任务的输入参数。

callback_url
string<uri>

可选。用于接收任务完成通知的回调 URL。

  • 生成完成后,系统会向该 URL POST 任务状态和结果
  • 回调 payload 结构与任务状态查询接口返回的 data 对象一致
  • 您的回调接口应支持接收包含结果的 JSON POST 请求
  • 成功接收后应返回 HTTP 200 状态码
示例:

"https://your-domain.com/api/callback"

响应

请求成功

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