Skip to main content
LLMGenerator API ドキュメントへようこそ。本 API では、llms.txt の生成や管理をアプリケーションに直接組み込むためのプログラムからのアクセスを提供します。

​
ベース URL

すべての API エンドポイントは、次のベース URL を基準とした相対パスです。

​
認証（API キー）

LLMGenerator API では、API キーでリクエストを認証します。API キーは 設定 → API キー で作成・管理できます。 認証が必要なリクエストには、Authorization ヘッダーに API キーを Bearer トークンとして付与します。
API キーは厳重に管理してください。GitHub やクライアント側のコードなど、公開されうる場所に置かないでください。

​
生成方式

API では次の 2 つの生成方式をサポートします。 /generate エンドポイントの generationMethod パラメーターで方式を指定できます。無料プランでは simple のみ利用できます。

​
クレジット制度

API の利用状況はクレジットで集計されます。
  • Simple 生成: 処理した URL あたりの基本クレジット
  • Enhanced 生成: AI 処理のため 2 倍のクレジット係数
  • フルテキスト: ページ全文を含める場合の追加クレジット
残高は /credits/balance エンドポイントで確認できます。

​
レート制限

API リクエストは契約プランに応じてレート制限されます。制限を超えると 429 Too Many Requests が返ります。レスポンスヘッダーに次のレート制限情報が含まれます。
  • X-RateLimit-Limit: 1 分あたりの最大リクエスト数
  • X-RateLimit-Remaining: 現在のウィンドウで残りのリクエスト数
  • X-RateLimit-Reset: ウィンドウがリセットされる時刻（UTC のエポック秒）

​
CORS 対応

公開ファイル用エンドポイント（/file/:siteId）は CORS に対応しており、ブラウザから直接呼び出せます。認証は不要です。

​
エラー

API は標準的な HTTP ステータスコードを使用します。 エラーレスポンスには JSON ボディが含まれます。

​
Webhook

長時間かかる処理については、ジョブ完了時に通知を受け取る Webhook URL を設定できます。アカウントで Webhook を有効にするにはサポートへお問い合わせください。