> ## 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.
# Request a change request review
> Automated pull-request and merge-request reviews are currently disabled. Valid requests return `409 pr_review_disabled`.
Scope: `reviews:write`
## OpenAPI
````yaml /openapi.json post /v3/organizations/{orgId}/pr-reviews
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 Ara selects semantically from their
descriptions 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/organizations/{orgId}/pr-reviews:
parameters:
- $ref: '#/components/parameters/orgId'
post:
tags:
- Change Request Reviews
summary: Request a change request review
description: >-
Automated pull-request and merge-request reviews are currently disabled.
Valid requests return `409 pr_review_disabled`.
Scope: `reviews:write`
operationId: triggerPrReview
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePrReview'
example:
repository: acme/web
pr_number: 482
provider: github
instructions: Pay special attention to the new auth middleware.
responses:
'201':
description: >-
Legacy success response retained for client compatibility. The
code-disabled service does not emit this response.
content:
application/json:
example:
pr_review_id: rev_71c2a8
status: queued
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'409':
description: Automated pull-request reviews are disabled.
security:
- araApiKey:
- reviews:write
components:
parameters:
orgId:
name: orgId
in: path
required: true
description: Organization id or slug. Resolve it with `GET /v3/self`.
schema:
type: string
schemas:
CreatePrReview:
type: object
properties:
repository:
type: string
description: GitHub repository path.
pr_number:
type: integer
description: The pull request number to review.
pr_url:
type: string
description: GitHub pull request URL. Alternative to `repository` + `pr_number`.
provider:
type: string
enum:
- github
description: Source-control provider. GitHub is the only supported provider.
instructions:
type: string
description: Optional guidance to focus the review.
Error:
type: object
properties:
error:
type: string
message:
type: string
required_scope:
type: string
description: >-
The capability required when the request was denied for a missing
scope.
responses:
BadRequest:
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: prompt_required
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, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read,
sessions:debug, knowledge:read, memory:read, memory:write, skills:read,
skills:write, repos:read, repos:write, reviews:read, reviews:write,
deployment:read, analytics:read, org:read, org:write, attachments:read,
attachments:write, guardrails:read, guardrails:write, automations:read,
automations:write, agent_auth:read. mcp:write manages MCP server
configuration only; it does not authorize remote MCP-tool execution.
sessions:debug is privileged: it expands diagnostic session events only
for organization owners/admins.
````