APIによるナレッジベース管理

Dify は、ナレッジベース、ドキュメント、チャンクをプログラムで管理するための完全なナレッジベース API セットを提供しています。データ同期の自動化や、ナレッジベース操作の CI/CD パイプラインへの統合に活用できます。 ナレッジベースを作成すると、API アクセスはデフォルトで有効になります。API 呼び出しを開始するには、エンドポイントとキーの API 認証情報のみが必要です。

​

API エンドポイントとキーの取得

Dify でナレッジベースページに移動します。右上の サービス API をクリックして API 設定パネルを開きます。ここでは以下の操作が可能です：

• サービス API エンドポイントを取得します。これはすべてのナレッジベース API リクエストのベース URL です。
• API キー をクリックして、新しいキーの作成や既存キーの管理を行います。
  API キーはサーバー側で安全に保管してください。クライアントサイドのコードや公開リポジトリには絶対に公開しないでください。

​

ナレッジベースの API アクセス管理

すべてのナレッジベースは、デフォルトでサービス API 経由でアクセス可能です。 特定のナレッジベースの API アクセスを制限するには、そのナレッジベースを開き、左下の API アクセス をクリックしてオフに切り替えます。

​

API リファレンス

エンドポイントの完全なリスト、リクエスト/レスポンスのスキーマ、エラーコード、インタラクティブな例については、ナレッジベース API リファレンスをご覧ください。