diff --git a/README-en.md b/README-en.md
index ff714c0..79b0089 100644
--- a/README-en.md
+++ b/README-en.md
@@ -8,7 +8,7 @@
-English | [简体中文](README.md)
+English | [简体中文](README.md)
> Thanks to [RootFTW](https://github.com/Root-FTW) for the translation
@@ -34,7 +34,8 @@ https://reccloud.com
## Features 🎯
-- [x] Complete **MVC architecture**, **clearly structured** code, easy to maintain, supports both API and Web interface
+- [x] Complete **MVC architecture**, **clearly structured** code, easy to maintain, supports both `API`
+ and `Web interface`
- [x] Supports **AI-generated** video copy, as well as **customized copy**
- [x] Supports various **high-definition video** sizes
- [x] Portrait 9:16, `1080x1920`
diff --git a/README.md b/README.md
index 8a70a35..fda71b2 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
-[English](README-en.md) | 简体中文
+[English](README-en.md) | 简体中文
只需提供一个视频 **主题** 或 **关键词** ,就可以全自动生成视频文案、视频素材、视频字幕、视频背景音乐,然后合成一个高清的短视频。
@@ -29,7 +29,7 @@
## 功能特性 🎯
-- [x] 完整的 **MVC架构**,代码 **结构清晰**,易于维护,支持API和Web界面
+- [x] 完整的 **MVC架构**,代码 **结构清晰**,易于维护,支持 `API` 和 `Web界面`
- [x] 支持视频文案 **AI自动生成**,也可以**自定义文案**
- [x] 支持多种 **高清视频** 尺寸
- [x] 竖屏 9:16,`1080x1920`
@@ -188,7 +188,7 @@ sh webui.sh
python main.py
```
-启动后,可以查看 `API文档` http://127.0.0.1:8080/docs 直接在线调试接口,快速体验。
+启动后,可以查看 `API文档` http://127.0.0.1:8080/docs 或者 http://127.0.0.1:8080/redoc 直接在线调试接口,快速体验。
效果如下图:

diff --git a/app/models/schema.py b/app/models/schema.py
index a4170b9..b686000 100644
--- a/app/models/schema.py
+++ b/app/models/schema.py
@@ -139,6 +139,30 @@ class TaskResponse(BaseResponse):
data: TaskResponseData
+ class Config:
+ json_schema_extra = {
+ "example": {
+ "status": 200,
+ "message": "success",
+ "data": {
+ "task_id": "6c85c8cc-a77a-42b9-bc30-947815aa0558"
+ }
+ },
+ }
+
class TaskQueryResponse(BaseResponse):
- pass
+ class Config:
+ json_schema_extra = {
+ "example": {
+ "status": 200,
+ "message": "success",
+ "data": {
+ "state": 1,
+ "progress": 100,
+ "videos": [
+ "http://127.0.0.1:8080/tasks/6c85c8cc-a77a-42b9-bc30-947815aa0558/final-1.mp4"
+ ]
+ }
+ },
+ }
diff --git a/docs/api.jpg b/docs/api.jpg
index 6ee51d2..e9a4122 100644
Binary files a/docs/api.jpg and b/docs/api.jpg differ