API 文档
了解 iPolloWork API 的资源分组、系统边界和仓库中的 OpenAPI 合约。
iPolloWork 仓库在 packages/docs/openapi.json 中包含 OpenAPI 合约。它定义了组织、认证、配置、连接器、插件、Skill、Worker 和其他控制平面操作的资源族。
本页是 API 的定位层。某个具体接口的请求与响应以生成的 OpenAPI 文档为准。
请求按其控制的资源类型分组。运行时工作与组织控制刻意保持为两类不同问题。
- 01身份
认证、当前用户、组织、成员、角色和邀请。
- 02配置
配置对象、版本、插件、Skill 与市场资源。
- 03连接
模型目录、连接器账号、目标、映射和同步活动。
- 04运行时
Worker、托管运行时状态、令牌和受限操作。
处理本地工作区时，应读取本地 Server 文档。处理组织管理能力时，应读取 OpenAPI。两条平面不应相互伪装。
本地 iPolloWork Server
基于文件系统的工作运行时
会话、文件、产物、审计、审批与范围化工作区健康状态。
受支持的 OpenCode 代理与本地能力边界。
Den OpenAPI
组织与 Cloud 能力平面
用户、组织、角色、邀请和资源访问。
配置对象、插件、Skills、模型提供商、连接器与托管 Worker。
从资源边界开始
| 需求 | 资源族 |
|---|---|
| 查看当前用户或组织 | /v1/me、/v1/org、/v1/members、/v1/roles |
| 管理可复用配置 | /v1/config-objects、/v1/plugins、/v1/skills、/v1/skill-hubs |
| 连接外部服务 | /v1/connector-accounts、/v1/connector-instances、/v1/connectors/github/* |
| 管理模型提供商 | /v1/llm-provider-catalog、/v1/llm-providers |
| 管理托管 Worker | /v1/workers |
构建客户端前，先阅读 OpenAPI 与集成。面向工作区的路由请阅读 Local Server 参考，Den API 资源图请阅读 控制平面资源地图。进一步可阅读 认证与访问、配置资源、Worker 和连接器 与 运行时、Worker 与 Webhook。