Create an automation

POST

https://api.ara.so/v3/organizations/:orgId/automations

POST

/v3/organizations/:orgId/automations

$ curl -X POST https://api.ara.so/v3/organizations/orgId/automations \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "instructions": "Audit dependencies for known CVEs and open a PR if any need patching.",
>   "repo": "acme/widget",
>   "name": "Nightly dependency audit",
>   "provider": "github"
> }'

1 {
2   "id": "string",
3   "org_id": "string",
4   "name": "string",
5   "instructions": "string",
6   "model": "string",
7   "enabled": true,
8   "tools": {
9     "mcp_servers": [
10       "string"
11     ],
12     "app_tools": [
13       "string"
14     ]
15   },
16   "environment": {
17     "repo": "string",
18     "provider": "github"
19   },
20   "triggers": [
21     {
22       "id": "string",
23       "kind": "schedule",
24       "enabled": true,
25       "schedule": {
26         "kind": "cron",
27         "expression": "string",
28         "every_seconds": 1,
29         "next_run_at": "2024-01-15T09:30:00Z"
30       },
31       "github": {
32         "event": "string",
33         "action": "string",
34         "repo": "string"
35       },
36       "webhook": {
37         "configured": true
38       },
39       "run_kind": "string",
40       "last_fired_at": "2024-01-15T09:30:00Z",
41       "created_at": "2024-01-15T09:30:00Z",
42       "updated_at": "2024-01-15T09:30:00Z"
43     }
44   ],
45   "created_at": "2024-01-15T09:30:00Z",
46   "updated_at": "2024-01-15T09:30:00Z"
47 }

Creates the automation’s configuration (instructions + environment binding). Add a trigger with POST /automations/{automationId}/triggers to make it fire. The repo must already be connected.

_{Scope: automations:write}

Authentification

AuthorizationBearer

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.

Paramètres de chemin

orgIdstringRequis

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

Requête

This endpoint expects an object.

instructionsstringRequis

The system instructions the automation runs with.

repostringRequis

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

namestringOptionnel

Display name. Defaults to the first line of instructions.

providerenumOptionnel

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

modelstring or nullOptionnel

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

toolsobjectOptionnel

Réponse

Created.

idstringOptionnel

org_idstringOptionnel

namestring or nullOptionnel

instructionsstring or nullOptionnel

The system instructions the automation runs with.

modelstring or nullOptionnel

enabledbooleanOptionnel

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

toolsobjectOptionnel

environmentobjectOptionnel

triggerslist of objectsOptionnel

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

created_atdatetimeOptionnel

updated_atdatetimeOptionnel

Erreurs

400

Bad Request Error

402

Payment Required Error