デプロイ環境

​

ベース URL

​

認証

curl https://api.example.com/v2/workflows/run \
  -H "Authorization: Bearer $DIFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"inputs": {}, "response_mode": "blocking", "user": "user-123"}'

​

対応するエンドポイント

• Workflow アプリの場合：
  • ワークフローを実行
  • ワークフロータスクを停止
• Chatflow アプリの場合：
  • チャットメッセージを送信
  • チャットメッセージの生成を停止
  • 会話一覧を取得
  • 会話を削除
  • 会話の名前を変更
  • 会話履歴メッセージ一覧を取得
  • 会話変数一覧を取得
  • 会話変数を更新
• 両方のアプリタイプの場合：
  • ファイルをアップロード
  • ファイルをダウンロード

​

エラー

{
  "code": "deployment_not_ready",
  "message": "deployment is in progress",
  "status": 503
}

• 認証情報が無効な場合やデプロイを利用できない場合、実行系とアップロード系の操作は次のエラーでリクエストを拒否します。対象は、ワークフローの実行と停止、チャットの送信と停止、ファイルのアップロードです。

  エラーコード	ステータス	意味
  token_invalid	401	API キーがない、形式が不正、または不明です。
  unauthorized	401	API キーが取り消されています。
  forbidden	403	アクセスポイント で、この環境の API アクセスが無効になっています。
  deployment_undeployed	503	この環境からアプリがアンデプロイされています。提供を再開するにはバージョンをデプロイしてください。
  deployment_not_ready	503	デプロイが進行中です。しばらくしてから再試行してください。
  apprunner_not_deployed	503	環境が利用できません。環境が削除中の場合や、稼働していない場合、接続できない場合などに発生します。プラットフォームの管理者に環境の確認を依頼してください。
  service_not_ready	503	デプロイされたバージョンが、この環境でまだ提供できる状態になっていません。読み込み中や入れ替え中などに発生します。しばらくしてから再試行してください。
  enterprise_unavailable	503	プラットフォーム側のルーティングサービスが一時的に利用できません。しばらくしてから再試行してください。

• 会話管理とファイルのダウンロードは、次のエラーを返します。
  • 無効なキーに対しては 401 unauthorized。
  • アプリの API アクセスが無効な場合、またはこの環境でアプリがデプロイされ利用可能になっていない場合は 400 app_unavailable。
• ワークフローの実行やチャットリクエストが、環境の最大実行時間（デフォルトは 20 分）を超えると、request_timeout で停止します。ブロッキングモードでは HTTP 504 が、ストリーミングモードでは status: 504 を持つ error イベントが返ります。 この上限を決める設定については、デプロイ環境（App Runner） の enterprise.workflowMaxExecutionTimeSeconds を参照してください。