搜索 VisionStory 开发者文档

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

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

VisionStory开发者

生成视频

POST/api/v1/video
快速开始

生成数字人视频,让数字人朗读通过文本转语音(text_script)或预录音频(audio_script)提供的脚本。生成异步执行,请轮询 GET /api/v1/video 查询状态。成片保留 7 天,请及时下载。

传入 client_request_id 可实现幂等重试,避免重复扣费。

请求头

X-API-Keystring必填

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

请求体

application/json必填
aspect_ratiostring

渲染视频的输出宽高比,默认 9:16

可选值: 9:1616:91:1

默认值: 9:16

audio_scriptAudioScript | null可为空

用于驱动数字人的预录旁白音频。audio_scripttext_script 二选一。

audio_urlstring | null可为空

用于驱动数字人的旁白音频的公开可访问 URL。此字段与 inline_data 二选一。

denoiseboolean

设为 true 时,在生成前对上传的音频降噪。

默认值: false

inline_dataInlineDataModel | null可为空

以内嵌 base64 数据提供的旁白音频。此字段与 audio_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']。

voice_changeboolean

设为 true 时,使用 voice_id 指定的声音重新合成上传的音频(声音转换),同时保留原始时间节奏。

默认值: false

voice_idstring | null可为空

voice_change 为 true 时用于声音转换的目标声音。请使用 GET /api/v1/voices 返回的 ID。

avatar_idstring必填

朗读脚本的数字人。请使用 GET /api/v1/avatars 返回的 ID,可选择公共或自己创建的数字人。

background_colorstring

可选的纯色背景,使用 6 位十六进制颜色值,例如 #00b140。留空时保留数字人的原始背景;设置后使用该颜色作为背景,便于色键抠像。

默认值:

client_request_idstring | null可为空

可选的幂等键。24 小时内使用相同值重复提交,会返回原任务,不会创建新任务或再次扣费,可用于安全重试。

emotionstring

数字人表现的情绪,默认 cheerful

可选值: cheerfulangrymarketingnewssinging

默认值: cheerful

model_idstring

使用的渲染模型,请查询 GET /api/v1/models。默认 vs_character_v4

默认值: vs_character_v4

resolutionstring

输出分辨率:720p1080p2k,默认 720p。分辨率越高,消耗的点数越多,渲染时间也越长。

可选值: 720p1080p2k

默认值: 720p

text_scriptTextScript | null可为空

文本转语音脚本,包含文本和声音。text_scriptaudio_script 二选一。

speech_ratestring | null可为空

合成声音的语速,默认 normal

可选值: slownormalfast

默认值: normal

textstring必填

要朗读的脚本,将使用所选声音转换为语音。

voice_idstring必填

用于合成脚本的声音。请使用 GET /api/v1/voices 返回的 ID,可选择公共声音或自己克隆的声音。

响应

200请求成功

application/json

dataCreateVideoResponse | null必填可为空

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

video_idstring必填

新建视频任务的标识符。使用此 ID 轮询 GET /api/v1/video 以查询进度。

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

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