目的と概要

トラッキングAPIは、生成AIエージェントのパフォーマンスを最大化するためのデータ記録システムです。このAPIは、エージェント自身が応答を生成するのではなく、将来の応答生成時に参照される行動データを体系的に記録する役割を担います。

AIの「記憶」としての役割

トラッキングAPIによって記録されたデータは、エージェントが新たなアクションを起こす際の「記憶」として機能します。これにより、過去の対話や行動を踏まえた、より適切で一貫性のある応答が可能になります。

リクエスト情報

メソッド: POST
エンドポイント: /tracker/:trackerId/:platform

ヘッダー

Key	Value
Content-Type	application/json
X-API-Key	`{API Key}` (トラッキングAPI用のAPIキー)

URLパラメータ

パラメータ	説明	型	必須
trackerId	エージェントID	String	○
platform	プラットフォーム (現在"api"のみ利用可能)	String	○

リクエストボディ

{
  "event": "イベントデータ（文字列形式）",
  "userId": "ユーザー識別子",
  "state": {
    "key1": "value1",
    "key2": "value2"
  },
  "disableAiRecord": false
}

パラメータ	説明	型	必須
event	イベントデータ（文字列形式）	String	○
userId	ユーザー識別子	String	○
state	ユーザーステート	Map (String : String)
disableAiRecord	AIによるトラッキング処理を無効化し、リクエスト内容をそのままトラッキングします。(default: false)	Boolean

認証について

X-API-Keyヘッダーを使用して認証を行います

レスポンス情報

ステータスコード

ステータスコード	説明
200	リクエスト成功
400	Bad Request（リクエストに問題あり）
401	Unauthorized（認証エラー）
404	Not Found（エージェントが存在しない）
500	Internal Server Error（サーバーエラー）

レスポンスボディ

リクエスト成功時（200）:

{}

エラー時:

{
  "error": "エラーメッセージ"
}

使用例

リクエスト例

curl -X POST \
  -H "Content-Type: application/json" \
  -H "X-API-Key: {your-api-key}" \
  -d '{
    "event": "ユーザーがサブスクリプションを購入しました。(購入プラン: Standard)",
    "userId": "user_123456",
    "state": {
      "last_visited": "2023-03-26"
    }
  }' \
  https://api-mebo.dev/tracker/`{trackerId}`/custom

注意事項

userId が空の場合、400エラーが返されます
event が空の場合、400エラーが返されます
プラットフォーム別の認証に失敗した場合、401エラーが返されます
エージェントが存在しない場合、404エラーが返されます
サーバー内部でエラーが発生した場合、500エラーが返されます

利用方法

具体的な利用用途や方法に関しては、下記の記事をご参照ください。

<https://note.com/makunugi/n/n14fecc26e087?sub_rt=share_pb>