Api
API 总览
Vidrush v1 媒体 API 的基础 URL、认证、响应信封、任务生命周期和 HTTP 语义。
基础 URL
https://vidrush-ai.com| 方法 | 端点 | 认证 | 用途 |
|---|---|---|---|
GET | /api/v1/models | 否 | 模型目录和定价;?type=video(默认)、image 或 music |
GET | /api/v1/voices | Bearer key | 文本转语音音色目录 |
POST | /api/v1/videos | Bearer key | 创建会消耗积分的视频任务 |
POST | /api/v1/images | Bearer key | 创建图片任务 |
POST | /api/v1/music | Bearer key | 创建音乐任务 |
POST | /api/v1/speech | Bearer key | 文本转语音 |
POST | /api/v1/sound-effects | Bearer key | 生成音效 |
GET | /api/v1/tasks/{taskId} | Bearer key | 查询任务状态和结果 URL(所有媒体类型) |
GET | /api/v1/credits | Bearer key | 查询剩余积分 |
已认证请求使用 Authorization: Bearer sk-...。参见认证。
响应信封
每个 v1 响应都是如下 JSON 信封:
{
"code": 0,
"message": "ok",
"data": {}
}用 HTTP 状态码处理传输层结果,用 code 判断业务结果。
| HTTP 状态码 | code | 含义 |
|---|---|---|
200 | 0 | 请求成功 |
400 | -1 | 请求、模型、选项无效,或被内容审核拦截 |
401 | -1001 | API key 缺失或无效 |
402 | -1002 | 积分不足 |
404 | -1 | 任务不存在,或当前 key 无权访问 |
500 | -1 | 内部服务器错误 |
任务生命周期
视频和图片创建是异步的——创建后每 5 秒轮询一次 GET /api/v1/tasks/{taskId}。音乐和音频为同步生成,通常在创建响应中直接返回 success 及 data.taskUrls 结果 URL;同一 taskId 仍可通过任务端点查询,以保持统一流程。
| 状态 | 操作 |
|---|---|
pending | 继续轮询 |
processing | 继续轮询 |
success | 从 data.taskUrls 读取生成视频 URL |
failed | 停止轮询并报告任务失败 |
canceled | 停止轮询并报告任务已取消 |