ワークフローを実行
対象アプリ：Workflow。
アプリの公開済みワークフローを実行し、その出力を返します。単一の blocking レスポンス、または streaming の Server-Sent Events フィードのいずれかで返します。公開済みのワークフローが必要です。
curl --request POST \
--url https://{api_base_url}/workflows/run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": {
"query": "Translate this to French: Hello world"
},
"response_mode": "blocking",
"user": "user_workflow_456"
}
'{
"data": {
"created_at": 1705407629,
"elapsed_time": 1.23,
"error": null,
"finished_at": 1705407630,
"id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
"outputs": {
"result": "Bonjour le monde"
},
"status": "succeeded",
"total_steps": 3,
"total_tokens": 150,
"workflow_id": "7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345"
},
"task_id": "c3800678-a077-43df-a102-53f23ed20b88",
"workflow_run_id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156"
}Authorizations
すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。
Body
ワークフロー入力変数のキーと値のペアです。アプリが期待する変数名と型は、アプリケーションのパラメータ情報を取得 の user_input_form フィールドで確認できます。
ファイル型の変数には、type、transfer_method、および url または upload_file_id を持つファイルオブジェクトの配列を渡します。
Show child attributes
Show child attributes
エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。データアクセスをスコープします。ワークフロー実行とそのファイルは、同じ user を持つ後続のリクエストにのみ表示されます。エンドユーザーの識別 を参照してください。
ファイルリストです。ファイルとテキストを組み合わせて入力する場合に適しており、モデルが Vision 機能をサポートしている場合にのみ使用できます。ローカルファイルを添付するには、まず ファイルをアップロード でアップロードし、返された id を upload_file_id として transfer_method: local_file で使用します。
- Option 1
- Option 2
Show child attributes
Show child attributes
レスポンスモードです。同期レスポンスには blocking（Cloudflare タイムアウトは 100 s）、サーバー送信イベントには streaming を使用します。省略した場合、デフォルトはブロッキング動作になります。
streaming, blocking Response
リクエスト成功。コンテンツタイプと構造はリクエストの response_mode パラメータに依存します。
response_modeがblockingの場合、application/jsonでWorkflowBlockingResponseオブジェクトを返します。response_modeがstreamingの場合、text/event-streamでChunkWorkflowEventオブジェクトのストリームを返します。
Show child attributes
Show child attributes
進行中の実行のタスク ID です。ワークフロータスクを停止 と組み合わせて、実行中のワークフローをキャンセルします。実行中のみ有効です。
このワークフロー実行記録の永続的な識別子です。ワークフロー実行詳細を取得 と組み合わせて、実行後に結果を取得します。
Was this page helpful?
curl --request POST \
--url https://{api_base_url}/workflows/run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": {
"query": "Translate this to French: Hello world"
},
"response_mode": "blocking",
"user": "user_workflow_456"
}
'{
"data": {
"created_at": 1705407629,
"elapsed_time": 1.23,
"error": null,
"finished_at": 1705407630,
"id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
"outputs": {
"result": "Bonjour le monde"
},
"status": "succeeded",
"total_steps": 3,
"total_tokens": 150,
"workflow_id": "7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345"
},
"task_id": "c3800678-a077-43df-a102-53f23ed20b88",
"workflow_run_id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156"
}