> ## 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

모든 API 엔드포인트는 다음 기본 URL을 기준으로 한 상대 경로입니다:

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

## 인증

LLMGenerator API는 API 키로 요청을 인증합니다. API 키는 [설정 → API Keys](https://app.llmgenerator.com/settings/api-keys)에서 생성·관리할 수 있습니다.

인증이 필요한 모든 요청에는 `Authorization` 헤더에 API 키를 Bearer 토큰 형식으로 넣어야 합니다.

```
Authorization: Bearer YOUR_API_KEY
```

<Warning>
  API 키는 안전하게 보관하세요. GitHub, 클라이언트 쪽 코드 등 외부에 노출되는 곳에는 공유하지 마세요.
</Warning>

## 생성 방식

API는 두 가지 생성 방식을 지원합니다:

| 방법           | 설명                                    | 크레딧 비용 |
| ------------ | ------------------------------------- | ------ |
| **Simple**   | 페이지 메타데이터 기반 빠른 생성입니다. 신속한 결과에 적합합니다. | 1x     |
| **Enhanced** | AI로 제목·설명을 다듬는 생성입니다.                 | 2x     |

`/generate` 엔드포인트의 `generationMethod` 매개변수로 방식을 지정합니다. 무료 플랜에서는 `simple`만 사용할 수 있습니다.

## 크레딧 시스템

API 사용량은 크레딧으로 집계됩니다:

* **Simple 생성**: 처리한 URL당 기본 크레딧
* **Enhanced 생성**: AI 처리에 대한 2배 크레딧 배율
* **Full text**: 전체 페이지 본문을 포함할 때 추가 크레딧

잔액은 `/credits/balance` 엔드포인트로 확인합니다.

## 속도 제한

API 요청은 구독 플랜에 따라 속도 제한됩니다. 제한을 넘으면 `429 Too Many Requests` 응답을 받으며, 응답 헤더에 속도 제한 정보가 포함됩니다:

* `X-RateLimit-Limit`: 분당 최대 요청 수
* `X-RateLimit-Remaining`: 현재 창에서 남은 요청 수
* `X-RateLimit-Reset`: 창이 초기화되는 시각 (UTC epoch 초)

## CORS 지원

공개 파일 엔드포인트(`/file/:siteId`)는 CORS를 지원하며 브라우저에서 직접 호출할 수 있습니다. 이 엔드포인트는 인증이 필요하지 않습니다.

## 오류

API는 표준 HTTP 상태 코드를 사용합니다:

| 코드    | 설명                      |
| ----- | ----------------------- |
| `200` | 성공                      |
| `201` | 리소스 생성됨                 |
| `400` | 잘못된 요청(유효성 검사 오류)       |
| `401` | 인증 실패(잘못되었거나 누락된 API 키) |
| `403` | 권한 없음                   |
| `404` | 리소스 없음                  |
| `429` | 속도 제한 초과                |
| `500` | 서버 내부 오류                |

오류 응답은 JSON 본문을 포함합니다:

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

## 웹훅

실행 시간이 긴 작업 완료 시 알림을 받으려면 웹훅 URL을 설정할 수 있습니다. 계정에 웹훅을 켜려면 지원팀에 문의하세요.