Descripción general de la API

La API de Arlet te permite gestionar repositorios, ejecutar análisis de código, ejecutar código y configurar integraciones de forma programática. Todos los endpoints utilizan JSON sobre HTTPS.

URL base

https://api.arlet.dev

Versionado

Todos los endpoints de recursos llevan el prefijo /v1. Los endpoints de OAuth y descubrimiento no tienen versión.

Autenticación

La mayoría de los endpoints requieren un token Bearer. Pásalo en el encabezado Authorization:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.arlet.dev/v1/repositories

Puedes crear y gestionar claves de API desde el panel de control o a través de los endpoints de claves de API.

Formato de respuesta

Todas las respuestas devuelven JSON. Las respuestas exitosas utilizan códigos de estado HTTP estándar:

Código	Significado
`200`	Éxito
`201`	Recurso creado
`204`	Éxito sin cuerpo de respuesta
`422`	Error de validación

Respuestas de error

Los errores de validación devuelven un estado 422 con detalles sobre qué campos fallaron:

{
  "detail": [
    {
      "loc": ["body", "field_name"],
      "msg": "description of the error",
      "type": "error_type"
    }
  ]
}

Grupos de endpoints

Usa la barra lateral para explorar todos los endpoints disponibles, organizados por grupo:

Repositorios — registrar, listar y gestionar repositorios
Archivos de repositorio — explorar archivos dentro de un repositorio
Análisis de código — iniciar, monitorear y gestionar análisis de código
Ejecución de código — ejecutar código y obtener resultados de ejecución
Streaming de ejecución — transmitir logs de stdout/stderr en tiempo real vía SSE
Claves de API — crear y revocar claves de API
Variables de entorno — gestionar variables de entorno para la ejecución
Integración con GitHub — conectar y gestionar repositorios de GitHub
GitHub App Webhooks — recibir eventos push y pull request para análisis automatizado
OAuth 2.0 — autorización, tokens y registro de clientes

​URL base

​Versionado

​Autenticación

​Formato de respuesta

​Respuestas de error

​Grupos de endpoints