Skip to main content
POST
Create an automation

Authorizations

Authorization
string
header
required

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.

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

Body

application/json

Creates the automation's configuration. It has no triggers until you add one via POST /automations/{automationId}/triggers, so it will not fire on its own yet.

instructions
string
required

The system instructions the automation runs with.

repo
string
required

Connected repository path. GitHub uses owner/name; GitLab projects may include nested groups, such as group/subgroup/project.

name
string

Display name. Defaults to the first line of instructions.

provider
enum<string>

Source-control provider for the connected repository. Defaults to GitHub first, then GitLab if no GitHub repository matches.

Available options:
github,
gitlab
model
string | null

Model override. null uses the workspace default. New runs accept only the currently available Ara model catalog.

tools
object

Response

Created.

An automation: its instructions, tools, environment binding, and triggers.

id
string
org_id
string
name
string | null
instructions
string | null

The system instructions the automation runs with.

model
string | null
enabled
boolean

A paused (false) automation's triggers never fire.

tools
object
environment
object
triggers
object[]

Every condition that fires this automation. Empty until you add one.

created_at
string<date-time>
updated_at
string<date-time>