> ## Documentation Index
> Fetch the complete documentation index at: https://enterprise-docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Dify API クイックスタート

> API キーを取得して最初のリクエストを送り、アプリタイプごとのエンドポイントを見つける

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

## API キーの取得

> [!WARNING]
>
> API はバックエンドからのみ呼び出してください。フロントエンドコードやクライアントアプリに埋め込んだキーは、抽出されて悪用されるおそれがあります。

* アプリの場合：アプリ内で API キーを作成します。キーはそのアプリ 1 つにのみ有効で、1 つのキーですべてのエンドユーザーに対応できます。

  > [!NOTE]
  >
  > 呼び出し時には 1 人ずつの `user` 値でユーザーを区別します。詳細は [エンドユーザーの識別](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/end-user-identity.md) を参照してください。

* ナレッジベースの場合：**ナレッジ** 画面を開き、右上の **サービスAPI** をクリックして API キーを作成します。

  キーのスコープは、[連携に必要なナレッジベースだけに限定](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/knowledge.md#scoped-api-keys) できます。

## 最初のリクエストを送る

すべてのリクエストは、キーを Bearer トークンとして送信します。ベース URL はデプロイ環境の API エンドポイント（例：`https://api.example.com/v1`）です。アプリの API アクセスページからコピーできます。

最初のリクエストは、コードなしで送るのが最速です。[アプリケーションの基本情報を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/applications/get-app-info.md) を開き、**試す** をクリックします。**Authorization** フィールドにキーを貼り付けて、**送信** を押します。どのアプリタイプでも使えます。

ターミナルから同じ呼び出しを送る場合：

```bash theme={null}
curl https://api.example.com/v1/info \
  -H "Authorization: Bearer $DIFY_API_KEY"
```

次のようなレスポンスが返れば、キーは有効です。どのアプリのキーかも確認できます：

```json theme={null}
{
  "name": "My Chat App",
  "description": "A helpful assistant",
  "tags": ["assistant"],
  "mode": "chat",
  "author_name": "Dify Team"
}
```

ナレッジ API キーでは、アクセス範囲に応じて最初の呼び出しを選びます。

* **スコープを限定したキー**：対象のナレッジベースの [ID を Dify からコピー](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/knowledge.md#knowledge-base-id) します。その ID で [ナレッジベース詳細を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/knowledge-bases/get-knowledge-base.md) を呼び出します。
* **すべてのナレッジベースにアクセスできるキー**：[ナレッジベースリストを取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/knowledge-bases/list-knowledge-bases.md) を呼び出します。

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

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

* [Chatflow](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/chatflow.md)（`advanced-chat`）
* [Workflow](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/workflow.md)（`workflow`）
* [Agent](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/agent.md)（`agent`）
* [Chatbotとレガシー Agent](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/chat.md)（`chat`、`agent-chat`）
* [テキストジェネレーター](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/completion.md)（`completion`）
* [ナレッジ](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/knowledge.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.