ディファイAPI
無料
Dify API は、
Dify API: プログラマブル インターフェイスとしてオープンな LLM アプリケーション オーケストレーション機能
コアパラメータと統計
Dify API は独立したクラウド サービスではなく、Dify プラットフォームの API サービス層です。Dify のビジュアル ワークフロー エンジン、RAG ナレッジ ベース エージェント ビルダー、モデル ゲートウェイの機能を RESTful インターフェイスを介して外部システム コールに公開します。製品形態の観点から見ると、Dify API は Dify が「社内オーケストレーション ツール」から「プラットフォーム インフラストラクチャ」に移行するための重要な橋渡しとなります。
| プロジェクト | 広報 |
|---|---|
| 公式の位置づけ | Dify プラットフォームの RESTful API サービス層 |
| インターフェースプロトコル | REST (HTTP/HTTPS) + JSON |
| 認証方法 | API キー (アプリレベル) + トークン (セッションレベル) |
| コアエンドポイントのカバレッジ | ワークフローの実行、セッション管理、ナレッジベースの取得、ドキュメントのアップロード、アプリケーション管理 |
| 実行モード | 同期 (ブロッキング待機) / 非同期 (コールバックまたはポーリング) |
| API ドキュメント | OpenAPI 3.0 仕様 (プラットフォーム バージョンに合わせて更新) |
| SDK サポート | Python、JavaScript/TypeScript (コミュニティ + 公式メンテナンス) |
| レート制限 | パッケージ レベルごとに分けられます (無料バージョンでは 1 日あたり 200 メッセージ、プロフェッショナル バージョンでは無制限) |
| 導入方法 | クラウド バージョンは自動的に有効になります / セルフホスト バージョンは API ゲートウェイを構成する必要があります |
| プラットフォームのバージョンと同期 | Dify プラットフォームのバージョン番号と一致します (現在 v1.14.2)。 |
位置づけの違い: Dify API と Dify Web Console の関係は、Stripe API と Stripe Dashboard に似ています。前者はプログラム呼び出しのためのオーケストレーション層であり、後者は人間による操作のためのグラフィカル インターフェイスです。この 2 つは同じワークフロー エンジンとナレッジ ベース パイプラインを共有しており、唯一の違いは対話の入り口にあります。開発者がコンソールではなく API を選択する主な理由は、「自動統合」です。つまり、ユーザーが操作のために Dify インターフェイスに切り替えるのではなく、AI ワークフローを既存のビジネス システムに組み込むことです。
使用モードの違い: Dify API は、同期実行モードと非同期実行モードの両方をサポートします。同期モードは、単純な質問と回答のシナリオに適しています (要求と応答は 30 秒以内に完了します)。非同期モードは、長時間実行されるワークフロー (複数ステップのエージェント タスク、大規模な RAG 取得と生成など) に適しており、最終結果は Webhook コールバックまたはポーリングを通じて取得されます。このデュアルモード設計は、オンラインの低遅延とオフラインのバッチ処理という 2 つの一般的な要件をカバーします。
ユーザーと市場の認識
Dify API のユーザー グループは Dify プラットフォームと非常に重複していますが、その技術プロファイルはより強力な「開発者指向」の機能を示しています。
採用データ: Dify プラットフォームのコミュニティ ベース GitHub 143,000 個以上のスターと 22,000 個以上のフォークの中で、API ユーザーはアクティブな開発者の一定の割合を占めています。これは、GitHub の問題に頻繁に表示される API 統合の問題、SDK ウェアハウスのスターの数、および npm/PyPI ダウンロードの数から確認できます。登録済みワークスペースの Dify Cloud バージョンでは、Web コンソールではなく API を通じて作成されたアプリケーションの割合は (コミュニティの議論によると) 20 ~ 30% と推定されており、増加傾向にあります。
典型的な統合シナリオ: 公開事例によると、企業顧客が Dify API を使用する典型的なパターンには、既存の CRM/ERP システムへの AI ワークフローの組み込み、API を介した自社構築ナレッジ ベース アプリケーションの接続、企業の WeChat/Feishu/DingTalk への AI Q&A ロボットの統合が含まれます。これらのシナリオに共通する特徴は、「元のシステムを変更せず、AI オーケストレーション レイヤーのみを追加する」ことです。Dify API は、古いシステムと新しいシステムの間の接着層として機能します。
競合 API との比較: 「プログラマブル LLM オーケストレーション API」のセグメントでは、Dify API の直接ベンチマーク製品には Coze API (ByteDance)、Flowise API、LangFlow API が含まれます。 Dify API の主な違いは「プラットフォームの完全性」にあります。他の 3 つは外部 RAG 機能 (Flowise/LangFlow) を必要とするか、セルフホストできない (Coze) のいずれかですが、Dify API は RAG 組み込み、セルフホスト型展開、およびモデル ゲートウェイの 3 つの側面を同時に満たしています。
| 寸法の比較 | ディファイAPI | Coze API | フローワイズ API | LangFlow API |
|---|---|---|---|---|
| RAG ナレッジベース API | ✅ 組み込みの完全な検索エンドポイント | ✅ 内蔵 | ❌ 外部プラグインが必要 | ❌ 外部プラグインが必要 |
| ワークフロー実行 API | ✅ 同期 + 非同期 | ✅ 同期 | ✅ 同期 | ✅ 同期 |
| モデルゲートウェイ API | ✅ 統合管理 + ルーティング | ❌ なし | ❌ なし | ❌ なし |
| セルフホスト型展開 | ✅ コミュニティバージョンは無料で構築可能 | ❌ クラウドのみ | ✅ ドッカー | ✅ ドッカー |
| API ドキュメント仕様 | OpenAPI 3.0 | カスタム | カスタム | カスタム |
| レート制限の透明性 | パッケージシステム、プロフェッショナル版は上限なし | 毎月の制限があります | 公式制限なし | 公式制限なし |
市場での認識の結論: Dify API は、「セルフホスティング + 組み込み RAG + 完全なワークフロー オーケストレーションが必要」の交差点に適切な位置にあります。すでに Dify Web コンソールを使用してアプリを構築しているチームにとって、API は自然な機能拡張であり、学習曲線が短く、テクノロジー スタックを切り替える必要がありません。
コストメリット
Dify API のコスト分析は、Dify プラットフォームの全体的な価格設定にリンクする必要があります。API 自体は別途課金されず、その呼び出し割り当てとレート制限は Dify パッケージによって決定されます。これは、API の限界コストがゼロに近いことを意味します。プラットフォームの料金はすでに支払っているため、API 呼び出しは付加価値機能に組み込まれています。
C サイドおよび個人開発者:
- 明示的なコスト: クラウドの無料バージョンには 1 日あたり 200 のメッセージ割り当てがあり、API 呼び出しは同じメッセージ割り当てに対してカウントされます。制限を超えた場合は、パッケージをアップグレードする必要があります。コミュニティ版のセルフホスティングは完全無料で、サーバー費用のみ負担(最小2コア4GBインスタンス、月額料金は50~200円程度)。
- 隠れたコスト: 自己ホスト型の場合の API ゲートウェイのデプロイ構成 (Nginx リバース プロキシ HTTPS 証明書 API キー管理)。クラウド バージョンの API 応答遅延はネットワーク状況の影響を受けるため、国境を越えたアクセスには追加の高速化ソリューションが必要になる場合があります。
- 推奨パス: プロトタイプ検証期間中はクラウド無料バージョンを使用します。予算に敏感で、特定の運用および保守機能を持つ個人の開発者は、セルフホスティング用のコミュニティ バージョンを選択します。
API 開発者および小規模チーム:
- 明示的なコスト: Dify Cloud Pro ワークスペースあたり月額 59 ドル、API 呼び出し制限なし。モデル API 料金は追加です (開発者はモデル サプライヤーに直接支払い、Dify は手数料を受け取りません)。年払いで約 15 ~ 20% の割引を受けられます。
- 隠れたコスト: 無料バージョンからプロフェッショナル バージョンにアップグレードする場合、API キーと権限を再構成する必要があります。コミュニティ バージョンからクラウド バージョンへの API の移行には、データのエクスポートが含まれます。
- 推奨パス: 3 ~ 10 人のチームにフルタイムの運用と保守が存在しない場合、月額 59 ドルの Cloud Professional Edition のコストは、セルフホスト型インフラストラクチャ + 運用と保守の人件費よりも低くなります。
企業の民営化展開:
- 明示的なコスト: エンタープライズ バージョンの価格はビジネス上の確認が必要です (業界の慣例に基づいて、年間 2,000 ~ 20,000 ドルと推定されます)。 API サービス自体は、Enterprise Edition 展開パッケージに含まれています。
- 隠れたコスト: 民営化された展開における API の運用および保守コスト (API ゲートウェイの高可用性構成、アラームの監視、ログ収集、アップグレード互換性テスト)。企業内部 API のセキュリティ ガバナンス (API キーのローテーション、アクセス監査)。
- 推奨パス: 金融、医療、官公庁などの規制対象業界は、エンタープライズ バージョンの評価を優先します。エンタープライズ バージョンのコンプライアンス価値 (データ主権 + 監査ログ) は、純粋な API 機能自体よりも高くなります。
3 段階のコストの比較:
| コストのディメンション | コミュニティ API (自己ホスト型) | クラウドプロフェッショナル API | エンタープライズ API |
|---|---|---|---|
| APIライセンス料 | $0 | 月額 59 ドルのプランに含まれています | エンタープライズ契約に含まれる |
| インフラストラクチャのコスト | $10-30/月 (サーバー) | サブスクリプションに含まれています | 自己負担または契約に含まれる |
| モデル API 料金 | 追加 | 追加 | 同梱可能、交渉可能 |
| API運用保守マンパワー | チームで準備する必要がある | 必要ありません | 導入モードによって異なります |
| レート制限 | なし (自動) | 無制限 | カスタム |
| データ主権 | 完全自律型 | Dify Cloud でホスト | プライベート クラウド/オンプレミス |
主な機能
Dify API の中核機能は、「Dify プラットフォームの機能をプログラム可能なインターフェイスとしてオープンにする」という目標を中心に展開しています。 Web コンソールのボタンを REST エンドポイントに単純にマッピングするのではなく、各機能の API セマンティクスが統合シナリオ向けに設計されています。
-
ワークフロー実行 API:
POST /workflows/runおよびPOST /workflows/run-asyncエンドポイントを通じて AI ワークフロー実行をトリガーし、初期変数とコンテキストの受け渡しをサポートします。 相乗効果: ワークフロー API は、Dify のビジュアル オーケストレーション エンジンと同じ実行ランタイムを共有します。Web コンソールでデバッグされたワークフローは、API 経由で呼び出された場合とまったく同じように動作するため、API 統合シナリオ用に個別のオーケストレーションを行う必要がなくなります。 「一度配置すれば、多くの場所で呼び出す」モデルにより、従来の統合における「テストにはコンテキストがあり、本番にはコンテキストが存在する」という分離の問題が回避されます。 -
セッション管理 API:
POST /chat-messagesエンドポイントを通じて会話セッションを作成および管理し、マルチラウンド会話コンテキストの自動メンテナンスをサポートします。 相乗効果: セッション管理 API とワークフロー API は連続して使用できます。複雑な複数ステップのタスクを「セッション永続化コンテキスト -> ワークフロー実行 -> 結果をセッションに書き戻す」というサイクルに分解して、ステートフル AI インタラクション プロセスを実現できます。 -
ナレッジ ベース取得 API:
POST /datasets/:id/retrieveエンドポイントを通じて、指定されたナレッジ ベースから関連するドキュメントのフラグメントを取得し、ベクトル検索、フルテキスト検索、およびハイブリッド検索の 3 つのモードをサポートします。 相乗効果: 取得 API は、LLM 呼び出しとは独立して使用できます。外部システムは、最初に取得 API を呼び出して知識フラグメントを取得し、次にそのフラグメントを LLM に渡すかどうか、またその方法を独自に決定します。この「取得と生成の分離」モードは、プロンプト構築に対する細かい制御が必要なシナリオで非常に実用的です。 -
ドキュメント管理 API: ドキュメントのアップロード (
POST /datasets/:id/document)、削除、更新、ステータス クエリのエンドポイントを提供します。 相乗効果: ドキュメント管理 API と検索 API は連携して、ナレッジ ベースの「ホット アップデート」を実現します。外部システムは API を介して新しいドキュメントを段階的にアップロードし、ナレッジ ベースのインデックスを手動で更新することなく、検索の終了が即座に有効になります。 -
アプリケーション管理および構成 API: アプリケーション パラメーターの取得、アプリケーション設定の更新、API キーの管理など、一連の
GET/POST /appsエンドポイントを通じて Dify アプリケーションのライフ サイクル (作成、クエリ、更新、削除) を管理します。 相乗効果: アプリケーション管理 API を使用すると、DevOps チームは Dify アプリケーションの作成と構成を CI/CD パイプラインに組み込むことができます。新しい境界デプロイメント中にアプリケーションの作成、モデルの構成、API キーの設定が自動的に行われ、手動構成の省略のリスクが軽減されます。 -
テキスト生成 API:
POST /completion-messagesエンドポイントを通じて Dify ワークフローの LLM ノードを直接呼び出して、テキスト生成タスクを完了します。翻訳、要約、コピーライティングの生成、および複数回の対話を維持する必要のないその他のシナリオに適しています。 -
ファイル アップロード API:
POST /files/uploadを介した画像やドキュメントなどのファイルのアップロードをサポートし、ワークフローの実行または会話メッセージでアップロードされたファイルを参照します。アップロードされたファイルは、関連するナレッジ ベースに自動的に分類されるか、ワークフロー ノードとして入力されます。
シナジーの概要: Dify API の価値は、個々のエンドポイントの機能ではなく、それらを組み合わせる機能にあります。たとえば、典型的な「スマート カスタマー サービス」統合リンク: ドキュメント管理 API (製品マニュアルのアップロード) → ナレッジ ベース取得 API (インデックスの構築) → ワークフロー実行 API (取得 + LLM 生成 + エージェント ツール呼び出し) → セッション管理 API (複数ラウンドの会話コンテキストの維持)。 4 つのエンドポイントを組み合わせることで、エンドツーエンドのインテリジェントな質問と回答システムが完成し、各エンドポイントは独立して他のシナリオに対応できます。
モデルとバージョンの進化
Dify API のバージョンは Dify プラットフォームのバージョンにバインドされており、API の反復リズムはプラットフォームのメインライン バージョンに従います。正式バージョンの v1.0 から現在の v1.14.x まで、API レイヤーは「基本的に利用可能」から「完全にカバー」への進化を経験しました。
API バージョンのコンテキスト
-
v1.0 (2025-01-01): マイルストーン バージョン。 Dify プラットフォーム v1.0 と同期して、API レイヤーは正式に運用準備段階に入りました。ワークフローの実行、セッション管理、ナレッジ ベースの取得という 3 つのコア エンドポイントを完全に提供します。 OpenAPI 3.0 仕様ドキュメントと Python/JS SDK の最初のバージョンをリリースしました。
-
v1.5 (2025-06): 実行結果の Webhook コールバック通知をサポートするために、非同期ワークフロー実行エンドポイント (
/workflows/run-async) を追加しました。ナレッジ ベース検索 API は、ハイブリッド検索パラメーター (search_methodフィールド) を追加します。ファイルアップロード API はオンラインです。 -
v1.10 (2025-12): アプリケーション管理 API シリーズのエンドポイントはオンラインであり、API を介した Dify アプリケーションの作成と管理をサポートします。テキスト生成 API (
/completion-messages) は独立してリリースされており、セッション コンテキストに依存せずに単一のテキスト生成タスクを完了できます。 -
v1.14.0 (2026-04-29): プラットフォーム エージェント アーキテクチャのアップグレードにより、エージェント オーケストレーション関連のエンドポイントが更新されます。 API により、ツール呼び出し結果の戻り形式の改善がエージェント ノードに追加されます。レート制限戦略が最適化され、Professional Edition 以降では API 呼び出しの上限が解除されます。
-
v1.14.1 (2026-05-12): セキュリティ強化 - API キーのローテーション メカニズムの改善、リクエストの署名検証の強化。ワークフロー API の安定性の向上 - タイムアウト処理がより予測可能になり、エラー応答形式が標準化されました。
-
v1.14.2 (2026-05-19): 継続的なセキュリティ強化とバグ修正。エージェントの基礎となるアーキテクチャが改善され (その後の高度なエージェント機能への道が開かれるため)、API レベルがエージェント ノード出力の構造の最適化に反映されます。
バージョンの機能の概要
- プラットフォームのバージョン番号でロック: API バージョンには独立した番号が付けられておらず、Dify プラットフォームのバージョンと一致しています。これにより、バージョン管理の複雑さが軽減されますが、API レベルでの変更には、純粋な API の変更ではなく、プラットフォーム機能の更新が含まれる可能性があることを意味します。
- RAG 機能が最初に成熟します: ナレッジ ベース検索 API は、「ナレッジ管理」シナリオに対する Dify の戦略的重点を反映して、すべてのエンドポイントの中で最も高速な反復を実現します。
- 非同期機能は徐々に完成しつつあります: v1.0 の同期実行から v1.5 の非同期サポート、そしてその後の Webhook およびポーリング メカニズムに至るまで、API の実行モードは徐々に成熟してきました。
- セキュリティとガバナンスはバージョンごとに強化されています: v1.14.x シリーズではセキュリティの強化について何度も言及しており、API レイヤーが「利用可能な機能」から「エンタープライズ レベルのセキュリティ」に移行していることを示しています。
技術的な利点
Dify API の技術的利点は、単一アルゴリズムのリーダーシップにあるのではなく、「アーキテクチャの統一性」と「エンジニアリングの深さ」にあります。Dify プラットフォームの複雑なワークフロー エンジン RAG パイプライン エージェント ランタイムとモデル ゲートウェイを、意味的に一貫した REST API のセットに統合します。
統合実行ランタイム
Dify API が呼び出されると、リクエストは有向グラフ (DAG) に基づく実行フレームワークである Dify のワークフロー エンジンに入ります。 API リクエストのパラメータはワークフロー入力変数にマッピングされ、エンジンはそれらを事前定義されたノード トポロジで順番に実行し、最終的に出力を JSON レスポンスにシリアル化します。この設計の中心的な価値は次のとおりです。 Web コンソールと API 実行パスは完全に一貫しています - 同じワークフローがキャンバス上のテストに合格した後、理論的には API 呼び出しによる動作が 100% 再現されるはずです。
メカニズム -> 効果 -> シナリオ: ランタイムの統合実行により、「テスト コンテキストと本番コンテキストの間でパフォーマンスの不一致」のリスクが排除されます。 Dify API を顧客向けシステム (顧客サービス ボット、レポート ジェネレーターなど) に統合するチームにとって、これは、ワークフロー オーケストレーター (おそらく非技術的な役割) と API 統合エンジニアが並行して作業し、それぞれが独自のツールチェーンで結果を検証し、最終的に本番環境にシームレスに統合できることを意味します。
REST API の階層化設計
Dify API は、アーキテクチャ的に 3 つの論理レイヤーに分割されています。
- アクセス レイヤー (API ゲートウェイ): リクエスト認証 (API キー検証)、レート制限、リクエスト ログ、およびクロスドメイン構成を処理します。セルフホスト型の展開では、このレイヤーは通常、Nginx または Kubernetes Ingress によって実装されます。
- オーケストレーション レイヤー (ワークフロー エンジン): API リクエスト パラメーターを解析し、ワークフロー実行コンテキストをインスタンス化し、DAG ノードの実行シーケンスをスケジュールします。この層は Dify API の中核であり、RESTful リクエスト セマンティクスをワークフロー実行セマンティクスに変換します。
- リソース レイヤー (サービス アダプター): モデル サプライヤー API、ベクター データベース、ファイル ストレージなどの外部リソースに接続します。 API 呼び出し元はこれらのバックエンド リソースの存在を直接認識せず、すべての適応ロジックはオーケストレーション層の下にカプセル化されます。
メカニズム -> 効果 -> シナリオ: 階層化された設計により、API 呼び出し元は、どのモデルがバックエンドに接続されているか、どのベクトル データベースが使用されているかを気にすることなく、「どのパラメーターが渡され、どのような結果が取得されるか」だけに集中できます。バックエンド リソースが切り替えられるとき (OpenAI から DeepSeek へなど)、API エンドポイントと応答形式は完全に変更されず、呼び出し元は変更されません。
ハイブリッド RAG 取得 API の技術的実装
Dify API のナレッジ ベース検索エンドポイントの背後には、次の 3 つの検索戦略をサポートする Dify のハイブリッド検索エンジンがあります。
- ベクトル取得 (密): 埋め込みモデルを使用して、クエリとドキュメントのフラグメントをセマンティック ベクトル空間にマッピングし、コサイン類似度を計算します。意味的な一致のシナリオには適していますが、専門用語の正確な一致には敏感ではありません。
- 全文検索 (Sparse/BM25): キーワード マッチングに基づく従来の情報検索方法。正確なヒットのシナリオに適していますが、セマンティックの変化には影響されません。
- ハイブリッド検索 (ハイブリッド): 構成可能な重みに従って密と疎の検索結果を融合し、再ランク モデルを通じて融合結果を調整します。
メカニズム -> 効果 -> シナリオ: ハイブリッド検索は、search_method パラメーターを通じて API レベルで呼び出し元に公開されます。 「意味の理解 + 正確なキーワード ヒット」の両方が重要である法的契約書の取得などのシナリオでは、ハイブリッド モードを選択し、dense_weight=0.6、sparse_weight=0.4 を設定すると、通常、単一検索モードと比較して最初のヒット率が 15 ~ 25% 向上します。 Rerank ステップでは、さらに約 100 ~ 300 ミリ秒の遅延が発生します。遅延の影響を受けやすいリアルタイムの質問と回答のシナリオでは、要件に基づいて有効または無効にすることができます。
Dify API ツールのオープンリスト
Dify API は、コア エンドポイント (つまり、「ツール セット」) を呼び出し元に公開します。各エンドポイントは、完全な API インタラクションに対応します。
| エンドポイント パス | HTTPメソッド | 動作の説明 | 対応するシナリオ |
|---|---|---|---|
/チャットメッセージ |
投稿 | 会話メッセージを送信してワークフローまたはエージェントの応答をトリガーする | インテリジェントQ&A、顧客サービスロボット |
/workflows/run |
投稿 | ワークフローの同期実行をトリガーし、ブロックして戻りを待ちます。決定的なタスク (記事の生成、レポート) | |
/workflows/run-async |
投稿 | ワークフローの非同期実行をトリガーし、task_id を返します。長期的なタスク (バッチ処理、詳細な分析) | |
/workflows/tasks/:id |
入手 | 非同期タスクの実行ステータスと結果をクエリする | 非同期タスクの進行状況の追跡 |
/datasets/:id/retrieve |
投稿 | 関連する文書の断片をナレッジ ベースから取得する | RAG Q&A、知識検索 |
/datasets/:id/document |
投稿 | ドキュメントをナレッジ ベースにアップロードする | ナレッジベースのバッチビルド |
/datasets/:id/document/:doc_id |
削除 | ナレッジ ベースからドキュメントを削除する | ナレッジベースの更新とメンテナンス |
/完了メッセージ |
投稿 | 単一のテキスト生成、セッション維持なし | 翻訳、要約、コピーライティングの生成 |
/files/upload |
投稿 | 後で参照できるようにファイル (写真、ドキュメント) をアップロードします。マルチモーダル入力、文書処理 | |
/アプリ |
取得/投稿 | アプリケーション一覧クエリ / 新規アプリケーション作成 | アプリケーションのライフサイクル管理 |
/apps/:id/api-keys |
取得/投稿 | API キー管理 | セキュリティ ガバナンスとキーのローテーション |
インタラクションの説明: 一般的な「ドキュメントの質問と回答」統合プロセスは、API エンドポイントのチェーン呼び出しを通じて完了します - POST /files/upload (製品マニュアルのアップロード) → POST /datasets/:id/document (ナレッジ ベースに組み込まれます) → POST /chat-messages (ユーザーの質問、ワークフロー内部呼び出し /datasets/:id/retrieve 取得 + LLM 生成)回答) → 最終回答を返します。プロセス全体は、ユーザーが Dify コンソールに触れることなく、外部システムの UI で完了します。
エンジニアリングの落とし穴ガイド
Dify API のアーキテクチャ上の特徴とコミュニティからのフィードバックに基づいて、本番環境の統合における一般的な問題と対応戦略を以下に示します。
-
API タイムアウトとワークフロー実行時間が制御不能になる: 複雑なワークフロー (複数の LLM ノード チェーン呼び出し + ナレッジ ベースの取得 + エージェント ツール呼び出し) の 1 回の実行が 60 秒を超え、タイムアウトと API ゲートウェイの切断がトリガーされる場合があります。 解決策: タイムアウトになる可能性があるシナリオには非同期モード (
/workflows/run-async) を一律に使用し、適切な Webhook コールバック URL を設定します。同期モードは、応答時間が予測可能な単純なワークフローにのみ使用されます (実行時間のしきい値を 30 秒未満に設定することをお勧めします)。ワークフロー設計レベルでは、単一ノードが大量のトークンを消費して実行時間が長くなるのを防ぐために、主要な LLM ノードに「max_tokens」の上限を設定できます。 -
API キーの漏洩と国境を越えた許可: Dify API キーをクライアント アプリケーション (Web フロントエンドやモバイル アプリなど) に直接埋め込むと、キー漏洩のリスクが伴います。攻撃者は漏洩したキーを使用して、無料割り当てを使い果たしたり、高コストのモデル呼び出しをトリガーしたりする可能性があります。 解決策: Dify API キーはバックエンド サービスに保持する必要があります。クライアント リクエストは最初に自己構築されたバックエンドに到達し、次にバックエンドは Dify API を呼び出すための API キーを伝えます。書き込みまたは削除操作(ドキュメントの削除、アプリケーション構成の変更)を伴うエンドポイントの場合、ビジネス層で二次確認または操作監査ログを設定します。 Dify Cloud Professional Edition 以降では、IP ホワイトリストと API キーのスコープ制限がサポートされています。
-
一貫性のないナレッジ ベースの取得結果: 同じクエリが、異なる時点で同じナレッジ ベースに対して
/datasets/:id/retrieveを呼び出し、異なる結果を返します。これは、ドキュメント更新時のインデックスの非同期、ベクトル データベースの一貫性の遅延、または埋め込みモデルのバージョンの切り替えが原因である可能性があります。 解決策: ドキュメントが更新された後、取得を実行する前に、ドキュメント ステータス クエリ エンドポイントを呼び出してインデックス ステータス (「indexing_status」フィールドが「completed」) を確認します。一貫性が重要なシナリオでは、ナレッジ ベースの同期インデックス作成モードを有効にします (インデックスが完了するまで更新操作がブロックされます)。不整合のトラブルシューティングを行うときにバックトラックするために、取得 API によって返された結果の「session_id」を記録します。
3 分ですぐに始められます
Dify API を使い始める最速の方法 (クラウド バージョンを例にします):
- https://cloud.dify.ai にログインし、アプリケーションを作成し、API キーを取得します (アプリケーション設定 → API キー → キーの作成)。 2.curl を使用して最初の会話メッセージを送信します。
「」バッシュ
curl -X POST "https://api.dify.ai/v1/chat-messages" \
-H "認可: ベアラー
- 返された結果の「回答」フィールド(AI の回答内容)を確認します。
セルフホステッド展開の API エンドポイント アドレスは「http://
使い方
Dify API への入り口はデプロイ方法によって異なりますが、認証方法とコア呼び出しモードは同じです。
エントリーマトリックス:
| 使い方 | API エンドポイントのベース アドレス | 該当するシナリオ | 認証方法 |
|---|---|---|---|
| クラウド版 | https://api.dify.ai/v1 |
試作検証、少人数チーム制作 | API キー (ベアラー トークン) |
| コミュニティ バージョンセルフホスト | http://<あなたのドメイン>/v1 |
データに敏感なシナリオ、運用展開 | API キー (ベアラー トークン) |
| Enterprise Edition 民営化 | エンタープライズ IT 部門によって提供 | 厳格なコンプライアンス要件があるシナリオ | API キー + 構成可能な認証 |
API 認証プロセス:
- Dify コンソールでアプリケーションを作成 → 「API アクセス」ページに入ります。
- [キーの作成] をクリックして、
app-で始まる API キーを生成します。 - すべての API リクエストの HTTP ヘッダーに「Authorization: Bearer
」を含めます。 - (オプション) 監視パネルでのユーザーの自由度ごとの使用状況の追跡を容易にするために、エンド ユーザーごとに独立したセッション トークン (「ユーザー」パラメーター) を生成します。
一般的な統合手順:
- Dify コンソールでビジュアル オーケストレーションを使用して AI ワークフローを構築します。
- アプリケーションを公開し、API キーを取得します。
- 外部システムの HTTP クライアントを通じて Dify API を呼び出し、ユーザー入力とコンテキスト変数を渡します。
- response_mode パラメータに従って、同期待機 (ブロッキング) または非同期コールバック (ストリーミング/コールバック) を選択します。
- API から返された JSON 応答を解析し、結果を独自の UI に表示します。
SDK サポート (Python を例にします):
「」パイソン インポートリクエスト
API_KEY = "
ヘッダー = { "認可": f"ベアラー {API_KEY}", 「コンテンツタイプ」: 「アプリケーション/json」 }
会話メッセージを送信する
応答 = リクエスト.post( f"{BASE_URL}/チャットメッセージ", ヘッダー=ヘッダー、 json={ 「入力」: {}、 "query": "今日のニュースは何ですか?", "response_mode": "ブロック", "ユーザー": "ユーザー-123" } )
print(response.json()["answer"]) 「」
ヒント: SDK の特定のインストール コマンドと完全なメソッド シグネチャは、Dify の公式 GitHub リポジトリと PyPI/npm ページの対象となります。 Community Edition が自己ホスト型の場合は、API ゲートウェイが HTTPS 証明書と正しいリバース プロキシ ルールで構成されていることを確認してください。
製品の価格設定
Dify API は個別に請求されることはなく、その価格は Dify プラットフォーム パッケージに含まれています。これは、API 呼び出しのクォータがプラン レベルのメッセージ/呼び出し量の上限に関連付けられていることを意味します。
コミュニティ エディション (オープンソース セルフホスト型):
- API料金: $0
- 制限事項: API 呼び出し制限なし (自己展開サーバーのパフォーマンスによって制限されます)
- 前提条件: API ゲートウェイ HTTPS 証明書 API キー管理を自分で設定する必要があります
- 適用対象: 運用および保守能力を持つ技術チーム
クラウド無料版:
- API料金: $0
- 制限: 1 日あたり 200 メッセージ (API + Web コンソールの共有割り当て)、最大 5 つのアプリ
- 対象:本人確認、プロトタイプ開発
Cloud Pro (ワークスペースあたり月額 59 ドル):
- API料金:サブスクリプションに含まれています
- 制限: メッセージ制限なし、アプリケーション数 50、優先テクニカル サポート
- 適した用途: 小規模チームによる本番環境での使用
クラウド チーム エディション (月額 159 ドルから):
- API料金:サブスクリプションに含まれています
- 制限: マルチメンバーのコラボレーション、高度な権限管理、アプリケーションとナレッジベースの割り当ての増加
- 対象: 複数のシナリオを並行して実行する中規模のチーム
エンタープライズ版 (カスタマイズされた見積り):
- API料金:Enterprise Edition契約に含まれます
- 制限事項: カスタム API レート制限、専用 SLA、SSO 統合、監査ログ
- 適用対象:金融、医療、官公庁などの規制業種
追加料金: すべてのパッケージのモデル API 呼び出し料金は、開発者によってモデル サプライヤー (OpenAI、DeepSeek、Anthropic など) に直接支払われ、Dify プラットフォームと API レイヤーには追加の手数料はかかりません。費用見積りには「Dify パッケージ料金 + モデル API 料金」の両方を予算に含めることを推奨します。
アプリケーションのシナリオ
Dify API のアプリケーション シナリオは、「AI 機能を既存のシステムに組み込む」と要約できます。既存のテクノロジー スタックを置き換えずに AI オーケストレーション機能を導入する必要があるシナリオには、Dify API が介入する余地があります。
-
既存システムの AI 機能拡張: CRM、ERP、作業指示システム、コンテンツ管理システムに AI 機能を組み込み、API を通じて Dify ワークフローを呼び出して、インテリジェントな Q&A、コンテンツ生成、データ分類などのタスクを完了します。 実装の利点: 既存のシステムへの侵入を最小限に抑えます。システム アーキテクチャを変更する必要はなく、ビジネス ロジックに HTTP 呼び出しを追加するだけです。推定によると、中規模の電子商取引バックエンドが AI カスタマー サービス API に接続された後、第 1 レベルの作業指示に対する自動応答率は 55 ~ 70% に達し、手動によるカスタマー サービスの処理量は元の 40% に減少します。
-
自社構築のナレッジ ベース Q&A アプリケーション: Dify API のドキュメント管理エンドポイントを通じて社内ドキュメントをバッチでアップロードし、検索エンドポイントを通じてコンテキストに応じた Q&A 取得を実装し、セッション管理エンドポイントを通じて複数ラウンドの会話を維持します。 導入のメリット: 一般的な HR ナレッジ ベースのシナリオでは、オンボーディング プロセス、休暇ポリシー、その他の一般的な問題について従業員がセルフサービスで問い合わせる時間が、平均 10 分 (書類に目を通し、同僚に質問する) から 30 秒未満に短縮されます。
-
自動化されたコンテンツ制作パイプライン: Dify ワークフローをコンテンツ制作パイプライン (トピック選択 → データ収集 → 初稿生成 → レビュー → リリース) に整理し、API を介して CMS システムと接続します。 実装の利点: 新しいメディア運用チームにとって、標準的なパブリック アカウント記事の最初のドラフト作成時間は 60 ~ 90 分から 10 ~ 15 分に短縮されますが、事実の正確さとブランドの論調の一貫性を確保するために手動レビューを維持する必要があります。
-
システム間の AI エージェント統合: Dify API のエージェント ワークフロー エンドポイントを通じて、複雑な AI タスクが複数のビジネス システム間で調整されます。たとえば、「顧客苦情処理エージェント」は、CRM API を呼び出して顧客情報を照会 → ナレッジ ベースを呼び出して関連する苦情ケースを取得 → LLM を呼び出して対応提案を生成 → 作業指示システムを呼び出して処理作業指示を作成できます。 実装の利点: 単純な苦情のフルリンク自動処理、複雑な苦情は手動レビュー用のドラフト処理提案を自動的に生成し、単一の苦情の処理時間が数時間から数分に短縮されます。
-
企業の内部ツール チェーンの AI 強化: Dify API を企業の WeChat、Feishu、DingTalk などのオフィス プラットフォームに統合して、AI アシスタント ロボットを提供します。 API のセッション管理機能を通じて、クロスプラットフォームの会話コンテキスト共有を実現できます。ユーザーは WeChat Enterprise の Feishu で質問を続けることができます。 適用される境界: クロスプラットフォームのコンテキスト共有には外部セッション管理システムのサポートが必要であり、純粋な API モードはメッセージ ルーティングの問題を直接解決しません。
コスト削減と効率化の定量的控除 (Dify API の機能に基づく推定)
| 職務 | 一般的なタスク | 従来の方法では時間がかかる | API統合後は時間がかかる | 効率改善 | 控除の説明 |
|---|---|---|---|---|---|
| カスタマーサービススペシャリスト | クエリの標準返品および交換プロセス | 3 ~ 5 分 (書類をめくる) | 10 ~ 15 秒 (API Q&A) | 12~30回 | ナレッジベース検索 + LLM 生成に基づく RAG API リンク |
| コンテンツの操作 | 製品紹介コピーの生成 | 60~90分 | 10 ~ 15 分 (初稿) | 4~6回 | ワークフロー API は複数ステップのコンテンツ制作パイプラインをトリガーします |
| 法務アシスタント | 契約条件の事前確認 | 2~4時間 | 15 ~ 30 分 (事前レビュー) | 4~8回 | ワークフロー API とナレッジ ベース検索 API を組み合わせて用語の比較を完了 |
| 開発エンジニア | AI Q&A を既存のシステムに統合 | 2 ~ 3 日 (自社構築の LLM パイプライン) | 2 ~ 4 時間 (API ドッキング) | 6~12回 | Dify API を使用すると、モデルへのアクセス、RAG 構築、セッション管理などが不要になります。 |
上記のデータは、Dify API の機能特性に基づいた理論上の推論であり、公式に約束するものではありません。実際の改善は、ワークフローの複雑さ、ナレッジベースの品質、モデルの選択、および API の応答時間によって異なります。
人間と機械のコラボレーションの境界
Dify API の自動化機能は、セクションごとに介入の深さが異なります。
- 100% 自動化およびセクション化: ナレッジ ベースの検索、ドキュメントの分類、テキストの要約、書式設定されたレポートの生成、作業指示書の自動分類とルーティング。これらの構造化された出力は検証可能であり、失敗しても取り返しのつかない損害を引き起こすことはありません。
- 手動確認ポイントを設定する必要がある記事: 契約条件の結論、顧客の苦情処理計画、支払い/返金指示、オンラインでのコンテンツのリリース、および法的効果や財務業務に関わるあらゆる AI 出力。 Dify ワークフローの「条件分岐」ノードは、このようなシナリオで「手動レビュー」パスを設定できます。AI は提案を生成し、それを手動確認キューにルーティングし、確認後に後続の操作を実行します。
該当する人
Dify API は、Dify プラットフォームに関連性の高い人々を対象としていますが、スキル要件と権限レベルには大きな違いがあります。
-
バックエンド/フルスタック開発者: コア ユーザー グループ。 AI 機能を既存のシステムに統合する必要がある開発者は、API の応答性、ドキュメントの完全性、エラー処理メカニズム、SDK の品質を懸念しています。 適応値: Dify API を使用すると、開発者は独自の LLM パイプラインを構築することなく、HTTP 呼び出しを通じて完全な AI オーケストレーション機能を取得できます (モデルは RAG に接続されてエージェント オーケストレーションを構築します)。 境界に適合していない: プロジェクトで 1 つの単純な LLM 呼び出し (テキストの翻訳など) のみが必要な場合は、モデル プロバイダー API を直接呼び出す方が、オーケストレーション レイヤーがここでは過度に抽象化されている Dify API を経由するよりも簡単です。
-
DevOps/プラットフォーム エンジニア: Dify セルフホステッド デプロイメントと API ゲートウェイの運用を担当するチーム。彼らは API の安定性、可観測性 (ログ、モニタリング、アラーム)、スケーラビリティ、およびセキュリティ構成を重視します。 適応値: Dify API の非同期実行モードと Webhook コールバック メカニズムにより、長期タスクの運用とメンテナンスの複雑さが軽減されます。エンタープライズ バージョンの監査ログと SSO 統合は、コンプライアンス要件を満たしています。 境界には適していません: GPU リソースが限られているチーム、またはコンテナ化された展開の経験がないチームの場合、セルフホスト型 Dify API の運用および保守コストがクラウド バージョンのサブスクリプション料金よりも高くなる可能性があります。人件費と経済コストを比較してから決定することをお勧めします。
-
テクニカル プロダクト マネージャー/ソリューション アーキテクト: ビジネス シナリオに合わせた AI 統合ソリューションを設計する意思決定者。彼らは、API 機能の境界、既存のテクノロジー スタックとの互換性、ベンダー ロックインのリスク、およびデータ主権を懸念しています。 適応価値: Dify API の「1 つのオーケストレーション、複数の呼び出し」モデルにより、複数のシステム間で AI 機能を重複して構築するコストが削減されます。オープンソースとセルフホスティング機能により、ベンダー ロックインの懸念が解消されます。 不適合境界: ビジネス要件が AI 機能の統合ではなく、すぐに使える SaaS 製品を購入することである場合、Dify API は適切な選択ではありません。現時点では、Dify Cloud の Web アプリケーションまたは類似の SaaS 製品を優先する必要があります。
-
AI アプリケーション起業家精神チーム: AI 製品のアイデアを迅速に検証する初期のチーム。 適応価値: Dify API は既製の AI オーケストレーション インフラストラクチャを提供するため、チームはビジネス ロジックとユーザー エクスペリエンスにリソースを集中できます。 該当なし: 極端な API パフォーマンスの最適化 (ミリ秒レベルの応答など) やワークフロー エンジンの動作の詳細なカスタマイズが必要になるまでユーザー数が増加した場合、Dify API の抽象化レイヤーがボトルネックになる可能性があります。その時点で、自社構築パイプラインに移行する必要があるかどうかを評価する必要があります。
概要と展望
Dify API は、Dify プラットフォームが「内部オーケストレーション ツール」から「プラットフォーム インフラストラクチャ」に移行するための重要な製品レイヤーです。その核となる競争力は、「統合された実行ランタイム + 完全な API カバレッジ + オープンソースとセルフホスティング」の組み合わせにあります。開発者は、「完全な機能だがクローズドソース」 (Coze API) と「オープンソースだが分散した機能」 (Flowise/LangFlow) のどちらかを選択する必要はありません。
主な利点: Dify API と Web コンソールは同じ実行エンジンを共有し、テストと運用の間の不一致を排除します。 API エンドポイントはワークフロー RAG、エージェント、モデル管理リンク全体をカバーし、単一のプラットフォームで AI オーケストレーションのほとんどのニーズを満たします。オープンソース コミュニティ バージョンは自己ホスト型であり、無制限のデータ主権を備えています。
現在の制限事項: API レベルの高度な管理機能 (きめ細かい RBAC、マルチテナント分離、カスタム レート ポリシー) はエンタープライズ バージョンでのみ利用可能であり、コミュニティ バージョンとクラウド バージョンの間にはセキュリティ ガバナンスにギャップがあります。ドキュメント管理 API はバッチ アップロードや増分同期のアトミック操作をサポートしておらず、大規模なナレッジ ベースの構築には外部オーケストレーションが必要です。 SDK がカバーする言語は限られており (Python と JS のみが公式に保守されています)、他の言語はコミュニティの貢献に依存しています。
フォローアップ観察ポイント: エージェント アーキテクチャのアップグレード後、API レイヤーがエージェント固有のエンドポイントを独立して公開するかどうか。エンタープライズ バージョン API が複雑なマルチデータ ソース クエリ シナリオを満たすために GraphQL サポートを追加するかどうか。 API の OpenAPI 仕様をプラットフォームのバージョンと同期して更新できるかどうか (現時点では一定の遅れがあります)。
調達/採用リスク評価: テクノロジーの選択段階では、まず Cloud Free Edition を使用して、API 機能と応答遅延がビジネス ニーズを満たしているかどうかを確認することをお勧めします。検証に合格したら、Cloud Professional Edition を使用するか、セルフホスト型 Community Edition を使用するかを決定できます。厳格なコンプライアンス要件を持つ中規模および大規模企業の場合、エンタープライズ バージョンの契約に署名する前に、API SLA の保証範囲 (月間可用性時間、タイムアウト再試行メカニズム、障害回復時間の目標など)、データの保存場所、データ削除ポリシーなどの条件を重点的に確認する必要があります。 API キー漏洩後の責任共有メカニズム。起業家チームの場合、「Dify API はオーケストレーション層であり、モデル API の料金が主なコストである」という予算意識を確立する必要があります。使用量が増えると、モデルの呼び出し料金が Dify パッケージの料金をはるかに超えるため、モデルの選択とコストの最適化戦略を早い段階で計画する必要があります (単純なタスクを処理するために費用対効果の高いモデルを使用する、コンテキスト キャッシュを通じて繰り返し入力コストを削減するなど)。
関連ツール: CrewAI、langchain
バージョン情報
- ディファイ API v1.14.2 :セキュリティの強化とバグ修正、エージェントの基礎となるアーキテクチャの改善、ワークフロー API の信頼性の向上、セルフホスト展開の最適化。 API レベルは、プラットフォーム v1.14.2 の安定性の向上と同期します。
- ディファイ API v1.14.1 :セキュリティの強化、ワークフロー API の安定性の向上、セルフホスト型展開のクリーンアップ。
- ディファイ API v1.14.0 :メインバージョンの機能が更新され、エージェントオーケストレーション関連のエンドポイントがAPIレベルで同時に追加されました。公式の変更履歴を参照してください。
- Dify API v1.0 正式版 :このマイルストーン バージョンでは、API レイヤーが正式に運用準備段階に入り、REST API を完全にカバーし、OpenAPI 仕様ドキュメントを提供します。
ユーザーレビュー