GMO即レスAI

Difyとカスタムツールの連携術:外部APIを活用したAIエージェントの機能拡張ガイド

2025-07-09

Difyとカスタムツールの連携術:外部APIを活用したAIエージェントの機能拡張ガイド

Difyの具体的な活用方法をまとめた導入事例をダウンロードしてみませんか?
業務効率化に成功した事例を多数ご紹介しており、最適なAI活用のヒントになれば幸いです。

▶︎Difyで業務効率化する際のポイントを解説したお役立ち資料

本記事では、Difyのツールの中でもカスタムツールを掘り下げて解説していきます。また、カスタムツールの具体的な作り方も紹介して行きますので、ぜひ最後までご覧ください。

Difyにおけるカスタムツールとは?

Difyにおけるツールとは、AIエージェントやチャットボットの機能を拡張させるために、外部サービスや社内システムと連携してAIが他の機能を使えるしくみです。Dify上でAIエージェントに「新しいスキル」を与える方法といえます。Difyには主に3つのツールが存在します。

ツール(ビルトイン)
Difyファーストパーティが提供するツールで、Dify AIエージェントによる業務自動化事例7選:生産性向上とコスト削減を実現する実践的アプローチ|2. 企業調査 でも紹介したJinaAI等が含まれます。また、マーケットプレイスで様々なツールのインストールが可能です。

カスタムツール
OpenAPIフォーマットでDifyと連携させて、利用用途や目的に応じて名前のとおり、自由に設計(カスタム)できる特徴を持つツールです。API連携で、リアルタイムに更新される情報をAIエージェントに与えることができます。

ワークフロー
Difyで構築したワークフローで構成され、ツールとして公開されたをものを指します。アプリタイプ「ワークフロー」で作成したアプリについては、単なるアプリとして公開するだけでなく、Difyの他のエージェントやワークフローと繋げて使えるツールとして公開ができます。ワークフロー編集画面右上の公開ボタンより「ワークフローをツールとして公開する」より設定が可能です。

カスタムツールでできること/できないこと

カスタムツールは自由に設計ができる特徴を持ちますが、できることとできないことがあります。外部APIの呼び出しやパラメータの指定、AIエージェントで複数のカスタムツール併用等ができる一方、HTMLから触接情報を抽出するようなwebサイトのスクレイピング処理、複雑なデータ整形やロジック処理などのループ処理には向いていません。

項目

内容

可否(◯/×)

補足・前提条件

外部APIの呼び出し

REST形式のAPI(OpenAPI 3.0/3.1仕様)に対するGET/POSTの操作

OpenAPI仕様をアップロードして使用

ユーザー入力のAPIパラメータ化

入力内容を動的にAPIリクエストに渡す

プロンプトに適切な誘導を書くことで自動適用される

APIレスポンスの自然言語変換

取得データをAIが自然な言葉で回答する

DifyがLLMを通じて出力文章に自動反映

複数APIツールの同時登録

複数のカスタムツールを1エージェントに組み込むこと

呼び出し先はAIが自動選択、並列実行には非対応

API認証対応(ベーシック/Bearer)

BearerトークンやBasic認証への対応

認証情報はカスタムツール定義で事前設定可能

OAuth 2.0等の高度な認証

ユーザーごとのトークン取得やリフレッシュ

×

現時点では非対応。静的トークン形式のみ対応可能

Webスクレイピング

HTMLページから直接情報を取得

×

スクレイピング処理には非対応、API経由のみ

ファイルのアップロード・出力

PDF/画像/Excelファイルの処理

×

ファイルURLの受け取りは可、直接処理は不可

複雑な制御処理(分岐・ループ)

プログラム的な条件分岐や繰り返し処理

×

AIによる簡易的対応は可能だが制御不可

複数APIの同時呼び出し

1回の応答で複数ツールを並列実行

×

必要に応じてAIが順番に呼ぶことがある

カスタムツールを活かしたAIエージェントへの組み込みや設計を心掛け、有効活用していきましょう。

実践:外部APIと連携するカスタムツールの作り方

では、実際にカスタムツールの作成方法を解説します。

APIスキーマの理解

カスタムツールを作成する前に、APIのしくみやAPIスキーマをおさらいしておきます。そもそもAPI(Application Programming Interface)は、ソフトウェアやプログラム間での情報の共有・呼び出しをするためのインターフェースです。APIを利用して、自身で一からデータをかき集めたり機能開発をしなくても外部ツールの情報や機能を引っ張ってくることが可能です。

APIスキーマとは、APIリクエストをした際にエンドポイントから正しく情報が返ってくるための条件や定義をまとめた仕様です。条件を満たしている場合にリクエストが返ってくるため、期待するレスポンスを受け取るためにはAPIスキーマを理解しておきましょう。

Difyにおいては、カスタムツールとして登録する外部APIの仕様を記述する取り扱い説明書と覚えておくとよいでしょう。DifyにAPIスキーマを読み込ませると、AIが登録したAPIを正しく使えるようになります。

スキーマは、OpenAPIのフォーマットに基づいて、主に以下のような要素で定義されます。

要素

説明

openapi

OpenAPIのバージョン

"3.0.0"

info

APIの名称やバージョン情報

title, version, description

paths

各エンドポイント(URI)とその動作

/weather や /users/

parameters

クエリ・パスパラメータなどの入力定義

?city=Tokyo など

requestBody

POSTなどのリクエスト本文の定義

JSON形式のリクエスト定義

responses

返却されるレスポンスの定義

200 OK の戻り値の型や構造

components/schemas

データ構造の共通定義

使い回しできる型を定義

security

認証方式(Bearerトークンなど)

"bearerAuth" など

カスタムツール設定

今回は、天気情報を取得できるカスタムツールを作成してみます。カスタムツールを設定するには、Difyへログイン後に「ツール」→「カスタム」の画面に移動し、「カスタムツールを作成する」をクリックします。すると、設定画面が表示されるので、必要な情報を入力していきます。

名前:どのようなツールであるか、わかりやすい名前を入力

OpenAPIスキーマ設定方法

呼び出すAPIのスキーマを入力します。OpenAPI形式で作成します。また、URLからインポートもできますし、よく使われるJSONやYAMLなどのテンプレートから選択もできます。今回は、OpenWeather無料プランで使用できるAPIに基づき、YAML形式でスキーマを入力しました。

下記のように、条件をChatGPTに投げて、スキーマの入力内容のベースを作成してもらうと効率的です。

  • エンドポイント:https://api.openweathermap.org/data/2.5/weather

  • HTTPメソッド:GET

  • 必須パラメータ:
    q:都市名(例:Tokyo)
    appid:OpenWeatherのAPIキー

  • 出力例:気温、天候(例:晴れ、雨)など

スキーマ作成時の注意点として、セキュリティリスクの観点からスキーマ自体にAPIキーの直接書き込みは実施しないで、次に紹介するカスタムツールの認証の設定で固定値として登録します。

カスタムツールの認証方式

認証方法は「なし」か「APIキー」のどちらかを選択が可能です。簡易的な利用であれば、いったん、「なし」で設定も可能ですが、APIキーによる認証が安全に利用するにはよいでしょう。APIキーで認証する場合は、あらかじめAPIキーを取得しておきましょう。今回は、APIキーを利用した認証で設定します。

動作検証

実際に登録したツールを利用できるかは、カスタムツールを編集する画面の「利用可能なツール」の「テスト」から試せます。値に試したい情報を入れてテストしてみて、結果で値が返ってきてエラー表示されなければ成功です。今回は、福岡の現在の天気を知りたいので、下記を入力してテストしました。

  • q=fukuoka

  • units=metric

  • appid=APIキー

テスト結果が表示されて、現在の天気情報がわかりました。

もしエラーが表示される場合は、エラーメッセージをもとにスキーマの見直しを行ってください。

具体的な利用例

今回は天気情報がわかるカスタムツールを設定する方法をご紹介しました。他にもAPIを利用して様々なツールの作成が可能です。具体的な例として5つご紹介します。

データ収集・分析の自動化
社内のデータベースや外部APIを利用し、レポート化

翻訳ツール
翻訳ツールのAPIを利用し、外国語に対応する

交通案内ボット
地図アプリのAPIを利用して道順や電車の乗り換えを案内

スケジュール・タスク管理
カレンダー系のアプリのAPIを利用して予定を取得して教えてくれるアシスタント

顧客問合せチケットの自動登録
顧客の問合せ内容を解析して自動的に問合せチケット管理ツールに登録

まとめ

カスタムツールはAPIを利用して作成できる便利な機能です。しかし、使用の際にはセキュリティリスクを考え、スキーマに直接APIキーを書かない等、充分に注意しながらご利用ください。また、APIには無料で利用可能な場合もありますが、有料の場合もありますので、利用する際は確認をおすすめします。

▶︎Difyで業務効率化する際のポイントを解説したお役立ち資料

GMO即レスAIでは企業の課題に応じて柔軟なAIエージェントの提供を行っております。ご興味のある方はお気軽にお問い合わせください。

▶︎お問い合わせはこちら

最後までお読みいただきありがとうございました!

AIと共に生産性の高い社会を創る
GMO即レスAI

AIチャットを体験