搜索 VisionStory 开发者文档

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

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

VisionStory开发者

列出视频

GET/api/v1/videos
快速开始

列出最近的视频,最多 100 个,按时间从新到旧排列。不分页,适合快速查看最近的生成记录。

请求头

X-API-Keystring必填

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

响应

200请求成功

application/json

dataGetVideosResponse | null必填可为空

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

videosVideoDto[]必填

账户最近的视频,按时间从新到旧排列,最多 100 个,不分页。

aspect_ratiostring

渲染后视频的输出宽高比。

可选值: 9:1616:91:1

默认值: 9:16

cost_creditinteger

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

默认值: 0

created_atinteger必填

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

model_idstring必填

生成此视频的模型标识符,请查询 GET /api/v1/models。

resolutionstring

渲染后视频的输出分辨率。

可选值: 480p720p1080p2k

默认值: 480p

statusstring必填

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

video_idstring必填

视频任务的唯一标识符,用于轮询状态或删除视频。

video_urlstring | null可为空

成片下载 URL;状态为 created 前为空。视频保留 7 天。

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必填

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