Dify APIドキュメントセンターへようこそ！このガイドは、Dify APIを効果的にテストし理解するために本文書が提供するインタラクティブ機能を活用する方法、そしてAPIアクセスの主要な要素を習得するためのお手伝いを目的としています。

重要事項：

  • このページの内容： 主にAPIドキュメントのインタラクティブな利用方法、グローバルなアクセス設定（ベースURL、APIキーなど）、およびドキュメントへの貢献プロセスについて説明します。
  • APIエンドポイント詳細： 全ての具体的なAPIエンドポイント（パラメータ、リクエスト/レスポンス構造、機能説明、例を含む）の内容は、OpenAPI仕様に基づいて自動生成され、最新の機能に関する注釈が含まれています。最も正確で詳細なエンドポイント情報については、これらの自動生成されたページを必ず参照してください。

APIアクセス

または上部のナビゲーションバーの「APIアクセス」タブをクリックすると、完全なAPIドキュメントを表示できます。

​
インタラクティブなAPIテスト

APIを迅速に検証し理解していただくために、本文書のほとんどのAPIエンドポイントページには、「試してみる」(Try It) というインタラクティブなテスト機能が組み込まれています。

1

「試してみる」機能を見つける

テストしたいAPIエンドポイントのドキュメントページで、通常はページ上部または右側の領域に、目立つ「試してみる」ボタンまたは直接操作可能なパラメータ入力領域があります。

2

リクエストパラメータを設定する

3

リクエストを送信して結果を確認する

すべてのパラメータ設定が完了したら、「送信」(Send) (または「実行」(Execute)) ボタンをクリックしてAPI呼び出しを開始します。しばらくすると、同じ領域にHTTPステータスコード、レスポンスヘッダー、レスポンスボディを含む完全なAPIレスポンスが表示されます。

​
🔑 APIアクセス設定

​
サーバーアドレス (ベースURL)

APIリクエストのベースURLは、Difyのデプロイ環境によって異なります。

https://api.dify.ai/v1

API呼び出しを行う際や「試してみる」機能を使用する際は、設定したベースURLが正しいことを必ず確認してください。

​
APIキー (API Key)

Difyの各アプリケーション (App) は、インターフェース呼び出しの認証と認可に使用される、それぞれ専用のAPIキーを所有しています。

  • 取得方法： Difyアプリケーションの概要、APIアクセス、または モニタリング ページで APIキー をクリックして、APIキーを管理または生成できます。

  • 使用方法： APIキーを取得したら、HTTPリクエストの Authorization ヘッダーに Bearer YOUR_API_KEY の形式で追加してください。

  • 重要なセキュリティに関する注意：

    APIキーはアプリケーションデータへのアクセス資格情報であり、高い権限を持っています。機密情報として扱い、厳重に保管してください。クライアントサイドのコード（ブラウザ、モバイルアプリのフロントエンドなど）にハードコーディングしたり、直接公開したりすることは絶対に避けてください。 APIキーは安全なサーバーサイド環境に保存し、バックエンドサービスを介してDify APIの呼び出しをプロキシすることを推奨します。

  • アクセス制御： Difyアプリケーションの モニタリング (Monitoring) -> バックエンドサービスAPI (Backend Service API) 設定で、APIのアクセス状態を管理できます。例えば、すべてのAPI呼び出しを一時的に無効にすることができます。

​
📚 APIアクセスと本文書について

​
ドキュメントの構成とソース

  • 本ガイドページ (api-access-readme.mdx)： APIドキュメントの使用方法、インタラクティブテストの実施方法、APIアクセスの一般的な設定情報を提供します。
  • APIエンドポイント詳細ページ： サイドバーの 「APIエンドポイント」 グループ以下のすべてのページは、当社のOpenAPI仕様 (OpenAPI仕様ソースファイルテンプレートを見る) から 自動生成 されています。これらのページには、各エンドポイントの詳細な説明、パラメータ、リクエスト/レスポンスの例、最新の機能に関する注釈が含まれています。

​
本文書への貢献方法

Difyドキュメントへのコミュニティメンバーからの貢献を心より歓迎し、感謝いたします！

もし 現在ご覧になっているこの APIアクセスとインタラクションガイド ページ を修正したい場合は、以下の手順で行うことができます：

  1. このページの下部までスクロールします。
  2. 「このページを編集」(Edit this page) ボタンをクリックします。
  3. これにより、GitHub上のこの api-access-readme.mdx ファイルの編集インターフェースに直接移動します。

注意：このページ下部の 「このページを編集」 ボタンは、現在のこのガイドページ (api-access-readme.mdx) 自体にのみ作用します。 個々の APIアクセス 詳細ページには 適用されません。

同期

APIドキュメントはDifyのメインリポジトリから同期されています。このカードをクリックすると、GitHubで元のコードを確認できます。同期のずれや誤りを見つけた場合は、ぜひPRを送信してコードに貢献してください。

すべての貢献（直接編集または問題報告）にはGitHubアカウントが必要です。より完全なDify利用ドキュメントを共に作り上げるための皆様のご参加をお待ちしております！

このページを編集する

直接貢献することでドキュメントの改善にご協力ください

問題を報告する

エラーを見つけたり提案がありますか？お知らせください