搜索 VisionStory 开发者文档

没有找到匹配的文档“”。

可以尝试功能或资源名称,例如

VisionStory开发者

获取 AI 视频状态

GET/api/v1/ai_video
AI 视频

通过 video_id 查询单个任务,或通过 video_ids(逗号分隔)一次查询最多 20 个任务。状态为 queuedcreatingcreatedfailed,建议每 5–10 秒轮询一次。失败任务包含 error 对象,且 cost_credit=0(点数自动退还)。

Beta:所有有效付费订阅账户均可使用,适用标准的单 API Key 请求频率限制。

请求头

X-API-Keystring必填

你的 VisionStory API Key(sk-vs-...),请仅保存在服务端。可在 API Key 管理 中创建或管理,需要 Pro 或更高方案。

查询参数

video_idstring | null

要查询的单个任务 ID,来自 POST /api/v1/ai_video。video_idvideo_ids 二选一。

video_idsstring | null

批量查询的任务 ID,以逗号分隔,最多 20 个,例如 101,102,103video_idsvideo_id 二选一。

响应

200请求成功

application/json

dataGetAiVideoResponse | GetAiVideosBatchResponse | null必填可为空

当前接口的响应数据,字段定义见该接口的响应结构。仅当操作不返回数据时为 null。

aspect_ratiostring

生成视频的输出宽高比(例如 16:99:16);尚未确定时为空。

默认值:

cost_creditinteger

此任务扣除的点数;失败时为 0,已扣点数会自动退还。

默认值: 0

cover_urlstring | null可为空

视频封面或缩略图的 URL,有可用封面时返回。

created_atinteger

任务创建时的 Unix 时间戳,单位为秒。

默认值: 0

duration_secnumber

生成视频的时长,单位为秒;尚未确定时为 0。

默认值: 0

errorAiVideoErrorDto | null可为空

失败详情,仅在状态为 failed 时返回。

codeinteger必填

表示生成失败原因的数字错误码。

messagestring必填

便于阅读的失败原因说明。

model_idstring必填

生成此视频所用的模型,请查询 GET /api/v1/ai_video/models。

resolutionstring

生成视频的输出分辨率(例如 720p1080p);尚未确定时为空。

默认值:

statusstring必填

当前任务状态:queued(等待中)、creating(渲染中)、created(已完成)或 failed(失败)。

video_idstring必填

视频任务的唯一标识符。

video_urlstring | null可为空

生成视频的下载 URL,状态为 created 时返回。

messagestring

便于阅读的状态消息;调用成功时为 "success"

默认值: success

server_timestring · date-time必填

服务端生成响应时的时间戳,使用 ISO 8601 格式(UTC)。

default错误响应。所有失败均使用统一结构:error 对象包含数字错误码 code、便于阅读的 message、可选的 details 字符串,以及提供后续处理建议的可选 hint(便于 AI Agent 使用)。

application/json

errorErrorDetail必填
codeinteger必填

机器可读的错误码。传输层失败时对应 HTTP 状态码(例如 401、404、422、500),其他情况可能使用业务专用错误码。

detailsstring | null可为空

可选的结构化错误详情,例如 422 响应中逐字段校验错误的 JSON 字符串。无补充信息时不返回。

hintstring | null可为空

供用户和 AI Agent 参考的错误处理建议,例如如何修正请求或在哪里获取 API Key。可能不返回此字段。

messagestring必填

便于阅读的错误原因说明,可安全记录到日志或展示给最终用户;此返回值未本地化。