「ごみ当ちゃん」で使用している機能のうち、外部システムからでも利用できるように、以下の機能をAPIとして提供します。
利用可能なAPI
- ごみ分別検索：ごみ分別方法を確認したい市区町村とごみ品目を指定して検索し、類似した品目含め、品目毎でのごみ分別方法を返却します。
- UTCPマニュアルの取得：Universal Tool Calling Protocol (UTCP)に従い、AIエージェントからツールとしてのごみ当ちゃんのAPIを呼び出すためのマニュアル(JSON)を提供します。
UTCPの概要については、こちらのリンクをご参照ください。ツールとしては「ごみ分別検索」のみを提供します。
利用条件
- 無料で利用可能 ですが、月間1,000リクエスト の制限があります。
- 利用可能な自治体は、以下のリンクに掲載されている自治体が提供するオープンデータを利用しています。
利用可能なごみ分別自治体リスト - お手持ちのLINEアプリにて、「ごみ当ちゃん」を友だち追加いただきますよう、お願いいたします。
友だち追加はこちらのリンクから可能です。
友だち追加はAPI利用には影響はございませんが、そのAPIを使用しているサービスの「実装例」としてその動きを体験することができます。
利用申し込み
APIを利用するには、事前の利用申し込み が必要です。
下の「利用申し込みへ進む」ボタンをクリックし、利用案内および利用規約をご確認ください。
利用方法
- 申込後に発行される 認証キー（APIキー） を、HTTPヘッダー
X-Api-Keyに指定してAPIを呼び出します。
※「UTCPマニュアルの取得」については認証キーは不要です。 - 提供しているAPIの詳細仕様は、上記の Swagger UI または Redoc ドキュメントで参照できます。
仕様アップデート・障害等の各種アナウンス
次の方法にて発信しておりますので、必要に応じてご確認ください。