AnythingLLM Developer API 1.0.0 的中文详细说明，基于提供的 Swagger 文档内容

AnythingLLM API 概述

AnythingLLM 提供开发者 API，支持通过编程方式管理实例，涵盖认证、用户管理、文档处理、工作区操作、系统设置等功能。所有请求需通过 Authorization: Bearer {API_KEY} 头部进行认证。

认证

验证 API 令牌有效性

• ‌端点‌: GET /v1/auth
• ‌功能‌: 检查请求头中的 API 令牌是否有效。
• ‌请求头‌:
  • Authorization: Bearer {API_KEY}
• ‌成功响应‌:

  { "authenticated": true }
  
  

‌失败响应‌:
403 Forbidden: 令牌无效。

管理员功能

多用户模式管理

‌检查多用户模式状态‌: GET /v1/admin/is-multi-user-mode
‌## 用户管理‌:
获取所有用户: GET /v1/admin/users
创建用户: POST /v1/admin/users/new
更新用户: POST /v1/admin/users/{id}
删除用户: DELETE /v1/admin/users/{id}

‌邀请管理‌:

获取邀请列表: GET /v1/admin/invites
创建邀请: POST /v1/admin/invite/new
删除邀请: DELETE /v1/admin/invite/{id}

工作区权限

获取工作区用户: GET /v1/admin/workspaces/{workspaceId}/users
更新工作区用户: POST /v1/admin/workspaces/{workspaceId}/update-users

文档管理

上传与处理

上传文件: POST /v1/document/upload
通过链接添加文档: POST /v1/document/upload-link
处理原始文本: POST /v1/document/raw-text
获取文档列表: GET /v1/documents
支持的文件类型: GET /v1/document/accepted-file-types

元数据与结构

获取元数据模式: GET /v1/document/metadata-schema
创建文件夹: POST /v1/document/create-folder
移动文件: POST /v1/document/move-files

工作区操作

核心功能

创建工作区: POST /v1/workspace/new
获取工作区列表: GET /v1/workspaces
删除工作区: DELETE /v1/workspace/{slug} （通过唯一 slug）
更新工作区: POST /v1/workspace/{slug}/update
聊天与搜索

执行聊天‌:

POST /v1/workspace/{slug}/chat
‌参数‌:

{
  "message": "问题内容",
  "mode": "query（仅向量搜索）或 chat（使用LLM）",
  "sessionId": "会话标识符",
  "attachments": [{"name": "图片.png", "mime": "image/png", "contentString": "base64数据"}]
}

‌响应‌:

{
  "textResponse": "回答内容",
  "sources": [{"title": "文档.txt", "chunk": "相关文本片段"}]
}

流式聊天: POST /v1/workspace/{slug}/stream-chat（实时流式响应）
向量搜索: POST /v1/workspace/{slug}/vector-search

系统设置

导出环境变量: GET /v1/system/env-dump
系统信息: GET /v1/system
更新环境变量: POST /v1/system