Create a local agent from a Library agent definition. Requires --execute when it raises the permission profile or grants skills.
curl --request POST \
--url http://localhost:3000/api/v1/agents/install \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ref": "<string>",
"cwd": "<string>",
"execute": true,
"id": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/agents/install"
payload = {
"ref": "<string>",
"cwd": "<string>",
"execute": True,
"id": "<string>"
}
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({ref: '<string>', cwd: '<string>', execute: true, id: '<string>'})
};
fetch('http://localhost:3000/api/v1/agents/install', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/agents/install",
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([
'ref' => '<string>',
'cwd' => '<string>',
'execute' => true,
'id' => '<string>'
]),
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 := "http://localhost:3000/api/v1/agents/install"
payload := strings.NewReader("{\n \"ref\": \"<string>\",\n \"cwd\": \"<string>\",\n \"execute\": true,\n \"id\": \"<string>\"\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("http://localhost:3000/api/v1/agents/install")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ref\": \"<string>\",\n \"cwd\": \"<string>\",\n \"execute\": true,\n \"id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/agents/install")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ref\": \"<string>\",\n \"cwd\": \"<string>\",\n \"execute\": true,\n \"id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"cwd": "<string>",
"id": "<string>",
"model": "<string>",
"provider": "<string>"
},
"granted": [
"<string>"
],
"next": [
"<string>"
],
"profile": "<string>",
"ref": "<string>",
"skipped": [
{
"reason": "<string>",
"ref": "<string>"
}
],
"success": true,
"version": 123
}agents
Create a local agent from a Library agent definition. Requires --execute when it raises the permission profile or grants skills.
POST
/
api
/
v1
/
agents
/
install
Create a local agent from a Library agent definition. Requires --execute when it raises the permission profile or grants skills.
curl --request POST \
--url http://localhost:3000/api/v1/agents/install \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ref": "<string>",
"cwd": "<string>",
"execute": true,
"id": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/agents/install"
payload = {
"ref": "<string>",
"cwd": "<string>",
"execute": True,
"id": "<string>"
}
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({ref: '<string>', cwd: '<string>', execute: true, id: '<string>'})
};
fetch('http://localhost:3000/api/v1/agents/install', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/agents/install",
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([
'ref' => '<string>',
'cwd' => '<string>',
'execute' => true,
'id' => '<string>'
]),
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 := "http://localhost:3000/api/v1/agents/install"
payload := strings.NewReader("{\n \"ref\": \"<string>\",\n \"cwd\": \"<string>\",\n \"execute\": true,\n \"id\": \"<string>\"\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("http://localhost:3000/api/v1/agents/install")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ref\": \"<string>\",\n \"cwd\": \"<string>\",\n \"execute\": true,\n \"id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/agents/install")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ref\": \"<string>\",\n \"cwd\": \"<string>\",\n \"execute\": true,\n \"id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"cwd": "<string>",
"id": "<string>",
"model": "<string>",
"provider": "<string>"
},
"granted": [
"<string>"
],
"next": [
"<string>"
],
"profile": "<string>",
"ref": "<string>",
"skipped": [
{
"reason": "<string>",
"ref": "<string>"
}
],
"success": true,
"version": 123
}Authorizations
Runtime context-key (rctx_*) issued by the Ravi gateway. Required for every non-open scope. Bootstrap the first key with ravi daemon init-admin-key; rotate, derive, and revoke via the ravi context family. Specs: runtime/context-keys, sdk/auth.
Body
application/json