iPolloWork Docs

配置资源

通过各自的 API 管理版本化配置、插件、Skill、市场和模型提供商元数据。

iPolloWork 使用独立可寻址的配置资源,而不是把所有工作区配置塞进一个不透明对象。这使版本历史、访问授权、插件关系和组织复用状态可以被明确管理。

配置流程配置资源生命周期

资源可以被创建、版本化、授权、解析为可用状态、归档、恢复或删除,具体操作由资源 API 族定义。

  1. 01创建

    创建配置对象或可复用能力记录。

  2. 02版本

    读取版本,并明确定位到最新版本。

  3. 03授权

    通过资源专属 access 路由分配访问。

  4. 04解析

    获取工作区或运行时真正要使用的实体化状态。

主要资源

资源常用路由
配置对象/v1/config-objects、版本、归档、恢复、删除、访问和插件
插件/v1/plugins、归档、恢复、resolved、访问和配置对象
Skill 与 Skill Hub/v1/skills/v1/skill-hubs、访问和 Hub 成员关系
市场/v1/marketplaces、访问、插件、归档、恢复与 resolved
模型提供商/v1/llm-provider-catalog/v1/llm-providers、connect 与 access

集成建议

  1. 后续写操作使用创建接口返回的资源 ID,不使用显示名称。
  2. 客户端需要可用运行时配置时,读取 latest 或 resolved 表示。
  3. 可逆业务动作优先使用 archive 和 restore,永久删除才使用 delete。
  4. 使用对应资源的 access 路由修改授权,不要把授权混入无关 payload。
  5. 将提供商凭据视为密钥,只读取面向客户端的元数据。

查询与生命周期细节

GET /v1/config-objects 用于资源发现,而不是一次性全量导出。它支持 Cursor 分页、1 到 100 的 limittypestatussourceMode、插件和连接器实例过滤、已删除资源筛选和文本查询。请先使用这些服务端过滤条件,再添加大范围客户端扫描。

Resolved 配置区分存储记录、版本历史和可用的运行时表示

展示记录不一定等于运行时应消费的配置实体。应按操作需求读取特定 latest、version 或 resolved 路由。

  1. 01记录

    创建或列出稳定配置对象 ID 及其描述性元数据。

  2. 02版本

    当调用方需要固定或可审计版本时读取版本历史。

  3. 03Resolved 表示

    请求为工作区或运行时实体化配置的对应路由。

  4. 04可逆状态

    业务意图可逆时使用 archive 和 restore。只有永久移除时才使用 delete。

当资源包含 access 子路由时,应独立更新该路由,而不是修改资源 Payload。这样可让版本化能力内容、访问策略和组织成员关系成为独立且可审计的关注点。

OpenAPI 文档是 payload 字段和状态码的唯一准则,本页只定义资源模型。