平台 · API 与 Webhook

通过 HTTPS集成，而不是看 PPT

实现服务器到服务器的聊天，将 token 流式输出到你自己的界面，并通过指向你 FlexyAgents 主机的 Webhook 触发自动化。下方的路由都是真实的 Next.js 处理程序——在生成 FlexyAgents API 连接后，从"部署"页面复制对应的值即可。

  • POST /api/agents/{agentId}/chat 接受绑定到 FlexyAgents 自动化应用连接的 Bearer，并运行与挂件相同的 RAG + 模型栈
  • 可选流式返回以换行分隔的 JSON 片段；非流式则折叠为单一助手载荷
  • 在套餐校验前先应用按 IP 的限速；托管套餐仍执行 token 预算，BYOK 在缺少提供商密钥时返回明确错误
  • Webhook 触发、渠道回调与出站集成共享同一租户模型——全部解析到组织与智能体记录
阅读文档开发者中心

先要密钥？ 创建工作空间 然后打开 设置 → API 密钥 或智能体的连接弹窗。

HTTP 接口一览

路径与 Next.js 路由树一一对应。请将占位符替换为部署界面中显示的智能体 ID 与主机。

  • POST/api/agents/{agentId}/chat

    智能体对话与流式输出

    发送包含 messages 数组（角色 + 内容）的 JSON，并可选用 stream 标志。Bearer 校验你在智能体连接上存储的 FlexyAgents API 密钥；密钥验证成功后会自动解析到对应组织。

  • POST/api/webhooks/automations/...

    自动化触发入口

    已发布的自动化可暴露 Webhook URL，反序列化载荷并调用 executeAutomation——当你的自有服务需要在无 OAuth 的情况下启动流程时非常有用。

  • GET/POST/api/webhooks/*

    渠道与服务商 Webhook

    /api/webhooks 下的同级路由处理 WhatsApp、Instagram、Facebook Messenger、入站邮件及类似厂商回调，使全渠道部署保留在你的域名下。

  • —集成 → Webhook

    出站投递

    若希望 FlexyAgents 将会话或系统事件推送到 SIEM、数据湖或工单桥接，可在控制台配置签名的出站 Webhook。

最简单的非流式调用

curl -X POST "https://YOUR_APP_HOST/api/agents/AGENT_ID/chat" \
  -H "Authorization: Bearer YOUR_FLEXYAGENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"messages":[{"role":"user","content":"你好"}],"stream":false}'

请将以下值替换为来自 部署 → API 的内容（在该智能体连接 FlexyAgents 应用之后获得）。

调用

优先 HTTPS 的对话，与挂件共用同一套推理

部署页可复制针对线上主机的 curl 片段。底层处理程序通过自动化连接存储校验 API 密钥，加载行为与知识，并像其他渠道一样累计用量。

  • messages 数组约定

    请求体至少包含一轮对话。执行器为检索会将历史裁剪到最新用户消息，同时仍接受多轮数组以备后续能力。

    • 校验器中角色仅限 user、assistant 或 system
    • 仅在文档允许时在请求头附加元数据——优先遵守 JSON 约定
    • 非法结构返回 400，并附带 Zod 细节字符串便于调试
    打开「部署」标签页

  • 流式模式

    设置 stream: true 可接收 NDJSON 片段（每行一个 JSON 对象），前端可在 token 到达时刷新界面。

    • 适合希望与托管挂件体验一致的移动端或桌面客户端
    • 流中途错误仍以 JSON 行序列化，便于解析器恢复
    • 若代理会强力缓冲响应，可关闭流式

  • Bearer API 密钥与会话 Cookie

    服务账号应使用按智能体生成的 FlexyAgents 连接密钥。交互式测试可依赖已登录控制台会话，但服务端到服务端应始终使用 Bearer。

    • 密钥与其他自动化凭据一同静态加密
    • 轮换密钥不会改变 URL 中的智能体 ID
    • 无效或缺失的密钥在产生模型费用前返回 401
    模型计费说明

  • 生产环境可见的限额

    基于 Redis 的限速在流量突增时返回 429。套餐策略对托管/BYOK 月配额添加 MESSAGE_LIMIT_REACHED，托管推理还有 token 上限。

    • 自动化与对话共享同一组织级计量故事
    • 联系支持时请记录错误载荷中的关联 ID
    • 在计费允许的前提下升级或增加额度以获得更高吞吐
    用量与套餐

事件

把你的技术栈接入 FlexyAgents——并把事件再推出去

入站路由规范化厂商签名，出站配置与其他集成并列。自动化还可以在流程内发起任意 HTTP POST。

  • 自动化 Webhook 触发

    当流程发布 Webhook 触发器时，FlexyAgents 保存路径片段并在调用 executeAutomation 前校验载荷并解析正文。

    • 可与调用 Slack、CRM 或自定义 REST 的智能体步骤组合
    • 功能分级可能要求在开放通用入站前升级套餐
    • 日志与 OAuth 触发器出现在同一自动化运行历史中
    自动化概览

  • 渠道服务商回调

    WhatsApp、Instagram DM、Messenger 与入站邮件各自注册公共 HTTPS 端点，供 Meta、Twilio 或邮件服务商验证并投递事件。

    • 在厂商控制台配置回调 URL，使其与部署主机一致
    • 验证握手与实时流量使用相同路由
    • 让敏感载荷落在你已审计的基础设施上
    渠道部署

  • 出站 HTTP 动作

    自动化动作可向客户自有 URL 发起 POST/PUT，并使用模板化正文——例如「通知 Opsgenie」或「创建 Jira 工单」，无需等待官方连接器。

    • 在自动化构建器中将触发字段映射到 JSON 正文
    • 重试与错误处理遵循自动化执行器默认策略
    • 可与智能体步骤组合，在投递前生成人类可读摘要

参考

规范、文档与探索工具

营销页负责叙事；工程师应依赖文档站、仓库中的 OpenAPI 定义，以及与租户 ID 一致的部署页片段。

  • 文档中心

    从 /docs 阅读概念指南，再交叉链接到面向开发者的 /api 页面获取快速开始、认证入门与分栏参考。

    • 示例强调 curl、JavaScript 与挂件嵌入模式
    • SDK 与 Postman 承诺应与实际分发内容一致
    • 通过支持渠道反馈缺口，便于营销与技术文档对齐
    打开文档

  • OpenAPI 真相来源

    仓库包含完整的 OpenAPI，描述认证方案、聊天载荷与附属 REST 资源——可从该文件生成客户端或导入 Postman。

    • 版本节奏跟随软件包发布，而非本落地页
    • 暂存与生产基址枚举在规范的 servers 列表中
    • 本地开发者在 localhost 上命中与生产租户主机相同的 /api/agents/{id}/chat 路径
    开发者 API 页面

  • 挂件与移动端配套

    并非所有场景都需要裸 REST——可嵌入脚本使用相同的聊天端点并携带访客上下文。若既要网页自助又要后台任务，可将 API 与挂件组合使用。

    • 托管页面复用你已测试过的智能体配置
    • CSP 与 Cookie 策略需允许你配置的挂件来源
    • 邮件中的深层链接可通过查询参数打开托管聊天
    网页触点

将 API 与自动化、渠道，以及分析中的治理能力配合使用。

下一步

复制可用的 curl，再为生产环境加固

生成 FlexyAgents 连接密钥并粘贴到你的密钥仓库，将自动化 Webhook 指向你掌控的路径。准备就绪后，把可观测性接入与客户成功团队相同的分析工作空间。

免费试用预约演示