> ## 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.
# Bulk index repositories
> Starts indexing for many repositories at once. Each entry may be an `owner/name` string or an `{ owner, repo }` object. Returns a per-repository result so partial failures are visible.
Scope: `repos:write`
## OpenAPI
````yaml /openapi/openapi.json put /v3/organizations/{orgId}/repositories/bulk-index
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/organizations/{orgId}/repositories/bulk-index:
parameters:
- $ref: '#/components/parameters/orgId'
put:
tags:
- Repositories
summary: Bulk index repositories
description: >-
Starts indexing for many repositories at once. Each entry may be an
`owner/name` string or an `{ owner, repo }` object. Returns a
per-repository result so partial failures are visible.
Scope: `repos:write`
operationId: bulkIndexRepositories
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BulkRepoRequest'
example:
repositories:
- acme/web
- owner: group
repo: subgroup/project
provider: gitlab
responses:
'200':
description: Per-repository results.
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
$ref: '#/components/schemas/BulkRepoResult'
example:
results:
- repo: acme/web
status: indexing
- repo: acme/api
status: error
error: not_connected
'400':
$ref: '#/components/responses/BadRequest'
'402':
description: Available during an Ara trial or paid subscription.
security:
- araApiKey:
- repos: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:
BulkRepoRequest:
type: object
properties:
repositories:
type: array
items:
oneOf:
- type: string
description: Repository in `owner/name` form.
- type: object
properties:
owner:
type: string
repo:
type: string
required:
- owner
- repo
required:
- repositories
description: >-
A list of repositories to operate on. Each entry is either an
`owner/name` string or an `{ owner, repo }` object.
BulkRepoResult:
type: object
properties:
repo:
type: string
description: >-
Provider-native repository path. GitHub uses `owner/name`; GitLab
may include nested groups.
status:
type: string
description: Per-repository status, e.g. `indexing`, `removed`, or `error`.
error:
type: string
description: Present only when `status` is `error`.
repo_enabled:
type: boolean
description: True when the repository row exists even though provisioning failed.
retryable:
type: boolean
action:
type: string
enum:
- reconnect_gitlab
- grant_gitlab_project_permission
description: The outcome of a bulk operation for a single repository.
Error:
type: object
properties:
error:
type: string
message:
type: string
responses:
BadRequest:
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: prompt_required
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.
````