API संदर्भ

सार्वजनिक API https://api.ara.so/v3 पर उपलब्ध है। एक ara_ API key उस Ara workspace से बंधी होती है जहाँ इसे बनाया गया था।

API key प्राप्त करें

1. Ara में साइन इन करें और अपना workspace खोलें।
2. Settings → Ara CLI खोलें।
3. API keys for CI के अंतर्गत, Generate key चुनें।
4. सबसे सीमित scopes और एक expiration चुनें, फिर key कॉपी करें।

key सत्यापित करें

अपने shell में key सेट करें और /v3/self को कॉल करें:

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

प्रतिक्रिया में key से बंधा organization 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
}

शेष उदाहरणों में उस मान का उपयोग करें:

$
export ARA_ORG_ID="org_8c2d1e"

API आज़माएं

जुड़े हुए repositories की सूची बनाएं

repos:read की आवश्यकता है।

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

एक session शुरू करें

run की आवश्यकता है। acme/web को workspace से जुड़े किसी 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."
>
  }'

प्रतिक्रिया में एक session_id शामिल होता है। Session निर्माण असंकालिक है।

session पढ़ें

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"

सामान्य scopes

सटीक request fields, response schemas, और हर सार्वजनिक endpoint के लिए, पूर्ण endpoint संदर्भ खोलें।

त्रुटियाँ