搜索 VisionStory 开发者文档

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

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

VisionStory开发者

列出数字人

GET/api/v1/avatars
数字人形象

按创建时间从新到旧,查询自己的数字人或公共数字人库(is_public=true)。分页时,将上一页的 next_cursor 传入;next_cursor=0 表示没有下一页。

请求头

X-API-Keystring必填

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

查询参数

is_publicboolean

false 查询自己的数字人并返回取景信息;true 改为查询公共数字人库。

默认值: false

cursorinteger

上一页返回的分页游标 next_cursor。首页可省略或传入 0。

默认值: 0

limitinteger

每页最多返回的数字人数量,范围为 1–100,默认值为 20。

默认值: 20

响应

200请求成功

application/json

dataGetAvatarsResponse | null必填可为空

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

avatarsAvatarDto[]必填

本页按创建时间从新到旧排列的数字人:自己的数字人;请求设置 is_public=true 时则为公共数字人库。

aspect_ratiosstring[]

此数字人已适配的宽高比(1:1 / 9:16 / 16:9)。生成视频时请选择匹配的 aspect_ratio。

avatar_idstring必填

数字人的唯一标识符。生成数字人视频时,将其作为 avatar_id 传入。

created_atinteger

数字人创建时的 Unix 时间戳,单位为秒。

默认值: 0

default_voice_idstring

数字人预设的声音。文本脚本中必须提供 voice_id;如需使用数字人自身的声音,请复制此值,不要猜测。未预设声音的数字人可能返回空值。

默认值:

framingAvatarFraming[] | null可为空

各画幅的当前取景,始终按 9:16、16:9、1:1 的顺序返回 3 项。新数字人会自动设置取景,可通过 POST /api/v1/avatar/framing 调整,并与网页编辑器共享。公共数字人始终返回 null,且不能通过 API 调整取景。

aspect_ratiostring必填

此取景适用的画幅。

可选值: 9:1616:91:1

image_urlstring | null可为空

当前在此画幅生成视频时使用的参考图片 URL。

offset_xnumber | null可为空

取景区域在可水平移动范围内的位置,取值为 -1 到 1:-1 紧贴左边缘,0 居中,1 紧贴右边缘。取景区域已覆盖完整宽度时,此值不生效;zoom 为 null 时,此值也为 null。

offset_ynumber | null可为空

取景区域在可垂直移动范围内的位置,取值为 -1 到 1:-1 紧贴上边缘,0 居中,1 紧贴下边缘。取景区域已覆盖完整高度时,此值不生效;zoom 为 null 时,此值也为 null。

zoomnumber | null可为空

缩放级别,最小为 1。1 表示源图中能够容纳此画幅的最大区域,即最宽取景(例如全身);2 会将取景宽度和高度各缩小一半,使人物看起来放大一倍。启用取景功能前创建的数字人返回 null。

thumbnail_urlstring必填

数字人预览缩略图的 URL。

next_cursorinteger

下一页游标,请将其作为 cursor 传回。0 表示没有下一页。

默认值: 0

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

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