Create an automation | Ara Documentation

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"
}'

{
  "id": "string",
  "org_id": "string",
  "name": "string",
  "instructions": "string",
  "model": "string",
  "enabled": true,
  "tools": {
    "mcp_servers": [
      "string"
    ],
    "app_tools": [
      "string"
    ]
  },
  "environment": {
    "repo": "string",
    "provider": "github"
  },
  "triggers": [
    {
      "id": "string",
      "kind": "schedule",
      "enabled": true,
      "schedule": {
        "kind": "cron",
        "expression": "string",
        "every_seconds": 1,
        "next_run_at": "2024-01-15T09:30:00Z"
      },
      "github": {
        "event": "string",
        "action": "string",
        "repo": "string"
      },
      "webhook": {
        "configured": true
      },
      "run_kind": "string",
      "last_fired_at": "2024-01-15T09:30:00Z",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z"
}

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}

인증

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.

경로 매개변수

orgIdstring필수

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

요청

This endpoint expects an object.

instructionsstring필수

The system instructions the automation runs with.

repostring필수

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

namestring선택 사항

Display name. Defaults to the first line of instructions.

providerenum선택 사항

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

modelstring or null선택 사항

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

toolsobject선택 사항

응답

Created.

idstring선택 사항

org_idstring선택 사항

namestring or null선택 사항

instructionsstring or null선택 사항

The system instructions the automation runs with.

modelstring or null선택 사항

enabledboolean선택 사항

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

toolsobject선택 사항

environmentobject선택 사항

triggerslist of objects선택 사항

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

created_atdatetime선택 사항

updated_atdatetime선택 사항

오류

400

Bad Request Error

402

Payment Required Error