Update an automation | Ara Documentation

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cdef34567890",
  "org_id": "acme-corp",
  "name": "Daily Code Review Automation",
  "instructions": "Run daily code review sessions to ensure code quality and compliance with standards.",
  "model": "gpt-4",
  "enabled": true,
  "tools": {
    "mcp_servers": [
      "primary-mcp"
    ],
    "app_tools": [
      "linear",
      "sentry"
    ]
  },
  "environment": {
    "repo": "acme-corp/backend-service",
    "provider": "github"
  },
  "triggers": [
    {
      "id": "trigger-1234abcd",
      "kind": "schedule",
      "enabled": true,
      "schedule": {
        "kind": "cron",
        "expression": "0 9 * * *",
        "every_seconds": 86400,
        "next_run_at": "2024-01-15T09:30:00Z"
      },
      "github": {
        "event": "push",
        "action": "opened",
        "repo": "acme-corp/backend-service"
      },
      "webhook": {
        "configured": true
      },
      "run_kind": "automated",
      "last_fired_at": "2024-01-14T09:30:00Z",
      "created_at": "2023-12-01T08:00:00Z",
      "updated_at": "2024-01-10T12:00:00Z"
    }
  ],
  "created_at": "2023-12-01T08:00:00Z",
  "updated_at": "2024-01-14T09:30:00Z"
}

Partial update of the automation’s configuration. Send only the fields you want to change. Triggers are managed through the triggers sub-resource.

_{Scope: automations:write}

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

Request

This endpoint expects an object.

namestringOptional

instructionsstringOptional

modelstring or nullOptional

toolsobjectOptional

enabledbooleanOptional

Set false to pause the automation. A paused automation’s triggers never fire.

Response

Updated.

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

402

Payment Required Error

404

Not Found Error

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