Skip to main content
POST
视频生成是异步任务。提交后立即返回 task_id,再通过 任务查询 轮询结果;也可传入 callback_url 由上游推送(见下文)。
Base URL 固定为 https://gogogotoken.ai。本文档即 Seedance 官方用法(2.0 / 2.5)。价目与能力差异见 视频模型列表。
超时重试 / 响应丢失:提交时建议带 Idempotency-Key(见下文);也可保存响应头 X-Oneapi-Request-Id,用 按 request_id 找回 查回 task_id。二者均约 24 小时有效,且不会重复预扣。

推荐模型

按实际生成量计费,提交时预扣,完成后按真实用量结算。价目分档见 视频模型列表。

图生视频两种方式

方式 1 · 公网 HTTPS 图片 在请求体中传入 images 数组,或使用 metadata.content[] 指定首帧。 方式 2 · 已上传素材 先通过 素材管理 登记图片,得到 asset://asset_xxx,在 metadata.content 中引用。
asset:// 图生要求素材与推理接入点在同一 BytePlus 项目。若报 asset not found,可先用公网 HTTPS 图片链接代替。

metadata.content 中的 role

若同时传 images[] 与 metadata.content,平台以 metadata.content 为准(images[] 不会保留)。2.5 素材上限约图片 ≤30 / 视频 ≤10 / 音频 ≤10(合计 ≤50)。首尾帧 / 编辑 / 延长建议 ratio=adaptive;编辑类常需 duration=-1——各任务类型的强制参数限制见 任务类型与参数限制。

字段映射(服务端自动完成)

你只需按下表字段提交;平台会自动转换为上游 ARK / BytePlus 请求体:

样片模式(Draft,仅 Seedance 2.5)

样片模式是「先出低分辨率样片验证效果,再生成高质量成片」的两步式生视频。先生成一段 480p 样片确认场景、镜头、动作、提示词意图,满意后基于样片任务 ID 出 1080p 成片。仅 seedance-2-5 支持。
1

生成 480p 样片

在 metadata 中加 draft: true,分辨率仅支持 480p(不传默认 480p,传其他分辨率返回 400)。其余参数(提示词、参考素材、时长、宽高比、seed、音频等)与普通生成一致。提交响应里的 task_id 即样片任务 ID,下一步要用它。
提交响应中的 task_id 就是样片任务 ID,记下它:
480p 样片的 token 用量与单价,与普通 480p 生成完全一致。先按 任务查询 轮询这个 task_id,等状态变 succeeded、预览样片满意后再进行第二步。
2

基于样片出 1080p 成片

把上一步的 task_id 原样填进 draft_task.id;metadata.content 只放这一个 draft_task 引用,分辨率仅支持 1080p(不传默认 1080p)。
成片按 1080p 正常视频计费;轮询与下载与普通任务一致,见 任务查询。
基于样片出成片时,禁止再传 prompt、参考图/视频/音频、duration、ratio(metadata.ratio)、seed、generate_audio、omni_reference_task_type —— 这些会自动复用样片阶段的取值,传了会在提交时返回 400。只有 output_format、watermark 等可重新指定。
  • 样片任务 ID 有效期 7 天(自创建起算),过期无法出片。
  • 只能引用同一账户下创建的样片任务(同账户的任意 API Key 均可)。
  • draft: true 与 draft_task 不能在同一请求中同时出现。

OpenAI 兼容格式(可选)

参数与 /v1/video/generations 相同。

任务回调(可选,依赖渠道支持)

提交时传入顶层 callback_url,任务状态变化(完成 / 失败)时上游平台会向该地址发起 HTTP POST 回调,免去轮询:
提交时指定回调地址
回调能力并非每个渠道都有(取决于任务实际路由的上游渠道)。不支持的渠道会忽略该字段——任务正常提交,但不会收到回调。具体适配的渠道请咨询客服;无论是否配置回调,都建议保留任务查询作为兜底。
  • callback_url 必须是公网可访问的地址(由上游平台直接调用),并正常返回 2xx 响应。
  • 回调体为该任务的最新状态与结果,字段结构与 任务查询 响应一致(含 status、视频 URL、usage)。回调由上游直接发送到你的服务器,不经过平台转发;推送体中的 id 是上游任务 ID,与提交响应中的 task_id 是同一任务。如需校验真伪,可用提交响应的 task_id 调 任务查询 交叉核对状态。
  • 回调与轮询可以混用,互不影响。
  • 计费在提交时预扣、完成时结算,与是否配置回调无关。

幂等提交(推荐)

客户端网络抖动或超时重试时,同一业务单号可能多次 POST。请在请求头携带稳定业务键: 重放成功时响应头含:
  • X-Idempotency-Replayed: true
  • X-Idempotency-Original-Request-Id:首次创建时的网关 request id(若有)
请同时保存响应头中的 X-Oneapi-Request-Id。若客户端超时未读到 body,可用该值做 按 request_id 找回。
仅创建成功并已落库 task_id 的请求可被重放或找回。无 task_id 的失败响应不要当成排队成功;换键重试前请确认业务是否应新建任务。

参数说明

string
required
API Key 鉴权信息,格式为 Bearer YOUR_API_KEY。
string
required
固定为 application/json。
string
可选。客户端幂等键;亦可用 X-Idempotency-Key。同用户同键约 24 小时内重放原 task_id,不重复扣费。详见上文「幂等提交」。
string
required
视频模型 ID:seedance-2-5、seedance-2-0、seedance-2-0-fast 或 seedance-2-0-mini(fast / mini 最高 720p;2.5 支持到 1080p,不含 4k)。
string
required
视频描述文本。
string
时长(秒),常用 "5";也可 "-1"(智能时长)。优先于顶层 duration。2.5 合法范围 4–30 或 -1。
number
时长整数,兼容 OpenAI Video 客户端。若同时传 seconds,以 seconds 为准;支持 -1。
string[]
图生视频时的参考图片 URL 列表(公网 HTTPS)。2.0「含媒体输入」档;2.5 仅含视频文件才走有视频输入低价档。
string
分辨率:480p、720p、1080p、4k。4k 仅 seedance-2-0;fast 最高 720p;2.5 支持 480p / 720p / 1080p(不含 4k)。也可通过 size 传相同枚举值。
string
与 metadata.resolution 等价的官方枚举;不支持像素串。
string
画幅比例,如 9:16、16:9、adaptive。
string
仅 Seedance 2.5:输出封装 mp4(默认)或 mov。
string
仅 Seedance 2.5:全模态参考任务的子类型引导,可选 auto(默认,按素材 + 提示词自动判定)、reference(参考生视频,ratio / duration 无特殊限制)、edit(视频编辑,要求 content 含 reference_video、ratio=adaptive、duration=-1)、extend(视频延长,要求 content 含 reference_video、ratio=adaptive)。显式指定可在提交时前置校验参数,减少任务创建后的异步报错(InvalidParameter.TaskTypeConstraint)。
boolean
仅 Seedance 2.5:true 开启样片模式 Step1(仅 480p)。
object
仅 Seedance 2.5:样片模式 Step2 引用样片任务 ID(仅 1080p),如 { "type": "draft_task", "draft_task": { "id": "task_xxx" } };平台自动换算为上游任务号。
array
高级图生/参考内容,可指定 first_frame、参考视频/音频与 asset:// 引用。
string
可选。任务完成 / 失败时上游平台向该公网地址 POST 回调任务结果,可替代轮询。并非每个渠道都支持(不支持的渠道会忽略该字段),具体适配的渠道请咨询客服。

响应体

string
视频生成任务 ID。
string
视频生成任务 ID,与 id 相同;后续轮询与样片模式引用均使用该值。
string
任务状态,提交成功时为 queued。
string
本次任务使用的模型 ID。

下一步

提交成功后,使用返回的 task_id 调用 任务查询与轮询。建议每 5–8 秒轮询一次,通常 30–120 秒出片。