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

> Übersicht über die Arlet-API zur Verwaltung von Repositories, Codeanalyse und Ausführung.

Mit der Arlet-API können Sie Repositories verwalten, Codeanalysen ausführen, Code ausführen und Integrationen programmatisch konfigurieren. Alle Endpunkte verwenden JSON über HTTPS.

## Basis-URL

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

## Versionierung

Alle Ressourcen-Endpunkte haben das Präfix `/v1`. OAuth- und Discovery-Endpunkte sind nicht versioniert.

## Authentifizierung

Die meisten Endpunkte erfordern ein Bearer-Token. Übergeben Sie es im `Authorization`-Header:

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

Sie können API-Schlüssel über das Dashboard oder über die API-Schlüssel-Endpunkte erstellen und verwalten.

## Antwortformat

Alle Antworten geben JSON zurück. Erfolgreiche Antworten verwenden Standard-HTTP-Statuscodes:

| Code  | Bedeutung                 |
| ----- | ------------------------- |
| `200` | Erfolg                    |
| `201` | Ressource erstellt        |
| `204` | Erfolg ohne Antwortkörper |
| `422` | Validierungsfehler        |

## Fehlerantworten

Validierungsfehler geben einen `422`-Status mit Details darüber zurück, welche Felder fehlgeschlagen sind:

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

## Endpunktgruppen

Verwenden Sie die Seitenleiste, um alle verfügbaren Endpunkte nach Gruppen sortiert zu durchsuchen:

* **Repositories** — Repositories registrieren, auflisten und verwalten
* **Repository-Dateien** — Dateien innerhalb eines Repositories durchsuchen
* **Codeanalyse** — Codeanalysen starten, überwachen und verwalten
* **Codeausführung** — Code ausführen und Ausführungsergebnisse abrufen
* **Run-Streaming** — Echtzeit-stdout/stderr-Logs über SSE streamen
* **API-Schlüssel** — API-Schlüssel erstellen und widerrufen
* **Umgebungsvariablen** — Umgebungsvariablen für die Ausführung verwalten
* **GitHub-Integration** — GitHub-Repositories verbinden und verwalten
* **GitHub App Webhooks** — Push- und Pull-Request-Ereignisse für automatisierte Analyse empfangen
* **OAuth 2.0** — Autorisierung, Tokens und Client-Registrierung
