搜索 VisionStory 开发者文档

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

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

VisionStory开发者

创建数字人

POST/api/v1/avatar
数字人形象

使用单张肖像创建自定义数字人,支持 JPEG/PNG/WEBP/HEIC,文件不超过 10MB。之后可通过 POST /api/v1/video,使用返回的 avatar_id 让数字人朗读任意脚本。

请求头

X-API-Keystring必填

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

请求体

application/json必填
img_urlstring | null可为空

源图像的公开可访问 URL。此字段与 inline_data 二选一。支持 JPEG/PNG/WEBP/HEIC,文件不超过 10MB。

inline_dataInlineDataModel | null可为空

以内嵌 base64 数据提供的源图像。此字段与 img_url 二选一。

datastring必填

文件原始字节编码后的 base64 字符串,不包含 data: URI 前缀。

mime_typestring必填

内嵌数据的 MIME 类型,网关据此区分图像、音频和视频。可接受的类型取决于具体接口,请参阅包含此对象的字段说明。数字人视频接受音频 ['audio/avi', 'audio/mpeg', 'audio/mp3', 'audio/mp4', 'audio/m4a', 'audio/wav'] 和图像 ['image/jpeg', 'image/jpg', 'image/png', 'image/webp', 'image/heic']。

响应

200请求成功

application/json

dataCreateAvatarResponse | null必填可为空

返回已创建的数字人数据。

aspect_ratiosstring[]

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

avatar_idstring必填

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

created_atinteger

数字人创建时的 Unix 时间戳,单位为秒;公共或平台数字人为 0。

默认值: 0

default_voice_idstring

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

默认值:

thumbnail_urlstring必填

数字人预览缩略图的 URL。

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

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