ワークフローを実行

対象アプリ：Workflow。

ワークフローを実行します。公開済みのワークフローがないと実行できません。

POST /workflows/run

cURL

streaming_example

curl --request POST \
  --url https://{api_base_url}/workflows/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": {
    "query": "Summarize this text: The quick brown fox jumps over the lazy dog."
  },
  "response_mode": "streaming",
  "user": "user_workflow_123"
}
'

200

blockingResponse

{
  "task_id": "c3800678-a077-43df-a102-53f23ed20b88",
  "workflow_run_id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
  "data": {
    "id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
    "workflow_id": "7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345",
    "status": "succeeded",
    "outputs": {
      "result": "Bonjour le monde"
    },
    "error": null,
    "elapsed_time": 1.23,
    "total_tokens": 150,
    "total_steps": 3,
    "created_at": 1705407629,
    "finished_at": 1705407630
  }
}

Authorizations

Authorization · string · header · required

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。API Key が欠落または無効な場合、HTTP 401 とエラーコード unauthorized が返されます。

Body

application/json

inputs · object · required

ワークフロー入力変数のキーと値のペアです。ファイル型変数の値は、type、transfer_method、および url または upload_file_id を持つファイルオブジェクトの配列である必要があります。アプリが期待する変数名と型については、アプリケーションのパラメータ情報を取得 レスポンスの user_input_form フィールドを参照してください。

Show child attributes

user · string · required

開発者のルールで定義されるユーザー識別子で、アプリケーション内で一意である必要があります。この識別子はデータアクセスの範囲を限定します——ワークフロー実行とファイルは同じ user 値でクエリした場合にのみ表示されます。

response_mode · enum<string>

レスポンスモードです。同期レスポンスには blocking（Cloudflare タイムアウトは 100 s）、サーバー送信イベントには streaming を使用します。省略した場合、デフォルトはブロッキング動作になります。

Available options: streaming, blocking

files · object[] | null

ファイルリストです。ファイルとテキストを組み合わせて入力する場合に適しており、モデルが Vision 機能をサポートしている場合にのみ使用できます。ローカルファイルを添付するには、まず ファイルをアップロード でアップロードし、返された id を upload_file_id として transfer_method: local_file で使用します。

Option 1

Option 2

Show child attributes

Response

200

application/json

リクエスト成功。コンテンツタイプと構造はリクエストの response_mode パラメータに依存します。

• response_mode が blocking の場合、 application/json で WorkflowBlockingResponse オブジェクトを返します。
• response_mode が streaming の場合、 text/event-stream で ChunkWorkflowEvent オブジェクトのストリームを返します。

task_id · string<uuid>

進行中の実行のタスク ID です。ワークフロータスクを停止 と組み合わせて、実行中のワークフローをキャンセルします。実行中のみ有効です。

workflow_run_id · string<uuid>

このワークフロー実行記録の永続的な識別子です。ワークフロー実行詳細を取得 と組み合わせて、実行後に結果を取得します。

data · object

Show child attributes