Quickstart | Ara Documentation

You need an ara_ API key and one connected GitHub repository or GitLab project. This walks through both, then opens a session and watches it work.

Create an API key

In the web app, go to Settings → Ara API and create a key. It looks like ara_ followed by a long hex string. Store it as an environment variable.

$ export ARA_API_KEY="ara_..."

Resolve your organization

Every resource is scoped to an organization. Get your org_id once and reuse it.

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

Open a session

Point an agent at a connected repository or project and describe the task. The session starts immediately and runs asynchronously. If the same path exists on both GitHub and GitLab, include "provider": "github" or "provider": "gitlab" in the request body.

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

Opening a session runs a real agent in a sandbox and consumes quota. Use a test repository while you are getting set up.

Watch it work

Poll GET /sessions/{id} until status is exit, and GET /sessions/{id}/messages for the conversation as it progresses. When the session finishes, it carries a pr_url pointing to the pull request or merge request.

curl

$ curl https://api.ara.so/v3/organizations/$ORG_ID/sessions/$SESSION_ID \
>   -H "Authorization: Bearer $ARA_API_KEY"