API-Referenz

Die öffentliche API ist unter https://api.ara.so/v3 erreichbar. Ein ara_ API-Schlüssel ist an den Ara-Arbeitsbereich gebunden, in dem er erstellt wurde.

API-Schlüssel abrufen

1. Melden Sie sich bei Ara an und öffnen Sie Ihren Arbeitsbereich.
2. Öffnen Sie Einstellungen → Ara CLI.
3. Wählen Sie unter API-Schlüssel für CI die Option Schlüssel generieren.
4. Wählen Sie die engsten Berechtigungen und ein Ablaufdatum, und kopieren Sie dann den Schlüssel.

Schlüssel verifizieren

Setzen Sie den Schlüssel in Ihrer Shell und rufen Sie /v3/self auf:

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

Die Antwort enthält die an den Schlüssel gebundene Organisations-ID:

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

Verwenden Sie diesen Wert in den verbleibenden Beispielen:

$
export ARA_ORG_ID="org_8c2d1e"

API ausprobieren

Verbundene Repositories auflisten

Erfordert repos:read.

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

Sitzung starten

Erfordert run. Ersetzen Sie acme/web durch ein mit dem Arbeitsbereich verbundenes Repository.

$
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."
>
  }'

Die Antwort enthält eine session_id. Die Sitzungserstellung erfolgt asynchron.

Sitzung lesen

Erfordert 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"

Häufige Berechtigungen

Für genaue Anforderungsfelder, Antwortschemata und alle öffentlichen Endpunkte öffnen Sie die vollständige Endpunkt-Referenz.

Fehler