メインコンテンツへスキップ
POST
ID でワークフローを実行

承認

Authorization
string
header
必須

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401unauthorized)で失敗します。

パスパラメータ

workflow_id
string
必須

実行する公開済みワークフローバージョンです。ワークフローを実行 のレスポンスおよび ワークフロー実行詳細を取得workflow_id フィールドで返されます。公開済みバージョンを指定する必要があります。ドラフトバージョンの ID は bad_request で拒否されます。

ボディ

application/json
inputs
object
必須

ワークフロー入力変数のキーと値のペアです。アプリが期待する変数名と型は、アプリケーションのパラメータ情報を取得user_input_form フィールドで確認できます。

ファイル型の変数には、typetransfer_method、および url または upload_file_id を持つファイルオブジェクトの配列を渡します。

user
string
必須

エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。データアクセスをスコープします。ワークフロー実行とそのファイルは、同じ user を持つ後続のリクエストにのみ表示されます。エンドユーザーの識別 を参照してください。

response_mode
enum<string>

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

利用可能なオプション:
streaming,
blocking
files
object[] | null

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

レスポンス

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

  • response_modeblocking の場合、 application/jsonWorkflowBlockingResponse オブジェクトを返します。
  • response_modestreaming の場合、 text/event-streamChunkWorkflowEvent オブジェクトのストリームを返します。
task_id
string<uuid>

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

workflow_run_id
string<uuid>

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

data
object