API 触发器

概述

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

配置输入格式

为每个参数添加一个 输入格式 字段。运行时输出键会镜像该模式，并且也可以在 <api.input> 下使用。

- type: string
  name: userId
  value: demo-user # optional manual test value
- type: number
  name: maxTokens

编辑器中的手动运行使用 value 列，因此您可以在不发送请求的情况下进行测试。在执行期间，解析器会填充 <api.userId> 和 <api.input.userId>。

请求示例

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

成功的响应会返回来自执行器的序列化执行结果。错误会显示验证、身份验证或工作流失败的原因。

输出参考

如果未定义输入格式，执行器仅在 <api.input> 处公开原始 JSON。