> ## 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** — 授权、令牌和客户端注册