Skip to main content

使用 Node.js SDK 运行

当你想从 Node.js 或 TypeScript 调用工作流部署时,请使用官方的 @fetch-hive/sdk 包。SDK 包装了公共的 POST /v1/workflow/invoke 端点,处理身份验证,并同时支持直接响应和回调投递。

安装

该 SDK 针对 Node.js 18+(使用全局 fetch),并附带 TypeScript 类型定义。

身份验证

FETCH_HIVE_API_KEY 环境变量设置为你的工作区 API 密钥:
或显式传入密钥:
有关如何创建和轮换密钥,请参阅 API 密钥

基本示例

直接运行工作流部署。该调用会阻塞,直到工作流完成:
请参阅 直接响应结构

方法参考

处理响应

回调投递

传入一个 async 块以立即返回,并让 Fetch Hive 在运行完成时调用你的回调 URL:
请保存 webhook_secret,以便你能验证传入回调的签名。请参阅 回调投递与 Webhook 触发 了解验证流程和签名负载结构。

配置

对于长时间运行的直接工作流请求,请优先使用 async: { enabled: true, ... },而不是增加客户端超时时间。

错误

非 2xx 响应会抛出一个 Error,其消息包含状态码和响应体:
有关工作流特有的失败案例,请参阅 错误处理;有关 HTTP 状态码含义,请参阅 错误与速率限制

链接

后续步骤