> ## 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 REST API 概述。

欢迎使用 LLMGenerator API 文档。我们的 API 以编程方式提供 LLMGenerator 的核心能力，便于你在应用中集成 `llms.txt` 的生成与管理。

## 基础 URL

所有接口路径均相对于以下基础 URL：

```
https://api.llmgenerator.com/api/v1
```

## 认证

LLMGenerator API 使用 API Key 鉴权。你可以在 [设置 → API Keys](https://app.llmgenerator.com/settings/api-keys) 创建并管理密钥。

所有需要认证的请求必须在请求头中包含 `Authorization`，值为 Bearer 方式的 API Key。

```
Authorization: Bearer YOUR_API_KEY
```

<Warning>
  请妥善保管 API Key，不要在 GitHub、前端代码等公开环境中泄露。
</Warning>

## 生成方式

API 支持两种生成方式：

| 方式               | 说明                     | 积分 |
| ---------------- | ---------------------- | -- |
| **Simple（简明）**   | 基于页面元数据的快速生成，适合尽快拿到结果。 | 1x |
| **Enhanced（增强）** | AI 优化标题与描述，质量更高。       | 2x |

你可以在 `/generate` 接口通过 `generationMethod` 指定方式。免费套餐用户仅能使用 `simple`。

## 积分体系

API 使用量按积分计费：

* **简明生成**：按处理的 URL 数扣除基础积分
* **增强生成**：AI 处理适用 2x 积分倍率
* **全文**：包含完整页面内容会额外消耗积分

可通过 `/credits/balance` 查询余额。

## 限速

请求频率按订阅方案限制。超过限额将返回 `429 Too Many Requests`。响应头中包含限速信息：

* `X-RateLimit-Limit`：每分钟最大请求数
* `X-RateLimit-Remaining`：当前时间窗口内剩余请求数
* `X-RateLimit-Reset`：窗口重置时间（UTC 纪元秒）

## CORS

公开文件接口（`/file/:siteId`）支持 CORS，可在浏览器中直接访问，无需认证。

## 错误

API 使用标准 HTTP 状态码：

| 代码    | 说明                 |
| ----- | ------------------ |
| `200` | 成功                 |
| `201` | 资源已创建              |
| `400` | 错误请求（校验失败）         |
| `401` | 未授权（API Key 无效或缺失） |
| `403` | 禁止访问（权限不足）         |
| `404` | 资源不存在              |
| `429` | 超出速率限制             |
| `500` | 服务器内部错误            |

错误响应体为 JSON：

```json theme={null}
{
  "message": "Validation error: URL is required"
}
```

## Webhook

对于耗时较长的任务，可配置 Webhook URL，在任务完成时接收通知。如需为你的账户启用 Webhook，请联系支持团队。