跳转到内容
Strata
登录

REST API

Strata 基于 OpenAPI 3.1 规范描述的 REST API 构建。大多数集成使用 MCP 服务器,而非直接调用 REST,但完整规范可供工具和自定义客户端使用。

规范

OpenAPI 规范

机器可读规范实时提供,与已部署的 API 保持同步。可直接打开,或导入到 Scalar、Redoc、Postman 或 Insomnia 等查看器中:

打开 openapi.json

该规范也通过 /.well-known/api-catalog 向代理和爬虫公开。

约定

基础 URL 与版本控制

所有端点均位于 API 主机的 /api/v1 路径下,路径前缀标识版本。

认证

认证

请求需携带 Bearer 令牌。浏览器会话使用从 HttpOnly 刷新 Cookie 生成的短期访问令牌,程序化 MCP 访问使用 OAuth 2.1,后者会自动处理令牌签发与刷新。

参考

资源领域

API 涵盖完整的 Strata 域,主要资源领域如下:

  • 文档:增删改查、历史记录、评论、建议、访问控制、发布、图片
  • Spaces:成员管理、来源、访问授权、混合搜索
  • 公司、组织与层级:工作区层次结构
  • 用户与主页:账户、成员资格、公开主页
  • 访问与共享:权限、公开链接、Space 授权
  • 认证与 OAuth:会话、租户切换、MCP OAuth 客户端
  • 代理与任务:平台和用户代理调用
  • 管理与合规:SSO、SCIM、审计、数据保留、计费
客户端

生成客户端

将任意支持 OpenAPI 3.1 的代码生成工具指向上述规范,即可生成所需语言的强类型客户端。

倾向于使用工具而非直接调用 REST?请参阅 MCP 工具参考。