Set or inspect an agent's generic model-broker profile
curl --request POST \
--url http://localhost:3000/api/v1/agents/model-broker \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"broker": "<string>",
"clear": true,
"execute": true,
"profile": "<string>",
"required": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/agents/model-broker"
payload = {
"id": "<string>",
"broker": "<string>",
"clear": True,
"execute": True,
"profile": "<string>",
"required": "<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({
id: '<string>',
broker: '<string>',
clear: true,
execute: true,
profile: '<string>',
required: '<string>'
})
};
fetch('http://localhost:3000/api/v1/agents/model-broker', 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/model-broker",
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([
'id' => '<string>',
'broker' => '<string>',
'clear' => true,
'execute' => true,
'profile' => '<string>',
'required' => '<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/model-broker"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"broker\": \"<string>\",\n \"clear\": true,\n \"execute\": true,\n \"profile\": \"<string>\",\n \"required\": \"<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/model-broker")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"broker\": \"<string>\",\n \"clear\": true,\n \"execute\": true,\n \"profile\": \"<string>\",\n \"required\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/agents/model-broker")
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 \"id\": \"<string>\",\n \"broker\": \"<string>\",\n \"clear\": true,\n \"execute\": true,\n \"profile\": \"<string>\",\n \"required\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"action": "model-broker",
"agentId": "<string>",
"changed": true,
"modelBroker": {
"brokerId": "<string>",
"profileRef": "<string>",
"required": true
},
"agent": {
"cwd": "<string>",
"effectiveModel": "<string>",
"effectiveProvider": "<string>",
"id": "<string>",
"isDefault": true,
"modelError": "<string>",
"modelPresetId": "<string>",
"modelPresetVersion": 123,
"modelSource": "agent_preset",
"providerSource": "<string>",
"tags": [
{
"assetId": "<string>",
"assetType": "agent",
"createdAt": 123,
"id": "<string>",
"source": "<string>",
"tagId": "<string>",
"tagSlug": "<string>",
"updatedAt": 123,
"createdBy": "<string>",
"metadata": {},
"updatedBy": "<string>"
}
],
"allowedSessions": [
"<string>"
],
"contactScope": "<string>",
"debounceMs": 123,
"defaults": {},
"dmScope": "main",
"effort": "none",
"groupDebounceMs": 123,
"heartbeat": {
"enabled": true,
"intervalMs": 123,
"accountId": "<string>",
"activeEnd": "<string>",
"activeStart": "<string>",
"lastRunAt": 123,
"model": "<string>"
},
"matrixAccount": "<string>",
"memoryModel": "<string>",
"mode": "active",
"model": "<string>",
"name": "<string>",
"provider": "<string>",
"remote": "<string>",
"remoteUser": "<string>",
"settingSources": [
"user"
],
"specMode": true,
"systemPromptAppend": "<string>"
},
"defaults": {}
}agents
Set or inspect an agent's generic model-broker profile
POST
/
api
/
v1
/
agents
/
model-broker
Set or inspect an agent's generic model-broker profile
curl --request POST \
--url http://localhost:3000/api/v1/agents/model-broker \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"broker": "<string>",
"clear": true,
"execute": true,
"profile": "<string>",
"required": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/agents/model-broker"
payload = {
"id": "<string>",
"broker": "<string>",
"clear": True,
"execute": True,
"profile": "<string>",
"required": "<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({
id: '<string>',
broker: '<string>',
clear: true,
execute: true,
profile: '<string>',
required: '<string>'
})
};
fetch('http://localhost:3000/api/v1/agents/model-broker', 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/model-broker",
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([
'id' => '<string>',
'broker' => '<string>',
'clear' => true,
'execute' => true,
'profile' => '<string>',
'required' => '<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/model-broker"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"broker\": \"<string>\",\n \"clear\": true,\n \"execute\": true,\n \"profile\": \"<string>\",\n \"required\": \"<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/model-broker")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"broker\": \"<string>\",\n \"clear\": true,\n \"execute\": true,\n \"profile\": \"<string>\",\n \"required\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/agents/model-broker")
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 \"id\": \"<string>\",\n \"broker\": \"<string>\",\n \"clear\": true,\n \"execute\": true,\n \"profile\": \"<string>\",\n \"required\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"action": "model-broker",
"agentId": "<string>",
"changed": true,
"modelBroker": {
"brokerId": "<string>",
"profileRef": "<string>",
"required": true
},
"agent": {
"cwd": "<string>",
"effectiveModel": "<string>",
"effectiveProvider": "<string>",
"id": "<string>",
"isDefault": true,
"modelError": "<string>",
"modelPresetId": "<string>",
"modelPresetVersion": 123,
"modelSource": "agent_preset",
"providerSource": "<string>",
"tags": [
{
"assetId": "<string>",
"assetType": "agent",
"createdAt": 123,
"id": "<string>",
"source": "<string>",
"tagId": "<string>",
"tagSlug": "<string>",
"updatedAt": 123,
"createdBy": "<string>",
"metadata": {},
"updatedBy": "<string>"
}
],
"allowedSessions": [
"<string>"
],
"contactScope": "<string>",
"debounceMs": 123,
"defaults": {},
"dmScope": "main",
"effort": "none",
"groupDebounceMs": 123,
"heartbeat": {
"enabled": true,
"intervalMs": 123,
"accountId": "<string>",
"activeEnd": "<string>",
"activeStart": "<string>",
"lastRunAt": 123,
"model": "<string>"
},
"matrixAccount": "<string>",
"memoryModel": "<string>",
"mode": "active",
"model": "<string>",
"name": "<string>",
"provider": "<string>",
"remote": "<string>",
"remoteUser": "<string>",
"settingSources": [
"user"
],
"specMode": true,
"systemPromptAppend": "<string>"
},
"defaults": {}
}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
Agent ID
Registered model-broker ID
Remove this agent's model-broker selection
Apply a required broker selection after capability preflight
Opaque public profile reference owned by the broker
Require broker routing (true or false)