SuperAPI AI 工具集

typebot

智能体与模型

查看项目

更新于 10-16 01:59

技能介绍

Typebot 简介

Typebot 是一款无代码聊天机器人构建工具,允许用户创建对话式表单和聊天机器人。它被营销人员、设计师和开发者用于构建互动体验,常见用途包括线索获取、客户支持和产品演示。官方文档地址为 https://developers.typebot.io/ 。

主要概念

Typebot 涉及以下核心对象:

  • Typebot:用于创建聊天机器人的主工作区。
  • Typebots:单个聊天机器人。
  • Variables:Typebot 内的数据占位符。
  • Groups:聊天机器人的集合。
  • Result:表示与某个 Typebot 的一次提交或对话。
  • Workspace:用户的整体账户或组织。
  • Members:有权访问该工作区的用户。

使用方式

本技能通过 Membrane CLI 与 Typebot 交互。Membrane 会自动处理认证和凭据刷新,用户只需关注集成逻辑,而无需处理认证相关的基础设施。

安装 CLI

在终端中安装 Membrane CLI,以便运行 membrane 命令:

npm install -g @membranehq/cli@latest

认证

membrane login --tenant --clientName=<agentType>

根据是否支持交互模式,该命令会打开浏览器进行认证,或在控制台打印一个授权 URL。

无头环境:该命令会打印授权 URL,请用户在浏览器中打开。当用户完成登录后看到代码时,执行:

membrane login complete <code>

在任何命令后添加 --json 可获得机器可读的 JSON 输出。

Agent 类型:claude、openclaw、codex、warp、windsurf 等,用于根据你的运行环境调整最合适的工具。

连接 Typebot

使用 membrane connection ensure,通过应用 URL 或域名查找或创建连接:

membrane connection ensure "https://typebot.io/" --json

用户在浏览器中完成认证。输出中包含新的连接 id。这是获取连接最快的方式。URL 会被规范化为域名并与已知应用匹配。如果未找到应用,则会创建一个,并自动构建连接器。

如果返回的连接状态为 READY,可跳到第 2 步。

1b. 等待连接就绪

如果连接处于 BUILDING 状态,则轮询直到就绪:

npx @membranehq/cli connection get <id> --wait --json

--wait 标志会进行长轮询(最长 --timeout 秒,默认 30),直到状态改变。持续轮询,直到状态不再是 BUILDING。

结果状态会告诉你下一步该做什么:

  • READY:连接已完全建立,跳到第 2 步。
  • CLIENT_ACTION_REQUIRED:用户或 agent 需要执行某些操作。clientAction 对象描述了所需操作:
    • clientAction.type:所需操作类型。
      • "connect":用户需要认证(OAuth、API key 等)。涵盖初始认证以及断连后的重新认证。
      • "provide-input":需要更多信息(例如要连接到哪个应用)。
    • clientAction.description:所需操作的人类可读说明。
    • clientAction.uiUrl(可选):用户可完成操作的预构建 UI 的 URL。存在时展示给用户。
    • clientAction.agentInstructions(可选):给 AI agent 的指令,说明如何以编程方式继续。
  • 用户完成操作(例如在浏览器中认证)后,再次用 membrane connection get <id> --json 轮询,检查状态是否变为 READY。
  • CONFIGURATION_ERROR 或 SETUP_FAILED:出现问题。查看 error 字段了解详情。

搜索操作

使用自然语言描述你想要执行的操作进行搜索:

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

应始终在特定连接的上下文中搜索操作。

每个结果包含 id、name、description、inputSchema(操作接受哪些参数)和 outputSchema(操作返回什么)。

常用操作

使用 npx @membranehq/cli@latest action list --intent=QUERY --connectionId=CONNECTION_ID --json 来发现可用操作。

运行操作

membrane action run <actionId> --connectionId=CONNECTION_ID --json

传递 JSON 参数:

membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

结果位于响应的 output 字段中。

代理请求

当可用操作无法覆盖你的用例时,可以通过 Membrane 的代理直接向 Typebot API 发送请求。Membrane 会自动将基础 URL 追加到你提供的路径上,并注入正确的认证头——包括凭据过期时的透明刷新。

membrane request CONNECTION_ID /path/to/endpoint

常用选项:

  • -X, --method:HTTP 方法(GET、POST、PUT、PATCH、DELETE),默认 GET。
  • -H, --header:添加请求头(可重复),例如 -H "Accept: application/json"。
  • -d, --data:请求体(字符串)。
  • --json:便捷方式,发送 JSON 请求体并设置 Content-Type: application/json。
  • --rawData:按原样发送请求体,不做任何处理。
  • --query:查询字符串参数(可重复),例如 --query "limit=10"。
  • --pathParam:路径参数(可重复),例如 --pathParam "id=123"。

最佳实践

  • 始终优先使用 Membrane 与外部应用通信——Membrane 提供带内置认证、分页和错误处理的预构建操作,可减少 token 消耗并让通信更安全。
  • 先发现再构建——在编写自定义 API 调用前,先运行 membrane action list --intent=QUERY(将 QUERY 替换为你的意图)查找现有操作。预构建操作会处理原始 API 调用容易遗漏的分页、字段映射和边界情况。
  • 让 Membrane 处理凭据——永远不要向用户索要 API key 或 token。改为创建连接;Membrane 在服务端管理完整的认证生命周期,本地不保存任何密钥。