Skip to content

Bytedance V1 Pro 文生视频 ​

本页由 ModelFold 文档站根据上游官方 OpenAPI 文档同步生成。接口路径、参数、示例与官方保持一致;品牌与 API 域名已替换为 ModelFold。

接口 ​

POST /jobs/createTask

完整 URL: https://ai.modelfold.online/v1/jobs/createTask

鉴权:所有请求都需要 Authorization: Bearer <API_KEY> 请求头。

查询任务状态 ​

提交任务后,可通过统一的查询接口查看任务进度并获取结果:

TIP

生产环境中,建议使用 callBackUrl 参数接收生成完成的自动通知,而非轮询状态接口。

相关资源 ​

请求参数 ​

请求体 (application/json) ​

参数类型必填说明
modelstring是用于生成任务的模型名称。必填字段。
- 该接口必须使用 bytedance/v1-pro-text-to-video 模型 默认值:"bytedance/v1-pro-text-to-video"。 可选值:bytedance/v1-pro-text-to-video。 示例:bytedance/v1-pro-text-to-video。
callBackUrlstring否接收生成任务完成通知的回调 URL。可选配置,生产环境建议使用。
- 任务生成完成后,系统会向该 URL 以 POST 方式推送任务状态和结果
- 回调内容包含生成内容的 URL 及任务相关信息
- 你的回调接口需支持接收 POST 请求及 JSON 格式的请求体
- 也可选择调用任务详情接口,主动轮询任务状态 示例:https://your-domain.com/api/callback。
inputobject否生成任务的输入参数
  input.promptstring是用于视频生成的文本提示词(最大长度:10000 字符) 示例:日落时分,一个卷头发、背着书包的男孩骑着自行车行驶在洒满金光的乡间小路上。<br>【切镜】他放慢车速,望向一片高高的草地。<br>【广角镜头】他的剪影停驻在橘色的薄雾中。。
  input.aspect_ratiostring否生成视频的宽高比 默认值:"16:9"。 可选值:21:9 / 16:9 / 4:3 / 1:1 / 3:4 / 9:16。 示例:16:9。
  input.resolutionstring否视频分辨率 - 480p 生成速度更快,720p 兼顾速度与画质,1080p 画质更高 默认值:"720p"。 可选值:480p / 720p / 1080p。 示例:720p。
  input.durationstring否视频时长(单位:秒) 默认值:"5"。 可选值:5 / 10。 示例:5。
  input.camera_fixedboolean否是否固定相机位置(布尔值(true/false)) 示例:false。
  input.seednumber否用于控制视频生成的随机种子值。设为 -1 时随机生成。(最小值:-1,最大值:2147483647,步长:1) 默认值:-1。 示例:-1。
  input.enable_safety_checkerboolean否Playground 环境下安全校验始终启用。仅可通过 API 将该参数设为 false 以关闭安全校验。(布尔值(true/false)) 示例:true。
  input.nsfw_checkerboolean否默认 false。为 false 时不额外进行内容过滤,结果由模型直接返回。

请求示例 ​

bash
curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
  -H "Authorization: Bearer $MODELFOLD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "bytedance/v1-pro-text-to-video",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "日落时分,一个卷头发、背着书包的男孩骑着自行车行驶在洒满金光的乡间小路上。\n【切镜】他放慢车速,望向一片高高的草地。\n【广角镜头】他的剪影停驻在橘色的薄雾中。",
    "aspect_ratio": "16:9",
    "resolution": "720p",
    "duration": "5",
    "camera_fixed": false,
    "seed": -1,
    "enable_safety_checker": true,
    "nsfw_checker": true
  }
}'
json
{
  "model": "bytedance/v1-pro-text-to-video",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "日落时分,一个卷头发、背着书包的男孩骑着自行车行驶在洒满金光的乡间小路上。\n【切镜】他放慢车速,望向一片高高的草地。\n【广角镜头】他的剪影停驻在橘色的薄雾中。",
    "aspect_ratio": "16:9",
    "resolution": "720p",
    "duration": "5",
    "camera_fixed": false,
    "seed": -1,
    "enable_safety_checker": true,
    "nsfw_checker": true
  }
}

响应 ​

200 — 请求成功 ​

参数类型必填说明
codeinteger是请求状态码。请求失败时 HTTP 状态仍为 200,请始终以本字段判断:200 表示成功,其他值均表示失败,原因见 msg。常见值:401 API key 无效或缺失;402 积分不足;429 超出频率限制;422 或 500 请求未能处理(请先查看 msg、检查参数,再决定是否重试)。 可选值:200 / 401 / 402 / 404 / 422 / 429 / 433 / 455 / 500 / 501 / 505。 示例:200。
msgstring是响应消息,失败时的错误描述
dataobject是—
  data.taskIdstring是可以使用任务 ID 与“获取任务详细信息”端点一起查询任务状态。
json
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "task_bytedance_1765186736545"
  }
}

回调 ​

videoTaskCompleted ​

回调地址:{request.body#/callBackUrl}(即请求体里的 callBackUrl)。

当 bytedance/v1-pro-text-to-video 任务成功或失败时,系统会发送此回调。

回调体参数

参数类型必填说明
codeinteger是统一回调状态码:成功为 200,失败为 501。 可选值:200 / 501。 示例:200。
msgstring是统一回调消息。 可选值:Playground task completed successfully. / Playground task failed.。 示例:Playground task completed successfully.。
dataobject是—
  data.taskIdstring是任务唯一标识符。
  data.modelstring是任务使用的模型。 可选值:bytedance/v1-pro-text-to-video。 示例:bytedance/v1-pro-text-to-video。
  data.statestring是任务最终状态。 可选值:success / fail。 示例:success。
  data.paramstring是包含已提交任务参数的 JSON 字符串。
  data.resultJsonstring否任务成功时,包含 resultUrls、firstFrameUrl、lastFrameUrl 或 resultObject 的 JSON 字符串。仅在 state 为 success 时出现。
  data.failCodestring否失败码,数字字符串,如 "400"、"500"。仅在 state 为 fail 时出现。
  data.failMsgstring否失败原因,仅在 state 为 fail 时出现。
  data.costTimeinteger否处理耗时(秒),成功和失败回调都会返回。
  data.completeTimeinteger否任务完成时间戳。
  data.createTimeinteger否任务创建时间戳。
  data.updateTimeinteger否完成时间请以 completeTime 为准;updateTime 可能与 createTime 相同。
  data.creditsConsumednumber否本任务消耗的积分;失败任务为 0。

任务成功完成

json
{
  "code": 200,
  "msg": "Playground task completed successfully.",
  "data": {
    "taskId": "task_example_video_webhook_001",
    "model": "bytedance/v1-pro-text-to-video",
    "state": "success",
    "param": "{\"input\":\"{\\\"prompt\\\":\\\"A boy with curly hair and a backpack rides a bike down a golden-lit rural road at sunset.\\\\n[Cut to] He slows down and ...\\\",\\\"aspect_ratio\\\":\\\"16:9\\\",\\\"resolution\\\":\\\"720p\\\",\\\"duration\\\":\\\"5\\\",\\\"camera_fixed\\\":false,\\\"seed\\\":-1,\\\"enable_safety_checker\\\":true,\\\"nsfw_checker\\\":false}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"bytedance/v1-pro-text-to-video\"}",
    "resultJson": "{\"resultUrls\":[\"https://example.com/generated-video.mp4\"]}",
    "costTime": 12,
    "completeTime": 1234567890,
    "createTime": 1234560000,
    "updateTime": 1234567890,
    "creditsConsumed": 1.23
  }
}

任务失败

json
{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "task_example_video_webhook_001",
    "model": "bytedance/v1-pro-text-to-video",
    "state": "fail",
    "param": "{\"input\":\"{\\\"prompt\\\":\\\"A boy with curly hair and a backpack rides a bike down a golden-lit rural road at sunset.\\\\n[Cut to] He slows down and ...\\\",\\\"aspect_ratio\\\":\\\"16:9\\\",\\\"resolution\\\":\\\"720p\\\",\\\"duration\\\":\\\"5\\\",\\\"camera_fixed\\\":false,\\\"seed\\\":-1,\\\"enable_safety_checker\\\":true,\\\"nsfw_checker\\\":false}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"bytedance/v1-pro-text-to-video\"}",
    "failCode": "400",
    "failMsg": "<error detail>",
    "costTime": 12,
    "creditsConsumed": 0
  }
}

ModelFold — 一个 API,接入所有主流 AI 模型。