APIファースト製品向けllms.txt

開発者は API について頻繁に AI アシスタントへ質問します。適切に選定された llms.txt は、実在しないエンドポイント、誤ったパラメーター、古い例の生成を減らします。

最終更新:

API製品が最大の恩恵を受ける理由

APIファーストの製品や開発者向けツールは、 llms.txtの恩恵を最も受けやすいサイトタイプの一つです。開発者は、APIに関する質問(ページネーションの方法、 レート制限、認証方法、特定のエラーの処理方法など)をAIコーディングアシスタントに頻繁に尋ねます。これらは 正確で、回答可能な質問です。 AIが正確なドキュメントを持っている場合、その回答は有用です。 そうでない場合、AIは近似値を算出することになり、APIに関する近似値はバグの原因となります。

対応エージェントまたは検索ワークフローを、APIの参照リストとしてllms.txtを使用するよう設定できます。その管理されたケースでは、回答前に読み込まれたドキュメントを追跡できます。

APIの幻覚問題

AI 言語モデルは、ときにもっともらしいものの誤った API 情報を生成します。よくあるパターン:

  • 存在しない、または名称変更されたエンドポイント。
  • 以前のAPIバージョンのパラメーター。
  • レスポンススキーマのフィールドが古い、または誤っている。
  • APIが対応していない認証方式。
  • 異なるプランや古い料金体系に基づくレート制限。

こうした誤りは、モデルの学習データが数か月または数年前のものである一方、API は進化し続けるために発生します。回答前に検索システムが実際のドキュメントを取得すれば、現在の内容を利用できます。llms.txt は、検索システムを信頼できる公式ページへ案内するのに役立ちます。

含めるべき内容

APIファーストの製品については、以下のページタイプを優先してください:

  • APIリファレンス、完全なエンドポイントリファレンス。非常に長い場合は、トップレベルのページにリンクします。
  • 認証ガイド、認証情報の取得方法とリクエストでの渡し方。
  • クイックスタートガイド、ゼロから実用的なAPI呼び出しを実現するまでの最短ルート。
  • レート制限と割り当て、プランおよびエンドポイント種別ごとの具体的な制限。
  • エラーリファレンス, エラーコードとその意味。
  • SDKドキュメントへのリンク、公式にサポートされている言語のSDKごとにリンクを1件掲載します。
  • 変更履歴またはリリースノートは、検索システムが現在の APIの状態を理解するのに役立ちます。
  • Webhook リファレンス、API が Webhook を送信する場合は、そのリンクを追加します。

除外すべきもの

  • 認証が必要なドキュメント。ログインが必要なページは、AI エージェントが取得しようとすると失敗します。
  • 内部ページまたはベータ版ページ、一般公開の準備ができていないページにはリンクしません。
  • 非推奨のAPIバージョン。旧バージョンのドキュメントは除外します。
  • マーケティング用ランディングページ、技術的な 質問をする開発者にとっては役に立たない。
  • コミュニティフォーラムまたはSlackへのリンク。AIクローラーが確実に 解析できない動的コンテンツです。

テンプレート例

架空の API 製品向けの完全な例です。ドキュメントの構成に合わせて調整してください。

# Acme API

> Acme provides a REST API for real-time inventory management. The API supports CRUD
> operations on products, locations, and stock adjustments, plus webhook notifications.
> Authentication uses API keys in the Authorization header.

## Core documentation

- [API reference](https://docs.acme.example/api/): complete endpoint reference.
- [Authentication](https://docs.acme.example/authentication/): API key setup and OAuth 2.0.
- [Quickstart](https://docs.acme.example/quickstart/): first API call in five minutes.
- [Rate limits](https://docs.acme.example/rate-limits/): limits by tier.
- [Errors](https://docs.acme.example/errors/): error codes and recommended handling.
- [Webhooks](https://docs.acme.example/webhooks/): event types and payload schema.

## SDKs

- [Python SDK](https://docs.acme.example/sdk/python/): official Python library.
- [Node.js SDK](https://docs.acme.example/sdk/node/): official Node.js library.
- [Go SDK](https://docs.acme.example/sdk/go/): official Go client.

## Optional

- [Changelog](https://docs.acme.example/changelog/): API version history and breaking changes.
- [Migration guides](https://docs.acme.example/migrations/): upgrading between major versions.
- [Status page](https://status.acme.example/): API uptime and incident history.

SDKおよび多言語対応に関する考慮事項

製品に複数言語向けのSDKがある場合は、各SDKのドキュメントを個別にリンクします。 明確な ## SDKs セクションにまとめ、各SDKのトップレベルページへリンクする。 個々のサブページすべてにリンクする必要はない。

最新状態の維持

  • APIリリースチェックリストに「llms.txt」のレビューを追加してください。
  • 新しいメジャーバージョンのAPIをリリースする際は、リンクを更新して最新バージョンのドキュメントを指すようにしてください。
  • ドキュメントページを廃止する際は、それらのリンクを直ちに削除または置換してください。
  • ドキュメントを頻繁に更新する場合は、ドキュメント CMS から llms.txt を自動生成することを検討してください。

続きを読む

ソース