You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
SadTalker/SadTalker_API.md

88 lines
2.7 KiB
Markdown

---
## 视频生成接口文档
### 基本信息
- **接口地址:** `http://192.168.10.70:6711/`
- **API 版本:** 1.0
### 生成动态视频
- **路径:** `/dynamic-video`
- **请求方法:** `POST`
- **描述:** 上传一张图片,生成带有动态效果的视频。
#### 请求参数
| 参数名 | 类型 | 描述 |
| ------ | ---- | ---- |
| image | File | 必填。要上传的图片文件。 |
#### 响应
| 字段名 | 类型 | 描述 |
| ------ | ---- | ---- |
| code | int | 响应状态码。200 表示成功500 表示失败。 |
| message | string | 状态消息,表示视频正在生成或其他信息。 |
| uid | string | 唯一任务标识符,可用于查询任务状态。 |
| video | string | 视频的 Base64 编码(任务完成时返回)。 |
- **成功:** 返回任务状态信息,包括唯一任务标识符 `uid`
- **失败:** 返回错误信息。
### 生成静态视频
- **路径:** `/silent-video`
- **请求方法:** `POST`
- **描述:** 上传一张图片,生成无声的视频。
#### 请求参数
| 参数名 | 类型 | 描述 |
| ------ | ---- | ---- |
| image | File | 必填。要上传的图片文件。 |
#### 响应
| 字段名 | 类型 | 描述 |
| ------ | ---- | ---- |
| code | int | 响应状态码。200 表示成功500 表示失败。 |
| message | string | 状态消息,表示视频正在生成或其他信息。 |
| uid | string | 唯一任务标识符,可用于查询任务状态。 |
| video | string | 视频的 Base64 编码(任务完成时返回)。 |
- **成功:** 返回任务状态信息,包括唯一任务标识符 `uid`
- **失败:** 返回错误信息。
### 查询任务状态
- **路径:** `/status/{uid}`
- **请求方法:** `GET`
- **描述:** 通过唯一任务标识符 `uid` 查询任务状态。
#### 请求参数
| 参数名 | 类型 | 描述 |
| ------ | ---- | ---- |
| uid | string | 必填。唯一任务标识符。 |
#### 响应
| 字段名 | 类型 | 描述 |
| ------ | ---- | ---- |
| code | int | 响应状态码。200 表示成功500 表示失败。 |
| status | string | 任务状态processing、completed、failed。 |
| message | string | 错误信息(任务失败时返回)。 |
| video | string | 视频的 Base64 编码(任务完成时返回)。 |
- **成功:** 返回任务状态信息,任务完成时返回生成的视频文件。
- **失败:** 返回错误信息。
### 注意事项
- 如果上传相同的图片,系统会检查之前是否已经生成了对应的视频,如果已生成则直接返回之前的视频,无需重新生成。
- 每次上传的图片都会被记录下来,以及对应的生成视频路径,以便下次上传同一张图片时可以直接返回之前的视频。
---