Invite a member - Ara Documentation

Invite a member

curl --request POST \
  --url https://api.ara.so/v3/organizations/{orgId}/members/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "engineer@acme.com"
  ],
  "role": "admin"
}
'

import requests

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

payload = {
    "emails": ["engineer@acme.com"],
    "role": "admin"
}
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({emails: ['engineer@acme.com'], role: 'admin'})
};

fetch('https://api.ara.so/v3/organizations/{orgId}/members/users', 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}/members/users",
  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([
    'emails' => [
        'engineer@acme.com'
    ],
    'role' => 'admin'
  ]),
  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}/members/users"

	payload := strings.NewReader("{\n  \"emails\": [\n    \"engineer@acme.com\"\n  ],\n  \"role\": \"admin\"\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}/members/users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"emails\": [\n    \"engineer@acme.com\"\n  ],\n  \"role\": \"admin\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"emails\": [\n    \"engineer@acme.com\"\n  ],\n  \"role\": \"admin\"\n}"

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

{
  "invited": 1
}

{
  "error": "prompt_required"
}

POST

/

v3

/

organizations

/

{orgId}

/

members

/

users

Invite a member

curl --request POST \
  --url https://api.ara.so/v3/organizations/{orgId}/members/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "engineer@acme.com"
  ],
  "role": "admin"
}
'

import requests

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

payload = {
    "emails": ["engineer@acme.com"],
    "role": "admin"
}
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({emails: ['engineer@acme.com'], role: 'admin'})
};

fetch('https://api.ara.so/v3/organizations/{orgId}/members/users', 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}/members/users",
  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([
    'emails' => [
        'engineer@acme.com'
    ],
    'role' => 'admin'
  ]),
  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}/members/users"

	payload := strings.NewReader("{\n  \"emails\": [\n    \"engineer@acme.com\"\n  ],\n  \"role\": \"admin\"\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}/members/users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"emails\": [\n    \"engineer@acme.com\"\n  ],\n  \"role\": \"admin\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"emails\": [\n    \"engineer@acme.com\"\n  ],\n  \"role\": \"admin\"\n}"

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

{
  "invited": 1
}

{
  "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

emails

string<email>[]

required

Email addresses to invite.

role

enum<string>

default:admin

Omitted values invite an admin; unknown values coerce to member.

Available options:

admin,

member

Response

Invitations created.

invited

integer

How many invitations were created.

⌘I