Retrieve an automation

GET

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

GET

/v3/organizations/:orgId/automations/:automationId

$ curl https://api.ara.so/v3/organizations/orgId/automations/automationId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3   "org_id": "dev-team-42",
4   "name": "Daily Code Review Automation",
5   "instructions": "Run a code review session every weekday morning to ensure code quality.",
6   "model": "gpt-4",
7   "enabled": true,
8   "tools": {
9     "mcp_servers": [
10       "mcp-server-01"
11     ],
12     "app_tools": [
13       "code-reviewer",
14       "test-runner"
15     ]
16   },
17   "environment": {
18     "repo": "openai/ara-api",
19     "provider": "github"
20   },
21   "triggers": [
22     {
23       "id": "trigger-1234abcd",
24       "kind": "schedule",
25       "enabled": true,
26       "schedule": {
27         "kind": "cron",
28         "expression": "0 9 * * 1-5",
29         "every_seconds": 86400,
30         "next_run_at": "2024-01-15T09:30:00Z"
31       },
32       "github": {
33         "event": null,
34         "action": null,
35         "repo": null
36       },
37       "webhook": {
38         "configured": false
39       },
40       "run_kind": "automated",
41       "last_fired_at": "2024-01-14T09:30:00Z",
42       "created_at": "2023-12-01T08:00:00Z",
43       "updated_at": "2024-01-10T12:00:00Z"
44     }
45   ],
46   "created_at": "2023-12-01T08:00:00Z",
47   "updated_at": "2024-01-10T12:00:00Z"
48 }

_{Scope: automations:read}

Authentication

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.

Path parameters

orgIdstringRequired

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

automationIdstringRequired

Response

The automation.

idstringOptional

org_idstringOptional

namestring or nullOptional

instructionsstring or nullOptional

The system instructions the automation runs with.

modelstring or nullOptional

enabledbooleanOptional

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

toolsobjectOptional

environmentobjectOptional

triggerslist of objectsOptional

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

created_atdatetimeOptional

updated_atdatetimeOptional

Errors

404

Not Found Error