开发者指南 · 11

API 参考

11.1 Admin API

方法路径说明
POST/api/auth/register注册(需注册码)
POST/api/auth/login登录
GET/api/auth/me当前用户
GET/POST/DELETE/api/conversations[/{id}]对话管理
POST/api/chat / /chat/resume / /chat/stopSSE 聊天
GET/api/chat/streaming-status后台流活跃状态
CRUD/api/files/*文件操作 + media + 上传/下载
POST/api/scripts/run执行脚本
POST/api/audio/transcribe语音转写
GET/api/models模型列表
CRUD/api/system-prompt[/versions]Prompt 管理
CRUD/api/user-profile[/versions]用户画像
CRUD/api/subagentsSubagent 管理
CRUD/api/capability-prompts[/{key}]能力提示词
GET/PUT/api/soul/configSoul 配置
POST/GET/api/batch/*批量执行
CRUD/api/services[/{id}[/keys]]Service 管理
CRUD/api/scheduler[/{id}]Admin 定时任务
POST/api/scheduler/{id}/run-now立即执行
GET/api/scheduler/{id}/runs运行记录
GET/api/scheduler/services/all所有 Service 任务
CRUD/api/scheduler/services/{svc_id}[/{task_id}]Service 任务
CRUD/api/inbox[/{id}]收件箱
GET/api/inbox/unread-count未读数
GET/POST/api/packages[/init/install/uninstall]per-user venv
GET/PUT/POST/api/settings/api-keys[/test/status]per-admin API Key
GET/api/wc/{service_id}/qrcodeService WeChat QR
GET/api/wc/{service_id}/sessions[/{session_id}/messages]会话查看
POST/api/admin/wechat/qrcodeAdmin WeChat QR
GET/DELETE/api/admin/wechat/sessionAdmin 会话管理
WS/api/voice/wsS2S WebSocket

11.2 Consumer API

方法路径说明
POST/api/v1/conversations创建对话
GET/api/v1/conversations/{id}对话历史
GET/api/v1/conversations/{id}/files[/{path}]生成文件列表 / 下载
GET/api/v1/conversations/{id}/attachments/{path}用户附件
POST/api/v1/chat自定义 SSE
POST/api/v1/chat/completionsOpenAI 兼容

11.3 静态页面

路径说明
GET /s/{service_id}Consumer 独立聊天页(React)
GET /s/{service_id}?key=sk-svc-...同上,自动写入 localStorage
GET /wc/{service_id}WeChat 扫码中间页