AiHummer
中文▾
登录帐户
v1.2.x▾
v1.2.xstablev1.1.xstablev1.0.xstable
{ }Swagger
应用程序接口/入站和集成触发器

入站和集成触发器

v1.2.x · 已更新 2026-07-27

除了兼容 OpenAI 的 API 外，AiHummer 还接受 入站消息 来自连接器和自动化平台，并发出一个 服务器端事件流 你可以订阅。这些端点是外部系统向网关传递工作以及用户界面保持实时的方式。

入站端点

入站端点是通道连接器和自定义集成向转发引擎传递消息的方式。它们通过一个进行安全保护 HMAC 共享密钥 寄到 X-AIHummer-Inbound-Secret 标题 (该 AIHUMMER_INBOUND_SECRET settings-catalog 键 — 在管理界面中通过 管理 → 设置 配置，或使用 aihummer settings set，不在 gateway.env).

方法与路径 目的
POST /v1/inbound/telegram 原生 Telegram 入站有效负载
POST /v1/inbound/generic 电子邮件→Webhook、定时任务和自定义应用的通用入站
POST /v1/inbound/binding/status 报告通道绑定状态

这 通用 端点是将任何来源输入 AiHummer 的最简单方式。发送一个包含频道名称、稳定的外部标识符和消息文本的小 JSON 体：

curl https://your-aihummer.example/v1/inbound/generic \
  -H "X-AIHummer-Inbound-Secret: $AIHUMMER_INBOUND_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "email",
    "external_id": "ticket-4821",
    "text": "A customer asks whether order #4821 has shipped."
  }'

[!NOTE] 通用入站调度器需要一个默认工作区。设置 AIHUMMER_DEFAULT_WORKSPACE_ID 这样可以对传入消息进行路由。

[!WARNING] 入站端点没有受到保护 ah- API 密钥——他们依赖于 X-AIHummer-Inbound-Secret HMAC。不要将该密钥放在客户端代码中，并且 如果漏了，就旋转它。

集成触发器（Zapier / Make）

POST /v1/integrations/trigger 是低代码自动化平台的入口点，例如 Zapier 和 制造。端点是 默认禁用: 直到 AIHUMMER_INBOUND_TRIGGER_SECRET 设置配置后它会响应 501 Not Implemented. 这是一个 分开 秘密，与……不同 AIHUMMER_INBOUND_SECRET; 像每个 settings-catalog 键一样，它可以在管理 UI（管理 → 设置）中设置，或通过 aihummer settings set.

配置完成后，该端点可以接受任一 X-AIHummer-Signature HMAC 或形式为的承载令牌 Authorization: Bearer <the AIHUMMER_INBOUND_TRIGGER_SECRET value>.

curl https://your-aihummer.example/v1/integrations/trigger \
  -H "Authorization: Bearer $AIHUMMER_INBOUND_TRIGGER_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "zapier",
    "external_id": "lead-99",
    "text": "New lead captured from the contact form."
  }'

Admin Sessions 后端

这两个路由是为 Admin Sessions 页面保留的内部传输接口。它们不是面向客户且可嵌入的受支持渠道。

方法与路径 用途
POST /v1/web/session 打开或重新关联 Admin Sessions 对话
GET /v1/web/stream 通过 SSE 流式传输对话响应

事件流

GET /v1/events/stream 是 可恢复的 网关事件的服务器发送事件（SSE）推送。该端点有两个硬性要求：

  1. 这 ?workspace_id=<id> 参数是必需的 — 没有它，请求 被拒绝与 400. 租户守护程序验证工作区的归属 呼叫者的租户；别人的 workspace_id 产量 403.
  2. 需要身份验证 — 一个管理员会话（cookie）或一个 ah- 应用程序接口 输入一个 Authorization: Bearer 标题。没有它，响应是 401.

传球 ?since= 光标从上一次连接中断的地方恢复，因此重新连接不会丢失事件。

# Subscribe from the beginning
curl -N -H "Authorization: Bearer ah-..." \
  "https://your-aihummer.example/v1/events/stream?workspace_id=<id>"

# Resume after a known cursor
curl -N -H "Authorization: Bearer ah-..." \
  "https://your-aihummer.example/v1/events/stream?workspace_id=<id>&since=<cursor>"

[!TIP] 将每个事件携带的值视为下一个 since 光标。开启 重新连接，从该光标重新播放以保证至少一次传递到您的 消费者

接下来去哪儿