REST API

概述

OpenVort 提供基于 FastAPI 的 REST API，支持 JWT 认证。所有 API 均以 /api 为前缀。

认证

获取 Token

POST /api/auth/login
Content-Type: application/json

{
  "username": "admin",
  "password": "your-password"
}

响应：

{
  "access_token": "eyJ...",
  "token_type": "bearer"
}

使用 Token

在后续请求的 Header 中携带 Token：

Authorization: Bearer eyJ...

核心 API

对话

发送消息

POST /api/chat/send
Content-Type: application/json

{
  "content": "帮我查看今天的待办任务",
  "session_id": "optional-session-id"
}

SSE 流式对话

GET /api/chat/stream?session_id=xxx
Accept: text/event-stream

虚拟成员

列表

GET /api/members/virtual

创建

POST /api/members/virtual
Content-Type: application/json

{
  "name": "AI 助手",
  "post": "developer",
  "mode": "agent"
}

插件

列表

GET /api/plugins

插件详情

GET /api/plugins/:name

WebSocket

OpenVort 使用 WebSocket 实现实时功能：

const ws = new WebSocket('ws://localhost:8090/ws')

ws.onmessage = (event) => {
  const data = JSON.parse(event.data)
  // Handle presence, typing, notifications
}

更多详细的 API 文档请参考 FastAPI 自动生成的文档：http://localhost:8090/docs