ワークフローを実行
対象アプリ:Workflow。
アプリの公開済みワークフローを実行し、その出力を返します。単一の blocking レスポンス、または streaming の Server-Sent Events フィードのいずれかで返します。公開済みのワークフローが必要です。
承認
すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。
ボディ
ワークフロー入力変数のキーと値のペアです。アプリが期待する変数名と型は、アプリケーションのパラメータ情報を取得 の user_input_form フィールドで確認できます。
ファイル型の変数には、type、transfer_method、および url または upload_file_id を持つファイルオブジェクトの配列を渡します。
エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。データアクセスをスコープします。ワークフロー実行とそのファイルは、同じ user を持つ後続のリクエストにのみ表示されます。エンドユーザーの識別 を参照してください。
レスポンスモードです。同期レスポンスには blocking(Cloudflare タイムアウトは 100 s)、サーバー送信イベントには streaming を使用します。省略した場合、デフォルトはブロッキング動作になります。
streaming, blocking ファイルリストです。ファイルとテキストを組み合わせて入力する場合に適しており、モデルが Vision 機能をサポートしている場合にのみ使用できます。ローカルファイルを添付するには、まず ファイルをアップロード でアップロードし、返された id を upload_file_id として transfer_method: local_file で使用します。
- Option 1
- Option 2
レスポンス
リクエスト成功。コンテンツタイプと構造はリクエストの response_mode パラメータに依存します。
response_modeがblockingの場合、application/jsonでWorkflowBlockingResponseオブジェクトを返します。response_modeがstreamingの場合、text/event-streamでChunkWorkflowEventオブジェクトのストリームを返します。
進行中の実行のタスク ID です。ワークフロータスクを停止 と組み合わせて、実行中のワークフローをキャンセルします。実行中のみ有効です。
このワークフロー実行記録の永続的な識別子です。ワークフロー実行詳細を取得 と組み合わせて、実行後に結果を取得します。