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}'

成功したレスポンスはエグゼキュータからのシリアル化された実行結果を返します。エラーは検証、認証、またはワークフローの失敗を表示します。

出力リファレンス

入力フォーマットが定義されていない場合、エグゼキュータは生のJSONを<api.input>でのみ公開します。