Referencia de API

La API pública se encuentra en https://api.ara.so/v3. Una clave de API ara_ está vinculada al espacio de trabajo de Ara donde fue creada.

Obtener una clave de API

1. Inicia sesión en Ara y abre tu espacio de trabajo.
2. Abre Configuración → Ara CLI.
3. En Claves de API para CI, selecciona Generar clave.
4. Elige los permisos más restrictivos y una fecha de expiración, luego copia la clave.

Verificar la clave

Establece la clave en tu shell y llama a /v3/self:

$
export ARA_API_KEY="ara_..."
$
$
curl https://api.ara.so/v3/self \
>
  -H "Authorization: Bearer $ARA_API_KEY"

La respuesta incluye el ID de organización vinculado a la clave:

1
{
2
  "principal_type": "service_user",
3
  "service_user_id": "key_3f9a",
4
  "service_user_name": "ci-bot",
5
  "org_id": "org_8c2d1e"
6
}

Usa ese valor en los ejemplos restantes:

$
export ARA_ORG_ID="org_8c2d1e"

Probar la API

Listar repositorios conectados

Requiere repos:read.

$
curl "https://api.ara.so/v3/organizations/$ARA_ORG_ID/repositories" \
>
  -H "Authorization: Bearer $ARA_API_KEY"

Iniciar una sesión

Requiere run. Reemplaza acme/web con un repositorio conectado al espacio de trabajo.

$
curl "https://api.ara.so/v3/organizations/$ARA_ORG_ID/sessions" \
>
  -H "Authorization: Bearer $ARA_API_KEY" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "repo": "acme/web",
>
    "prompt": "Fix the flaky auth test, add a regression case, and open a PR."
>
  }'

La respuesta incluye un session_id. La creación de sesiones es asíncrona.

Leer la sesión

Requiere sessions:read.

$
export ARA_SESSION_ID="ses_91af3c"
$
$
curl "https://api.ara.so/v3/organizations/$ARA_ORG_ID/sessions/$ARA_SESSION_ID" \
>
  -H "Authorization: Bearer $ARA_API_KEY"

Permisos comunes

Para conocer los campos exactos de las solicitudes, los esquemas de respuesta y todos los endpoints públicos, abre la referencia completa de endpoints.

Errores