API 文档

返回主页 常见问题

邀请码验证

GET
/api/invitation/check/{invite_code}

验证邀请码的有效性和剩余时长

参数

参数 类型 位置 描述
invite_code string 路径 邀请码字符串

响应示例

{
  "invite_code": "ABC123",
  "available_minutes": 120,
  "valid": true
}

系统状态

GET
/api/status

获取系统当前状态和队列信息

响应示例

{
  "busy": false,
  "queue_length": 2,
  "whisper_available": true
}
GET
/api/whisper/health

检查Whisper服务健康状态

响应示例

{
  "available": true
}

单文件处理

POST
/api/process/srt/{invite_code}

处理单个视频文件，生成SRT字幕文件

参数

参数 类型 位置 描述
invite_code string 路径 有效的邀请码
file file 表单 视频文件
POST
/api/process/video/{invite_code}

处理单个视频文件，生成带字幕的视频

响应示例

{
  "task_id": "task_abc123",
  "duration": 5.2,
  "message": "任务已创建"
}

批量处理

POST
/api/batch/process/{invite_code}

批量处理多个视频文件

参数

参数 类型 位置 描述
invite_code string 路径 有效的邀请码
files file[] 表单 多个视频文件
mode string 表单 处理模式: "srt" 或 "video"

响应示例

{
  "batch_id": "batch_xyz789",
  "file_count": 3,
  "message": "批量任务已创建"
}

任务查询

GET
/api/task/{task_id}

查询单个任务状态

响应示例

{
  "task_id": "task_abc123",
  "status": "completed",
  "progress": "处理完成",
  "filename": "output_video.mp4",
  "mode": "video"
}
GET
/api/batch/{batch_id}

查询批量任务状态

响应示例

{
  "batch_id": "batch_xyz789",
  "status": "processing",
  "task_ids": ["task_1", "task_2", "task_3"],
  "tasks": {
    "task_1": {"status": "completed"},
    "task_2": {"status": "processing"},
    "task_3": {"status": "pending"}
  }
}

文件下载

GET
/api/download/srt/{filename}

下载SRT字幕文件

GET
/api/download/video/{filename}

下载带字幕的视频文件

GET
/api/batch/download/{batch_id}

下载批量任务的压缩包

配置管理

GET
/api/tranpy/config-ollama-api/{api_url}

配置Ollama API地址

GET
/api/tranpy/config-ollama-model/{model_name}

配置Ollama模型名称

GET
/api/tranpy/config

获取当前配置信息

响应示例

{
  "ollama_api": "http://localhost:11434",
  "ollama_model": "llama2"
}

管理功能

POST
/api/administrator/delete_all_cache

清除所有缓存文件（管理员功能）

响应示例

{
  "message": "所有缓存已清除",
  "deleted_files": 15
}