メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.llmgenerator.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
ベース URL

すべての API エンドポイントは、次のベース URL を基準とした相対パスです。 
https://api.llmgenerator.com/api/v1

​
認証（API キー）

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

​
生成方式

API では次の 2 つの生成方式をサポートします。
メソッド説明クレジット消費
Simpleページのメタデータを用いた高速生成。迅速な結果向けです。1x
Enhancedタイトル・説明文を AI で改善した生成方式。2x
/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 ステータスコードを使用します。
コード説明
200成功
201リソース作成済み
400不正なリクエスト（バリデーションエラー）
401未認証（API キーが無効または未指定）
403禁止（権限不足）
404リソースが見つからない
429レート制限超過
500サーバー内部エラー
エラーレスポンスには JSON ボディが含まれます。 
{
  "message": "Validation error: URL is required"
}

​
Webhook

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