Retrieve an automation

curl --request GET \
  --url https://api.ara.so/v3/organizations/{orgId}/automations/{automationId} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ara.so/v3/organizations/{orgId}/automations/{automationId}', 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/{automationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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": "session_not_found"
}

GET

organizations

{orgId}

automations

{automationId}

Retrieve an automation

curl --request GET \
  --url https://api.ara.so/v3/organizations/{orgId}/automations/{automationId} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ara.so/v3/organizations/{orgId}/automations/{automationId}', 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/{automationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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": "session_not_found"
}

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.

automationId

string

required

Response

The automation.

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

Retrieve an automation

Authorizations

Path Parameters

Response