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

# Aperçu de l'API

> Aperçu de l'API Arlet pour la gestion des dépôts, l'analyse de code et l'exécution.

L'API Arlet vous permet de gérer des dépôts, d'exécuter des analyses de code, d'exécuter du code et de configurer des intégrations de manière programmatique. Tous les endpoints utilisent JSON sur HTTPS.

## URL de base

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

## Versionnage

Tous les endpoints de ressources sont préfixés par `/v1`. Les endpoints OAuth et de découverte ne sont pas versionnés.

## Authentification

La plupart des endpoints nécessitent un token Bearer. Transmettez-le dans l'en-tête `Authorization` :

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

Vous pouvez créer et gérer vos clés API depuis le tableau de bord ou via les endpoints de clés API.

## Format de réponse

Toutes les réponses renvoient du JSON. Les réponses réussies utilisent les codes de statut HTTP standard :

| Code  | Signification                |
| ----- | ---------------------------- |
| `200` | Succès                       |
| `201` | Ressource créée              |
| `204` | Succès sans corps de réponse |
| `422` | Erreur de validation         |

## Réponses d'erreur

Les erreurs de validation renvoient un statut `422` avec des détails sur les champs en échec :

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

## Groupes d'endpoints

Utilisez la barre latérale pour parcourir tous les endpoints disponibles, organisés par groupe :

* **Dépôts** — enregistrer, lister et gérer les dépôts
* **Fichiers de dépôt** — parcourir les fichiers d'un dépôt
* **Analyse de code** — démarrer, surveiller et gérer les analyses de code
* **Exécution de code** — exécuter du code et récupérer les résultats d'exécution
* **Streaming d'exécution** — diffuser les logs stdout/stderr en temps réel via SSE
* **Clés API** — créer et révoquer des clés API
* **Variables d'environnement** — gérer les variables d'environnement pour l'exécution
* **Intégration GitHub** — connecter et gérer les dépôts GitHub
* **GitHub App Webhooks** — recevoir les événements push et pull request pour l'analyse automatisée
* **OAuth 2.0** — autorisation, tokens et enregistrement de clients