API 触发器

API 触发器会将你的工作流开放为安全的 HTTP 端点。向该端点发送 JSON 数据后，工作流会立即处理。API 调用始终针对你的最新部署执行。

这是基于 webhook 的触发器。外部服务或脚本发送 HTTP 请求以启动工作流。

配置

输入格式

定义 API 端点接受的 JSON 输入结构

为每个参数添加一个 输入格式 字段。支持的类型：

string — 文本值
number — 数值
boolean — 真/假值
object — JSON 对象
array — JSON 数组
listingIdentity — 结构化的交易标的/上市身份
files — 文件上传（通过 <api.fieldName[0].url>、<api.fieldName[0].name> 等访问）

输出引用

引用	类型	说明
`<api.field>`	可变	在输入格式中定义的字段
`<api.input>`	json	完整的结构化请求体

请求示例

curl -X POST \
  https://www.tradinggoose.ai/api/workflows/WORKFLOW_ID/execute \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_KEY' \
  -d '{"userId":"demo-user","maxTokens":1024}'

流式响应

启用实时流式传输，以便在工作流输出生成时即时接收。

请求参数

stream — 设为 true 以启用服务器发送事件 (SSE) 流式传输
selectedOutputs — 要流式传输的模块输出数组（例如 ["agent1.content"]）

示例

curl -X POST \
  https://www.tradinggoose.ai/api/workflows/WORKFLOW_ID/execute \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_KEY' \
  -d '{"message": "Count to five", "stream": true, "selectedOutputs": ["agent1.content"]}'

响应格式

data: {"blockId":"...","chunk":"One"}
data: {"blockId":"...","chunk":", two"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]

文件上传格式

{
  "documents": [{
    "type": "file",
    "data": "data:application/pdf;base64,JVBERi0xLjQK...",
    "name": "document.pdf",
    "mime": "application/pdf"
  }]
}

工作流只能包含一个 API 触发器。更改后请发布新部署，以使端点保持最新。

API 触发器

On this page