Tài liệu tham khảo API

API công khai được đặt tại https://api.ara.so/v3. Khóa API ara_ được liên kết với workspace Ara nơi nó được tạo ra.

Lấy khóa API

1. Đăng nhập vào Ara và mở workspace của bạn.
2. Mở Settings → Ara CLI.
3. Trong mục API keys for CI, chọn Generate key.
4. Chọn phạm vi hẹp nhất và thời hạn hết hạn, sau đó sao chép khóa.

Xác minh khóa

Đặt khóa trong shell của bạn và gọi /v3/self:

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

Phản hồi bao gồm ID tổ chức được liên kết với khóa:

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

Sử dụng giá trị đó trong các ví dụ còn lại:

$
export ARA_ORG_ID="org_8c2d1e"

Thử nghiệm API

Liệt kê các kho lưu trữ đã kết nối

Yêu cầu repos:read.

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

Bắt đầu một phiên

Yêu cầu run. Thay thế acme/web bằng một kho lưu trữ đã kết nối với 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."
>
  }'

Phản hồi bao gồm một session_id. Việc tạo phiên là bất đồng bộ.

Đọc phiên

Yêu cầu 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"

Các phạm vi phổ biến

Để biết các trường yêu cầu chính xác, lược đồ phản hồi và mọi endpoint công khai, hãy mở tài liệu tham khảo endpoint đầy đủ.

Lỗi