このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、英語版 を参照してください。
Dify で公開したアプリは、そのまま REST API としても使えます。ナレッジベースも同様です。エンドユーザーが使うのと同じアプリを、API キーを使って自分のバックエンドから呼び出せます。
API キーの取得
API はバックエンドからのみ呼び出してください。フロントエンドコードやクライアントアプリに埋め込んだキーは、抽出されて悪用されるおそれがあります。
-
アプリの場合:アプリ内で API キーを作成します。キーはそのアプリ 1 つにのみ有効で、1 つのキーですべてのエンドユーザーに対応できます。
呼び出し時には 1 人ずつの user 値でユーザーを区別します。詳細は エンドユーザーの識別 を参照してください。
-
ナレッジベースの場合:ナレッジ 画面を開き、右上の サービスAPI をクリックして API キーを作成します。
キーのスコープは、連携に必要なナレッジベースだけに限定 できます。
最初のリクエストを送る
すべてのリクエストは、キーを Bearer トークンとして送信します。Dify Cloud のベース URL は https://api.dify.ai/v1 です。セルフホスト環境では、自分のインスタンスの API ベース URL に置き換えてください。
最初のリクエストは、コードなしで送るのが最速です。アプリケーションの基本情報を取得 を開き、試す をクリックします。Authorization フィールドにキーを貼り付けて、送信 を押します。どのアプリタイプでも使えます。
ターミナルから同じ呼び出しを送る場合:
次のようなレスポンスが返れば、キーは有効です。どのアプリのキーかも確認できます:
ナレッジ API キーでは、アクセス範囲に応じて最初の呼び出しを選びます。
アプリタイプごとのエンドポイントを見つける
各アプリタイプの API の全体像は、それぞれの概要ページを参照してください。