跳转到主要内容
文档入门快速开始
入门 · 10 分钟

快速开始

注册账号、进入控制台,用模板或 AI 助手在 10 分钟内跑通一条完整的工作流。

这一篇带你从"刚打开网站"到"跑通一条真实工作流",中间不用写代码、不用装任何东西。跟着走一遍,你会认识 Braidrun Workflow 里几乎所有最常用的概念。

开始之前

你需要的东西很少:

  • 一个能收邮件的邮箱 —— 用来注册 + 邮箱验证。
  • 一把 OpenAI / Anthropic / DeepSeek / Kimi 任一家的 API Key(可选)—— 没 Key 也能先跑 dry-run 看数据流;真正调 LLM 的那一刻才需要。
  • 10 到 15 分钟的专注时间。

全景预览:这一篇会发生什么

下面是我们会按顺序走的路径。每一步都会解释"为什么要这样做",不是干巴巴的操作手册:

  1. 注册账号 → 登录进来
  2. 到「工作流」页认识主控台
  3. 从模板库克隆一条现成工作流
  4. 用 dry-run 检查它的结构
  5. 绑定你的 LLM Key(BYOK)
  6. 真跑一次,读懂实时事件流
  7. 挂一个 cron 让它每天自动跑

第 1 步 · 注册账号

1.1 打开注册页

首页右上角点「登录」,在登录页底部点「创建账号」,或者直接访问 /register

1.2 邀请码或开放注册

Braidrun 目前处于邀请制内测阶段,意思是:

  • 你需要一个邀请码才能完成注册;
  • 没有邀请码的话,在首页「申请邀请码」表单留下你的邮箱,我们开放名额时会优先联系你。

拿到邀请码后,填邮箱 + 密码 + 邀请码即可。也可以用 Google / GitHub OAuth 一键登录(这种方式不需要邀请码但仍需等待管理员批准)。详细流程见 注册与登录

1.3 邮箱验证与激活

提交表单后会收到一封验证邮件,点击里面的链接激活账号。激活前你能浏览页面但不能创建 / 保存 / 执行工作流 —— 顶部会有一条橙色提示横幅。

没收到邮件?

先看垃圾邮件箱。如果仍然没有,到「账号设置」页点「重新发送验证邮件」。超过 15 分钟仍收不到,可能是你的邮箱域屏蔽了外部验证邮件,换一个邮箱试试。

第 2 步 · 进入工作流控制台

2.1 左侧主导航

登录后你落在首页。左侧是一条固定的导航栏,这几个你一定会用到:

  • 工作流 — 你的主战场。所有工作流都在这里列出。
  • 模板库 — 240+ 条预置工作流,克隆即用。
  • 模块库 — 120+ 个可复用模块 + 你自己 Promote 的模块。
  • 执行历史 — 最近的所有 execution 列表。
  • 调度管理 — 定时 / Webhook 触发条目。
  • 审批管理 — 工作流挂在「人工审批」步骤时,审批人从这里批准。
  • 凭据管理 — 所有 API Key 放这里,加密存储。

2.2 首页的三个快捷入口

首页不是一张空地。它提供三种起点:

  1. 新建空白工作流 — 从一张白画布开始。推荐已经对平台熟悉之后再选这个。
  2. 从模板克隆 — 本指南采用这一条路径。最快上手。
  3. 让 AI 助手生成 — 右下角的 FAB 打开侧边 AI 助手,用自然语言描述你要干什么,它会给出一个初稿。

第 3 步 · 从模板库克隆

3.1 挑一个最贴近你业务的模板

打开左侧 模板库。左上角有分类筛选(运营自动化、广告投放、数据分析、iOS 开发、内容创作、合规审查 …);右上角有搜索框和标签过滤。

建议第一次选这两类之一:

  • 「每日新闻摘要」 — 逻辑简单,步骤少,看得到完整数据流。
  • 「ASA 周报」 — 真实业务场景,用到调度 + 子工作流 + Slack 投递。

3.2 阅读模板卡片

点进去看:

  • 「描述」—— 它是干什么的
  • 「所需凭据」—— 跑起来要填哪些 key
  • 「示例输入 / 输出」—— 能代表典型结果
  • 「预估时长 / 成本」—— 跑一次大概多少分钟、多少美元

3.3 克隆到工作区

点右上角 「使用此模板」。确认后平台会在 /workflows 下为你生成一份独立的副本 —— 之后你怎么改都不会影响原模板。

第 4 步 · 用 dry-run 先看结构

4.1 为什么非要 dry-run?

dry-run 的核心价值是"零成本":它会走完一遍完整的 DAG,但把所有 LLM 调用和外部副作用(发消息、写数据库、扣款等)替换成安全的 no-op。你能看到:

  • 变量到底流到了哪里 —— 引用的 {{...}} 有没有拼错
  • 哪些 step 被 condition 跳过了
  • 模板对哪些凭据有依赖 —— 提前知道要在凭据中心配什么

4.2 在编辑器里启动 dry-run

  1. 在工作流编辑器顶部点 「执行」
  2. 对话框里勾选「dry-run(不调 LLM / 不发副作用)」。
  3. 按模板提示填若干必要参数,剩下的留默认即可。
  4. 点「开始执行」。编辑器会自动切到执行详情视图。
读懂执行详情页

顶部是甘特图(每个 step 横条代表耗时),左下是 step 列表,右下是所选 step 的输入 / 输出 / 变量快照。dry-run 完成后所有 step 都应该是绿色 COMPLETED 或灰色 SKIPPED。

第 5 步 · 配置一把 LLM Key(BYOK)

5.1 什么是 BYOK

"Bring Your Own Key"。你自己去 OpenAI / Anthropic 等 provider 拿一把 API Key,配在 Braidrun 里让它代你调用。好处:

  • Token 消耗直接记在你自己的 LLM 账户上,平台不加价。
  • 你可以用自己账户的高级模型 —— 比如 Claude Opus、GPT-5 —— 而不用平台统一兜底。
  • 轮换 / 吊销 Key 完全由你掌握。

5.2 拿一把 Key

最常见的几家:

5.3 在凭据中心存它

  1. 打开 凭据管理
  2. 点「新建凭据」。
  3. 类型选 api_key;名字起一个有辨识度的,比如 openai_mainanthropic_personal;值粘贴你从 provider 拿到的 key。
  4. 保存。平台会立刻用 AES-256-GCM 加密落库 —— 之后这个字段只能覆盖,不能读回。

更完整的解释(三级命名空间、provider 绑定、轮换流程)见 凭据管理BYOK · 自带 LLM Key

第 6 步 · 真跑一次

6.1 启动执行

  1. 回到工作流编辑器,顶部点「执行」。
  2. 对话框里这次 取消 勾选 dry-run。
  3. 再次填必要参数 —— 通常第一次会和 dry-run 填一样。
  4. 点「开始执行」。

6.2 读懂右侧实时事件流

页面右侧是一条通过 WebSocket 实时推送的事件流。每一行是一个事件,可以按类别筛选:

  • Agent 发言 —— Agent 的中间输出,group_chat 步骤里最常见;
  • LLM 调用 —— 每次模型调用的摘要,带输入 / 输出 token 数;
  • 工具调用 —— Agent 调了哪个工具,展开可以看参数与返回值;
  • 对外消息 —— 工作流向 Slack / Telegram 等渠道发出的消息记录。

更多事件类别的解释见 执行监控与日志

6.3 看结果与产物

跑完后顶部点「查看执行详情」:

  • 甘特图里每个绿色横条是成功的 step;鼠标悬停看耗时。
  • 点某个 step 看它的输入 / 输出 / 日志 / 变量快照。
  • 产物栏里可以预览或下载 Markdown / Excel / 截图等。

第 7 步 · 挂一个 cron 让它自动跑

7.1 新建调度

  1. 左侧「调度管理」→「新建调度」。
  2. 目标工作流选你刚才跑通的那条。
  3. 类型选 cron;表达式填 0 8 * * *(每天早上 8:00);时区选 Asia/Shanghai。
  4. 如果工作流有变量,在「参数预设」里填这批调度默认用的值(每次定时触发都会带着这些值启动)。
  5. 保存。列表里就多了一条,「下次触发时间」实时计算显示。
只支持标准 5 段 cron

表达式必须是「分 时 日 月 周」5 段格式。Quartz 风格的 6 / 7 段表达式(多出秒位或 ? 占位符,如 0 0 8 * * ?)保存时不会报错,但永远不会触发。

7.2 调度如何保证不重复

多实例部署下平台自动做分布式锁:同一个调度同一分钟只会在一台机器上被触发。你不需要担心重复跑。

定时调度还能按 interval / one-time 方式配,详见 定时调度

做完这些,你已经会的

  • 注册 / 登录 / 邮箱验证的完整流程
  • 模板库克隆 → 编辑器 dry-run → 真跑的基本循环
  • 凭据中心的角色以及 BYOK 的意义
  • 读实时事件流 + 执行详情页的能力
  • 把工作流挂到 cron 自动跑的入口

接下来看什么

  • 核心概念 — workflow / step / agent / module / execution / credential 之间的关系一张图讲清楚
  • 实战:第一条工作流 — 手把手写一条真实业务工作流,所有概念串在一起
  • 可视化编辑器 — 把画布 / YAML / 工具栏 / 协作锁 / 版本快照一个一个讲清楚
  • 最佳实践 — 踩过的坑别再踩一遍