Files
AI-VideoAssistant/api/docs/index.md

1.2 KiB

API 文档索引

本文档描述 AI-VideoAssistant 项目的后端 API 接口规范。

目录

模块 文件 说明
小助手 assistant.md AI 助手管理
LLM 模型 llm.md LLM 模型配置与管理
ASR 模型 asr.md 语音识别模型配置
声音资源 voice-resources.md TTS 语音配置
工具与测试 tools.md 工具列表与自动测试
知识库 knowledge.md 知识库与文档管理
历史记录 history-records.md 通话记录和转写

基础信息

  • Base URL: http://localhost:8000/api/v1
  • 认证方式: Bearer Token (预留)
  • Content-Type: application/json

状态码说明

状态码 说明
200 成功
201 创建成功
400 请求参数错误
401 未认证
403 无权限
404 资源不存在
500 服务器错误

通用响应格式

成功响应

{
  "data": { ... }
}

错误响应

{
  "detail": "错误描述"
}

列表响应

{
  "total": 100,
  "page": 1,
  "limit": 20,
  "list": [ ... ]
}