zhAPI 接口文档视频系列POST视频生成与查询
视频系列POST提交生成任务
API 接口文档

视频生成

POSThttps://api.tokenbay.com/v1/videos

异步视频生成:提交任务、轮询状态、下载结果

一个 OpenAI 风格的统一入口承载多个视频模型族(HappyHorse、Veo 3.1、Seedance)。请求体中的 model 字段决定路由到哪个模型,其余字段因模型而异。

成功与业务失败均返回 HTTP 200。成功响应的任务字段平铺在 JSON 顶层(无 data 包装);失败响应携带 error 对象({ message, type, code })。

视频路由默认禁用 failover 重试,因为任务创建非幂等。

提交生成任务

openaiFailover: disabled

校验 Authorization 头后,按请求体中的 model 字段路由到对应模型。

任务创建非幂等,视频路由禁用 failover 重试。

POST/v1/videos兼容别名POST/v1/video/generations

请求

字段

通用顶层字段。完整字段集按模型族定义——见 HappyHorse、Veo 3.1、Seedance 各页。

modelstringRequired

视频模型 ID,决定路由到哪个模型以及任务类型。已收录的模型族:HappyHorse、Veo 3.1、Seedance——完整参数见各模型页。

promptstringRequired

视频描述提示词。长度限制与语言建议因模型而异。

image / images / input_reference / last_frame_image / reference_imagesstring | array<string>Optional

图生视频、首尾帧、参考图等图像输入。字段名与数量限制因模型而异,见各模型页。

duration / secondsinteger | stringOptional

视频时长(秒)。支持档位与默认值因模型而异。

resolution / sizestringOptional

分辨率档位,如 720p、1080p。可选值因模型而异。

aspect_ratiostringOptional

宽高比,如 16:9、9:16。HappyHorse 与 Seedance 的比例参数放在 metadata.ratio 中。

negative_promptstringOptional

负向提示词;支持情况由模型决定。

seedintegerOptional

随机种子,尽力保证可复现。

generate_audiobooleanOptional

是否生成音频;仅支持该能力的模型生效。

metadataobjectOptional

厂商特有参数容器。可用键按模型族定义,见各模型页。

响应

字段

提交回执,字段平铺在 JSON 顶层。

idstringOptional

任务 ID(task_xxx)。与 task_id 相同,供 OpenAI SDK 兼容使用。

task_idstringOptional

任务 ID,用于后续轮询与下载。

objectstringOptional

固定值 video。

modelstringOptional

请求中传入的模型名。

statusstringOptional

提交后初始状态,通常为 QUEUED。

SUBMITTEDQUEUEDIN_PROGRESSSUCCESSFAILURE
progressintegerOptional

进度 0–100,刚提交时通常为 0。

created_atintegerOptional

任务创建时间(秒级时间戳)。

鉴权只通过 Authorization: Bearer sk-xxx 请求头完成,请勿在请求体中携带 API Key。

通过响应体中是否存在 error 字段区分成功与失败——HTTP 状态码始终是 200。

查询任务详情

GET/v1/videos/{task_id}兼容别名GET/v1/video/generations/{task_id}

响应

字段

任务详情,字段平铺在 JSON 顶层。

task_idstringOptional

任务 ID。

actionstringOptional

任务动作,如 generate。

statusstringOptional

任务状态。SUCCESS 与 FAILURE 为终态。

SUBMITTEDQUEUEDIN_PROGRESSSUCCESSFAILURE
progressstringOptional

进度百分比字符串,如 "50%"。

result_urlstringOptional

结果视频下载地址,仅 status 为 SUCCESS 时返回。形如 /v1/videos/{task_id}/content。

fail_reasonstringOptional

失败原因,仅 status 为 FAILURE 时返回。

quotaintegerOptional

本次任务消耗的配额,结算后填充。

submit_time / start_time / finish_timeintegerOptional

任务提交、开始执行、完成时间(秒级时间戳)。

created_at / updated_atintegerOptional

记录创建与最后更新时间(秒级时间戳)。

errorobjectOptional

任务级错误详情,任务失败时返回。

error.messagestringOptional

错误信息。

error.codestringOptional

错误码。

状态生命周期:SUBMITTED → QUEUED → IN_PROGRESS → SUCCESS / FAILURE。SUCCESS 与 FAILURE 为终态。

建议每 10–15 秒轮询一次,不要低于 5 秒。总超时建议:生成类任务 5 分钟,视频编辑 8–10 分钟。

任务 FAILURE 时,请读取 fail_reason(以及 error 对象,若返回)了解失败原因。

下载结果

GET/v1/videos/{task_id}/content

响应

二进制

video/mp4 字节流。

查询接口返回的 result_url 就是这个地址,两种方式等价。

支持 Range 请求(HTTP 206),可断点续传,也可在播放器中拖拽播放。

相关页面