> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arlet.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# API 개요

> 리포지토리 관리, 코드 분석 및 실행을 위한 Arlet API 개요.

Arlet API를 사용하면 리포지토리 관리, 코드 분석 실행, 코드 실행, 연동 설정을 프로그래밍 방식으로 수행할 수 있습니다. 모든 엔드포인트는 HTTPS를 통한 JSON을 사용합니다.

## 기본 URL

```bash theme={null}
https://api.arlet.dev
```

## 버전 관리

모든 리소스 엔드포인트에는 `/v1` 접두사가 붙습니다. OAuth 및 디스커버리 엔드포인트에는 버전이 없습니다.

## 인증

대부분의 엔드포인트에는 Bearer 토큰이 필요합니다. `Authorization` 헤더에 전달하세요:

```bash theme={null}
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.arlet.dev/v1/repositories
```

대시보드 또는 API 키 엔드포인트를 통해 API 키를 생성하고 관리할 수 있습니다.

## 응답 형식

모든 응답은 JSON을 반환합니다. 성공적인 응답은 표준 HTTP 상태 코드를 사용합니다:

| 코드    | 의미           |
| ----- | ------------ |
| `200` | 성공           |
| `201` | 리소스 생성됨      |
| `204` | 성공, 응답 본문 없음 |
| `422` | 유효성 검사 오류    |

## 오류 응답

유효성 검사 오류는 `422` 상태를 반환하며, 어떤 필드가 실패했는지에 대한 세부 정보가 포함됩니다:

```json theme={null}
{
  "detail": [
    {
      "loc": ["body", "field_name"],
      "msg": "description of the error",
      "type": "error_type"
    }
  ]
}
```

## 엔드포인트 그룹

사이드바를 사용하여 그룹별로 정리된 모든 사용 가능한 엔드포인트를 탐색하세요:

* **리포지토리** — 리포지토리 등록, 목록 조회 및 관리
* **리포지토리 파일** — 리포지토리 내 파일 탐색
* **코드 분석** — 코드 분석 시작, 모니터링 및 관리
* **코드 실행** — 코드 실행 및 실행 결과 조회
* **런 스트리밍** — SSE를 통한 실시간 stdout/stderr 로그 스트리밍
* **API 키** — API 키 생성 및 폐기
* **환경 변수** — 실행 환경 변수 관리
* **GitHub 연동** — GitHub 리포지토리 연결 및 관리
* **GitHub App Webhooks** — push 및 pull request 이벤트를 수신하여 자동 분석 실행
* **OAuth 2.0** — 인가, 토큰 및 클라이언트 등록