> ## Documentation Index
> Fetch the complete documentation index at: https://ara-90a60a07.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Verify credentials
> Returns the principal behind the current key and the organization it can act on. Call this first to discover your `org_id`.
Auth: any valid API key (no scope)
## OpenAPI
````yaml /openapi/openapi.json get /v3/self
openapi: 3.1.0
info:
title: Ara API
version: 3.0.0
description: >-
The Ara HTTP API. Drive cloud software-engineering agents: open sessions
against your repositories, stream their work, and manage the secrets,
knowledge, skills, and automations they run with.
All requests authenticate with an `ara_` API key sent as a bearer token.
Every resource is scoped to an organization; resolve your `org_id` once with
`GET /v3/self`.
servers:
- url: https://api.ara.so
security:
- araApiKey: []
tags:
- name: Account
description: Verify a key and resolve the organization it belongs to.
- name: Sessions
description: >-
A session is one run of an agent against a repository: it reproduces the
task, writes the code, verifies it, and opens a pull request or merge
request.
- name: Secrets
description: >-
Encrypted credentials injected into the agent's sandbox. Write-only:
values can be set but never read back.
- name: Knowledge
description: Durable notes the agent consults while it works.
- name: Memory
description: >-
Editable repository notes that are projected into native memory; generated
memory remains read-only.
- name: Skills
description: Reusable instruction bundles that activate for matching agent tasks.
- name: Automations
description: Recurring or one-time triggers that open sessions on a timetable.
- name: Change Request Reviews
description: >-
Automated senior-engineer reviews posted on pull requests and merge
requests.
- name: Repositories
description: Connected repositories, their indexing state, and generated wikis.
- name: Git Connections
description: Linked source-control accounts and the repositories they expose.
- name: Consumption
description: 'Billing-aligned usage: daily consumption and billing cycles.'
- name: Metrics
description: Aggregate analytics over sessions, change requests, and usage.
- name: Audit Logs
description: An append-only record of changes made within the organization.
- name: Organizations
description: The top-level tenant. Create, read, update, and delete organizations.
- name: Members
description: People in an organization and their pending invites.
- name: Service Users
description: Machine principals that own API keys for headless access.
- name: Roles
description: Role assignments that govern what each member can do.
- name: Attachments
description: >-
Files uploaded to the organization and shared with sessions, downloaded
via short-lived signed URLs.
- name: Guardrails
description: >-
Per-repository automation limits and the violations recorded when a limit
is hit.
- name: MCP Servers
description: >-
Org-level Model Context Protocol servers exposed to the agent. Secret
values are write-only.
- name: Settings
description: 'Organization configuration: namespaced settings and the run tag policy.'
- name: Blueprints
description: >-
Read-only declarative manifests of an organization's agents (identity, run
config, triggers, suite), with credentials redacted.
- name: IP Access List
description: >-
Source-network allow-list that, when enabled, restricts the organization's
API surface to a set of CIDR ranges.
- name: Groups
description: Manually-curated member groups carrying optional per-day resource limits.
paths:
/v3/self:
get:
tags:
- Account
summary: Verify credentials
description: >-
Returns the principal behind the current key and the organization it can
act on. Call this first to discover your `org_id`.
Auth: any valid API key (no scope)
operationId: getSelf
responses:
'200':
description: The authenticated principal.
content:
application/json:
schema:
$ref: '#/components/schemas/Self'
example:
principal_type: service_user
service_user_id: key_3f9a
service_user_name: ci-bot
org_id: org_8c2d1e
'401':
$ref: '#/components/responses/Unauthorized'
security:
- araApiKey: []
components:
schemas:
Self:
type: object
properties:
principal_type:
type: string
enum:
- service_user
- user
description: >-
API keys resolve to `service_user`; MCP OAuth grants resolve to
`user`.
service_user_id:
type: string
description: Present when `principal_type` is `service_user`.
service_user_name:
description: Present when `principal_type` is `service_user`.
type:
- string
- 'null'
org_id:
type: string
description: Organization pinned to the current credential.
user_id:
type: string
description: Present when `principal_type` is `user`.
user_name:
description: Present when `principal_type` is `user`.
type:
- string
- 'null'
email:
description: Present when `principal_type` is `user`.
type:
- string
- 'null'
organization_name:
description: Display name of the organization pinned to this credential.
type:
- string
- 'null'
organization_slug:
description: URL slug of the organization pinned to this credential.
type:
- string
- 'null'
mcp_connections:
type: array
items:
type: object
properties:
client_id:
type: string
client_name:
type: string
last_used_at:
type:
- string
- 'null'
required:
- client_id
- client_name
- last_used_at
description: >-
Active MCP OAuth client grants for the signed-in user and
organization.
Error:
type: object
properties:
error:
type: string
message:
type: string
responses:
Unauthorized:
description: Missing, invalid, or expired key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: unauthorized
securitySchemes:
araApiKey:
type: http
scheme: bearer
bearerFormat: ara_
description: >-
Your `ara_` API key from Settings > Ara API. Keys are capability-scoped:
run, plugins:read, secrets:read, secrets:write, sessions:read,
knowledge:read, repos:read, repos:write, reviews:read, reviews:write,
analytics:read, org:read, org:write, attachments:read,
attachments:write, plugins:write, guardrails:read, guardrails:write.
````