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

> Overview of the Arlet API for managing repositories, code analysis, and execution.

The Arlet API lets you manage repositories, run code analysis, execute code, and configure integrations programmatically. All endpoints use JSON over HTTPS.

## Base URL

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

## Versioning

All resource endpoints are prefixed with `/v1`. OAuth and discovery endpoints are unversioned.

## Authentication

Most endpoints require a bearer token. Pass it in the `Authorization` header:

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

You can create and manage API keys from the dashboard or via the API keys endpoints.

## Response format

All responses return JSON. Successful responses use standard HTTP status codes:

| Code  | Meaning                       |
| ----- | ----------------------------- |
| `200` | Success                       |
| `201` | Resource created              |
| `204` | Success with no response body |
| `422` | Validation error              |

## Error responses

Validation errors return a `422` status with details about which fields failed:

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

## Endpoint groups

Use the sidebar to browse all available endpoints organized by group:

* **Repositories** — Register, list, and manage repositories
* **Repository files** — Browse files within a repository
* **Code analysis** — Start, monitor, and manage code analyses
* **Code execution** — Run code and retrieve execution results
* **Run streaming** — Stream real-time stdout/stderr logs via SSE
* **API keys** — Create and revoke API keys
* **Environment variables** — Manage environment variables for execution
* **GitHub integration** — Connect and manage GitHub repositories
* **GitHub App Webhooks** — Receive push and pull request events for automated analysis
* **OAuth 2.0** — Authorization, tokens, and client registration