更新接口文档

main
fanpt 9 months ago
parent f41887be1b
commit 9373cba5ab

@ -1,11 +1,10 @@
---
## 视频生成接口文档
### 基本信息
- **接口地址:** `http://192.168.10.70:6711/`
- **接口地址:** `http://192.168.10.70:8000/`
- **API 版本:** 1.0
### 生成动态视频
@ -22,8 +21,10 @@
#### 响应
- **成功:** 返回生成的视频文件。
- **失败:** 返回错误信息。
| 字段 | 类型 | 描述 |
| ---- | ---- | ---- |
| message | string | 视频正在生成,请稍后。 |
| uid | string | 任务的唯一标识符。 |
### 生成静态视频
@ -39,12 +40,36 @@
#### 响应
- **成功:** 返回生成的视频文件。
- **失败:** 返回错误信息。
| 字段 | 类型 | 描述 |
| ---- | ---- | ---- |
| message | string | 视频正在生成,请稍后。 |
| uid | string | 任务的唯一标识符。 |
### 查询任务状态
- **路径:** `/status/{uid}`
- **请求方法:** `GET`
- **描述:** 通过任务的唯一标识符查询任务的状态和结果。
#### 请求参数
| 参数名 | 类型 | 描述 |
| ------ | ---- | ---- |
| uid | string | 必填。任务的唯一标识符。 |
#### 响应
| 字段 | 类型 | 描述 |
| ---- | ---- | ---- |
| status | string | 任务的状态processing, completed, failed。 |
| video_path | string | (仅在任务完成时返回)生成的视频文件路径。 |
| message | string | (仅在任务失败时返回)失败原因。 |
### 注意事项
- 如果上传相同的图片,系统会检查之前是否已经生成了对应的视频,如果已生成则直接返回之前的视频,无需重新生成。
- 如果上传相同的图片,系统会检查之前是否已经生成了对应的视频如果已生成则直接返回之前的视频,无需重新生成。
- 每次上传的图片都会被记录下来,以及对应的生成视频路径,以便下次上传同一张图片时可以直接返回之前的视频。
- 通过 `uid` 查询任务状态时,如果任务正在处理会返回状态 `processing`,如果生成成功会返回生成的视频文件,如果生成失败会返回失败原因。
---

Loading…
Cancel
Save