メインコンテンツへスキップ
Dify で公開したアプリは、そのまま REST API としても使えます。ナレッジベースも同様です。エンドユーザーが使うのと同じアプリを、API キーを使って自分のバックエンドから呼び出せます。

API キーの取得

API はバックエンドからのみ呼び出してください。フロントエンドコードやクライアントアプリに埋め込んだキーは、抽出されて悪用されるおそれがあります。
  • アプリの場合:アプリ内で API キーを作成します。キーはそのアプリ 1 つにのみ有効で、1 つのキーですべてのエンドユーザーに対応できます。
    呼び出し時には 1 人ずつの user 値でユーザーを区別します。詳細は エンドユーザーの識別 を参照してください。
  • ナレッジベースの場合:ナレッジ 画面を開き、右上の サービスAPI をクリックします。 ナレッジベースのキーは範囲が広く、キーを作成したアカウントから見えるすべてのナレッジベースにアクセスできます。取り扱いには特に注意してください。詳細は ナレッジ API を参照してください。

最初のリクエストを送る

すべてのリクエストは、キーを Bearer トークンとして送信します。ベース URL はデプロイ環境の API エンドポイント(例:https://api.example.com/v1)です。アプリの API アクセスページからコピーできます。 最初のリクエストは、コードなしで送るのが最速です。アプリケーションの基本情報を取得 を開き、試す をクリックします。Authorization フィールドにキーを貼り付けて、送信 を押します。どのアプリタイプでも使えます。 ターミナルから同じ呼び出しを送る場合:
次のようなレスポンスが返れば、キーは有効です。どのアプリのキーかも確認できます:
ナレッジベースの API キーを使う場合、エンドポイントは別系統です。最初のリクエストには ナレッジベースリストを取得 を試してください。

アプリタイプごとのエンドポイントを見つける

各アプリタイプの API の全体像は、それぞれの概要ページを参照してください。