Dify APIの使い方完全ガイド：ワークフローをAPI化してアプリに組み込む方法

Dify APIとは？ワークフローをバックエンドAPIとして使える仕組み

DifyをBaaS（Backend as a Service）として使うという発想

• バックエンドの複雑さをスキップ：AIインフラストラクチャを管理することなく、大規模言語モデル機能にアクセスできる
• ビジュアルアプリ管理：AIの動作を視覚的に設計・更新でき、変更は全てのAPIコンシューマーに即座に反映される
• プロバイダーの柔軟性：コード変更なしでAIプロバイダーを切り替え、APIキーを一元管理できる
• 組み込み監視機能：ログ、分析、ユーザーアクティビティ追跡が標準で利用できる

APIキーの取得と基本設定

1. モデルプロバイダーのAPIキー（例：OpenAI APIキー、Gemini APIキー）：DifyがLLMを呼び出すために必要。Difyの設定画面で入力する。
2. DifyアプリのAPIキー（Service API Key）：外部システムからDifyアプリを呼び出すために必要。アプリごとに発行する。

モデルプロバイダーのAPIキー設定

DifyアプリのAPIキー（Service API Key）の発行

1. Dify上でアプリ（ワークフロー・チャットフロー等）を作成・公開する
2. アプリの左サイドバーから「API Access」に移動する
3. 「APIシークレットキー」を新規作成する
4. 発行されたキーをコピーして安全な場所に保管する

チャットフローのAPI呼び出し方法

curl --location --request POST 'https://api.dify.ai/v1/chat-messages' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "inputs": {},
  "query": "こんにちは、今日のニュースを教えてください",
  "response_mode": "blocking",
  "conversation_id": "",
  "user": "user-001"
}'

conversation_idの管理ポイント

• 新しい会話を開始するときはconversation_idを空にする（システムが自動生成して返す）
• 既存の会話を継続するときは、前の呼び出しで返ってきたconversation_idを含める
• セッション中に変数を変更したい場合は「会話変数」を使って動的に調整できる

ワークフローのAPI化と外部システムへの組み込み

curl --location --request POST 'https://api.dify.ai/v1/workflows/run' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "inputs": {
    "URL": "https://example.com/article",
    "count": 120
  },
  "response_mode": "blocking",
  "user": "user-001"
}'

streaming モードでのリアルタイム出力

Pythonでの実装例

import requests
import os

def run_dify_workflow(inputs: dict, user: str = "default-user"):
    api_key = os.environ.get("DIFY_API_KEY")
    base_url = os.environ.get("DIFY_BASE_URL", "https://api.dify.ai")
    url = f"{base_url}/v1/workflows/run"
    
    headers = {
        "Authorization": f"Bearer {api_key}",
        "Content-Type": "application/json"
    }
    
    payload = {
        "inputs": inputs,
        "response_mode": "blocking",
        "user": user
    }
    
    response = requests.post(url, headers=headers, json=payload)
    
    if response.status_code == 200:
        result = response.json()
        return result["data"]["outputs"]
    else:
        raise Exception(f"Error {response.status_code}: {response.text}")

# 使用例
outputs = run_dify_workflow(
    inputs={"topic": "AI活用事例", "language": "ja"},
    user="user-001"
)
print(outputs)

GASやn8nとの連携パターン

Google Apps Script（GAS）との連携

function runDifyWorkflow() {
  const API_KEY = PropertiesService.getScriptProperties()
    .getProperty("DIFY_API_KEY");
  
  const headers = {
    "Authorization": "Bearer " + API_KEY,
    "Content-Type": "application/json"
  };
  
  const payload = {
    "inputs": {
      "URL": "https://example.com/article",
      "count": 120
    },
    "response_mode": "blocking",
    "user": "gas-user"
  };
  
  const options = {
    "method": "post",
    "payload": JSON.stringify(payload),
    "headers": headers,
    "muteHttpExceptions": true
  };
  
  const response = UrlFetchApp.fetch(
    "https://api.dify.ai/v1/workflows/run",
    options
  );
  
  if (response.getResponseCode() === 200) {
    const result = JSON.parse(response.getContentText());
    Logger.log(result.data.outputs);
  } else {
    Logger.log("Error: " + response.getContentText());
  }
}

n8nとの連携

ナレッジAPI（Knowledge API）の使い方

• 自動更新：社内システムのデータが更新されたら、自動でナレッジベースも更新する
• バッチ登録：大量のドキュメントをまとめてナレッジベースに追加する
• 外部ナレッジベースとの連携：既存の社内DBをDifyから使う

ナレッジAPIのエンドポイント

エラーハンドリングとセキュリティのベストプラクティス

セキュリティのベストプラクティス

• APIキーは必ずバックエンド側に置く（フロントエンドのコードに書かない）
• 環境変数でAPIキーを管理する
• 本番・ステージング・開発環境で別々のAPIキーを使用する
• 定期的にAPIキーをローテーションする
• API使用量を監視して異常なアクティビティを検出する

よくある質問（FAQ）

DifyのAPIは無料で使えますか？

セルフホスト版とクラウド版でAPIの使い方は変わりますか？

Difyのワークフローを別のワークフローから呼び出せますか？

streaming モードのレスポンスはどう処理しますか？

まとめ

• Dify APIには「アプリケーションAPI」と「ナレッジAPI」の2種類がある
• アプリケーションAPIのエンドポイントはアプリタイプによって異なる（ワークフロー: /v1/workflows/run、チャット: /v1/chat-messages）
• APIキーはモデルプロバイダーのキーとDifyアプリのAPIキーの2種類がある
• セキュリティのため、APIキーは必ずバックエンド側で環境変数として管理する
• GASやPythonからも簡単に呼び出せる

出典

• Dify 公式ドキュメント - API統合
• Dify 公式ドキュメント - 主要な概念
• Dify 公式ドキュメント - ナレッジ
• Dify 料金プラン
• Dify GitHub リポジトリ