Referensi API

API publik tersedia di https://api.ara.so/v3. Kunci API ara_ terikat pada workspace Ara tempat kunci tersebut dibuat.

Dapatkan kunci API

1. Masuk ke Ara dan buka workspace Anda.
2. Buka Settings → Ara CLI.
3. Di bawah API keys for CI, pilih Generate key.
4. Pilih cakupan tersempit dan tanggal kedaluwarsa, lalu salin kuncinya.

Verifikasi kunci

Setel kunci di shell Anda dan panggil /v3/self:

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

Respons menyertakan ID organisasi yang terikat pada kunci:

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

Gunakan nilai tersebut pada contoh-contoh berikutnya:

$
export ARA_ORG_ID="org_8c2d1e"

Coba API

Daftar repositori yang terhubung

Memerlukan repos:read.

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

Mulai sesi

Memerlukan run. Ganti acme/web dengan repositori yang terhubung ke workspace.

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

Respons menyertakan session_id. Pembuatan sesi bersifat asinkron.

Baca sesi

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

Cakupan umum

Untuk kolom permintaan yang tepat, skema respons, dan setiap endpoint publik, buka referensi endpoint lengkap.

Kesalahan