Developer Docs

文档首页

开发文档 · 开始使用

快速开始

使用 @fellow.work/client 创建 Thread、发起 Run 并消费事件流。

状态:Stable(Interaction @ ≥ 0.6.0) — 本页覆盖 Thread、Run 与 Fellow StreamEvent SSE 主链路。Object / Control / Case / Runtime 为 Stable opt-in(≥ 0.6.3 / 0.6.1 / 0.6.4 / 0.6.5);须显式开启 Gateway 能力。

本页以公开 SDK 完成第一条可运行链路。Fellow Desktop 是使用同一平台能力构建的官方参考应用,不是 SDK 接入的前置条件。

1. 前置条件

  • Node.js 20 或更高版本;
  • 可访问的 Fellow Gateway;
  • 服务端 API Key,或由 Integration App 签发的短期用户 Token;
  • 一个新的 TypeScript 项目。

浏览器应用不得保存 fkey_…。浏览器鉴权请使用 Integration App 的后端 token exchange。

2. 安装 Client SDK

pnpm add @fellow.work/client

3. 创建 Client 并运行任务

import { createClient, EventType } from '@fellow.work/client';

const client = createClient({
  baseUrl: process.env.FELLOW_BASE_URL!,
  apiKey: process.env.FELLOW_APP_API_KEY!,
});

const { id: threadId } = await client.createThread({
  externalUserId: 'quickstart-user',
});

const { events } = await client.run(threadId, {
  content: '用三点说明智能应用开发平台的价值',
});

for await (const event of events) {
  if (event.type === EventType.TEXT_MESSAGE_CONTENT) {
    process.stdout.write(event.delta);
  }
}

把 FELLOW_BASE_URL 与 FELLOW_APP_API_KEY 放入服务端环境变量,然后运行脚本。

4. 验证成功

第一条链路至少验证:

  • Thread 创建成功;
  • Run 正常进入事件流;
  • 客户端持续消费增量事件直至终态;
  • 错误能够被捕获,而不是静默结束;
  • API Key 没有进入浏览器 bundle 或日志。

完整 API、取消和错误处理见 Client SDK。

5. 选择下一条开发路径

目标下一步
嵌入现有 Web / SaaSIntegration App → 嵌入指南
接入企业数据与工具Connectors 或 MCP Server
构建可安装长期应用Applications → HARP
部署到云端或私有环境部署选型 → Console
理解运行和协议边界AIOS Foundation → AIOS 协议族
参考完整本地应用参考应用:Fellow Desktop

6. 官方参考应用

Fellow Desktop 展示本地 Host、Gateway、Sandbox、Skills、Connectors 与 HARP 如何组合。它适合验证完整产品形态,但开发者无需先安装 Desktop 才能使用 SDK。

下一步