页面状态: Reference 入口。当前尚无覆盖全部模块、可由统一 OpenAPI 或 Schema 生成的完整 API 参考。
本页不手工复制端点,也不根据 SDK 方法推测服务端 API。线上 HTTP 行为当前以 gateway/packages/api 的实际实现为事实权威;@fellow.work/client 是 Interaction 的 TypeScript/Web/Node 参考实现,不是全部产品 API 的定义。
按职责查找
- Interaction Protocol:Thread、Run、Consent 与原生 SSE。
- Host Protocol:窄宿主能力与授权边界。
- Runtime Protocol:Run、作业、沙箱与 HARP workload 生命周期。
- Interfaces Protocol:AG-UI(
@fellow/ag-ui-adapter)、Channels、MCP、Connectors 边界(Stable @ ≥ 0.7.1)。 - Management Protocol:Operator API(Stable ·
@fellow.work/client/management)。 - Case Protocol:Stable opt-in @ ≥ 0.6.4(
FELLOW_CASE=1)。
当前可用
当前外部开发者的主要可用面是 Interaction:通过 Client SDK 使用 Thread / Run、消费 Fellow StreamEvent SSE,并处理 Consent。Integration App 的认证与 Scope 见接入应用。
在显式开启 capability 的 Gateway 上,还可试用 Runtime、Case 等 opt-in 路由;行为以 gateway/packages/api 实现与 SDK spec/ 为准,集成前必须检查 Fellow-Gateway-Capabilities。
契约要求
完整 Reference 应由版本化机器可读契约生成,并为每个 endpoint 或 method 提供鉴权、Scope、请求响应、稳定错误、幂等和版本信息。在生成链、错误语义和 conformance 完成前,本入口不会伪造路径、字段或可复制调用示例。
信任与版本边界
七个模块独立成熟、独立版本化;SDK 包版本、Console 版本和协议版本不能互相替代。任何生产集成都应核对响应头 Fellow-Gateway-Capabilities 与兼容性,不能仅按产品名称或 npm 包版本猜测能力。