AI版 (llms.txt)

ProxyHatは、AIアシスタントがAPIを直接読み取って推論できるよう、このドキュメントの機械可読版を公開しています。Claude、Cursor、CodexなどのLLM搭載ツールでインテグレーションを構築する際は、これらのファイルを渡すだけで、推測に頼ることなくAPIの正確な全体像を把握させることができます。

2つのファイル

リンクインデックス — 各ドキュメントページを1行の要約とURL付きで列挙した短いMarkdownファイルです。アシスタントのコンテキストに常駐させられるほど小さく、モデルは必要に応じて個々のページを取得します。

完全版ドキュメント — 全ページを1つのMarkdownドキュメントに連結したものです。リンクをたどる必要も、取得する必要もありません。一度貼り付ければ、アシスタントはAPI全体を理解します。

お使いのツールでの使い方

どのツールでも使えるアプローチは2つあります。

• 貼り付ける。 上の「AI用にコピー」をクリックし（または https://docs.proxyhat.com/llms-full.txt を開いてファイル全体をコピーし）、アシスタントのチャットやコンテキスト／ルールファイルに貼り付けます。ツールがインターネットにアクセスできない場合に最適です。
• URLを指定する。 ツールに https://docs.proxyhat.com/llms.txt または https://docs.proxyhat.com/llms-full.txt のURLを渡して取得させます。Webアクセスやファイル取得機能を持つツールに最適です。

ツール別の補足

• Claude / Claude Code — llms-full.txt の内容を会話に貼り付けるか、プロジェクトの CLAUDE.md にURLを追加して、すべてのセッションで読み込まれるようにします。Claude CodeならWebツールでURLを直接取得することもできます。
• Codex — URLまたは貼り付けた内容を AGENTS.md（もしくはプロンプト）に入れておくと、エージェントがインテグレーションを書く際に参照します。
• Cursor — Settings → Indexing & Docs（Add new doc）で https://docs.proxyhat.com/llms-full.txt を追加するか、ファイルを .cursorrules やプロジェクトルールに貼り付けます。
• Kimi — llms-full.txt の内容をチャットに貼り付けるか、URLを共有して先にファイルを読むよう指示します。
• OpenCode — エージェント設定／ルールファイルでURLを参照するか、ファイル全体をコンテキストに貼り付けます。
• その他のLLM — やり方は同じです。「AI用にコピー」ボタンを使うか、llms-full.txt の内容をアシスタントに貼り付けるか、上記のURLをツールに指定してください。

AIが学習する内容

これらのファイルから、アシスタントは動作するインテグレーションを書くために必要な情報をすべて得られます。たとえば次のとおりです。

• ベースURL — すべてのリクエストは https://api.proxyhat.com/v1 に送信します。
• 認証 — APIキーの取得方法と、Authorization: Bearer <key> として送信する方法。
• サブユーザーモデル — サブユーザー、グループ、プリセットがプロキシアクセスにどう対応付けられるか。
• プロキシ接続文字列 — ユーザー名の文法（国、セッション、ローテーション、AIフィルターのターゲティング）と、そのまま使える接続文字列を組み立てる、または取得する方法。
• リセラーフロー — 自社の顧客に代わってプロキシをプロビジョニングし、管理する方法。
• レスポンスの形式 — どのエンドポイントが標準の {success, payload, meta, errors, description} エンベロープを使い、どれがフラットなオブジェクトを返すかを、実際のフィールド名とあわせて把握できます。