Create an automation

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

import requests

url = "https://api.ara.so/v3/organizations/{orgId}/automations"

payload = {
    "name": "Nightly dependency audit",
    "instructions": "Audit dependencies for known CVEs and open a PR if any need patching.",
    "repo": "acme/widget",
    "provider": "github"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Nightly dependency audit',
    instructions: 'Audit dependencies for known CVEs and open a PR if any need patching.',
    repo: 'acme/widget',
    provider: 'github'
  })
};

fetch('https://api.ara.so/v3/organizations/{orgId}/automations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ara.so/v3/organizations/{orgId}/automations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Nightly dependency audit',
    'instructions' => 'Audit dependencies for known CVEs and open a PR if any need patching.',
    'repo' => 'acme/widget',
    'provider' => 'github'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ara.so/v3/organizations/{orgId}/automations"

	payload := strings.NewReader("{\n  \"name\": \"Nightly dependency audit\",\n  \"instructions\": \"Audit dependencies for known CVEs and open a PR if any need patching.\",\n  \"repo\": \"acme/widget\",\n  \"provider\": \"github\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.ara.so/v3/organizations/{orgId}/automations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Nightly dependency audit\",\n  \"instructions\": \"Audit dependencies for known CVEs and open a PR if any need patching.\",\n  \"repo\": \"acme/widget\",\n  \"provider\": \"github\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ara.so/v3/organizations/{orgId}/automations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Nightly dependency audit\",\n  \"instructions\": \"Audit dependencies for known CVEs and open a PR if any need patching.\",\n  \"repo\": \"acme/widget\",\n  \"provider\": \"github\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": 123,
        "next_run_at": "2023-11-07T05:31:56Z"
      },
      "github": {
        "event": "<string>",
        "action": "<string>",
        "repo": "<string>"
      },
      "webhook": {
        "configured": true
      },
      "run_kind": "<string>",
      "last_fired_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "prompt_required"
}

POST

organizations

{orgId}

automations

Create an automation

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

import requests

url = "https://api.ara.so/v3/organizations/{orgId}/automations"

payload = {
    "name": "Nightly dependency audit",
    "instructions": "Audit dependencies for known CVEs and open a PR if any need patching.",
    "repo": "acme/widget",
    "provider": "github"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Nightly dependency audit',
    instructions: 'Audit dependencies for known CVEs and open a PR if any need patching.',
    repo: 'acme/widget',
    provider: 'github'
  })
};

fetch('https://api.ara.so/v3/organizations/{orgId}/automations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ara.so/v3/organizations/{orgId}/automations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Nightly dependency audit',
    'instructions' => 'Audit dependencies for known CVEs and open a PR if any need patching.',
    'repo' => 'acme/widget',
    'provider' => 'github'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ara.so/v3/organizations/{orgId}/automations"

	payload := strings.NewReader("{\n  \"name\": \"Nightly dependency audit\",\n  \"instructions\": \"Audit dependencies for known CVEs and open a PR if any need patching.\",\n  \"repo\": \"acme/widget\",\n  \"provider\": \"github\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.ara.so/v3/organizations/{orgId}/automations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Nightly dependency audit\",\n  \"instructions\": \"Audit dependencies for known CVEs and open a PR if any need patching.\",\n  \"repo\": \"acme/widget\",\n  \"provider\": \"github\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ara.so/v3/organizations/{orgId}/automations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Nightly dependency audit\",\n  \"instructions\": \"Audit dependencies for known CVEs and open a PR if any need patching.\",\n  \"repo\": \"acme/widget\",\n  \"provider\": \"github\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": 123,
        "next_run_at": "2023-11-07T05:31:56Z"
      },
      "github": {
        "event": "<string>",
        "action": "<string>",
        "repo": "<string>"
      },
      "webhook": {
        "configured": true
      },
      "run_kind": "<string>",
      "last_fired_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "prompt_required"
}

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

Show child attributes

Response

Created.

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

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

Show child attributes

environment

object

Show child attributes

triggers

object[]

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

Show child attributes

created_at

string<date-time>

updated_at

string<date-time>

⌘I

Quickstart

Endpoints

Create an automation

Authorizations

Path Parameters

Body

Response