VAgent

VAgent API

下方是完整的 REST API 参考。所有 v1 端点都可以用 Personal Access Token 调(请求头加 Authorization: Bearer pat_xxxxx)。本页下方已内嵌完整 OpenAPI 参考,可直接查看端点、参数和响应结构。

注意:下方 API 参考由后端 OpenAPI 自动生成,当前仅提供中文版。

认证方式
推荐使用 API Tokens。请求头携带 Authorization: Bearer pat_xxx,即可调用绝大多数 v1 接口。
对应生成入口:/api-tokens
常见资源
会话、消息、知识源、网站、工作区、计费和审计都通过 REST API 访问。具体路径以 OpenAPI 为准。
先看示例
如果你只想快速接入,先在下方 OpenAPI 面板里展开一个 endpoint,再复制示例请求体即可。
文档状态
OpenAPI 参考正在加载;如果网络限制拦截 CDN,这里仍保留静态说明。
快速开始
1. 在 API Tokens 页面创建 token。2. 将 token 放入 Authorization 头。3. 调用 /api 或 /api/v1 下的接口。4. 先确认响应码和错误结构,再接入前端或脚本。
请求与响应
本项目接口采用 JSON 作为主要数据格式;分页、过滤、错误码等细节已在 OpenAPI 中说明。
联调建议
先用浏览器打开此页确认 OpenAPI 可见,再用 curl / Postman 验证 token 与基础路径是否正确。

文档说明

下列内容用于在 ReDoc 初始化失败或网络受限时,也能让页面不再空白。

若下方 OpenAPI 参考暂未显示,请确认后端已暴露 /openapi.json, 且浏览器可访问 ReDoc CDN。即使如此,上方仍保留了 API 使用入口与接入指引。

你也可以直接查看 API Tokens 页面创建凭据,或返回主页继续浏览其他公开文档。