Get Agent Settings Schema
curl --request GET \
--url https://api.example.com/api/settings/agent-schema \
--header 'X-Session-API-Key: <api-key>'import requests
url = "https://api.example.com/api/settings/agent-schema"
headers = {"X-Session-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Session-API-Key': '<api-key>'}};
fetch('https://api.example.com/api/settings/agent-schema', 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.example.com/api/settings/agent-schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Session-API-Key: <api-key>"
],
]);
$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.example.com/api/settings/agent-schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Session-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/settings/agent-schema")
.header("X-Session-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/settings/agent-schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Session-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"model_name": "<string>",
"sections": [
{
"fields": [
{
"key": "<string>",
"label": "<string>",
"section": "<string>",
"section_label": "<string>",
"value_type": "string",
"choices": [
{
"label": "<string>",
"value": true
}
],
"default": "<unknown>",
"depends_on": [
"<string>"
],
"description": "<string>",
"prominence": "minor",
"secret": false,
"variant": "<string>"
}
],
"key": "<string>",
"label": "<string>",
"variant": "<string>"
}
]
}Settings
Get Agent Settings Schema
Return the schema used to render AgentSettings-based settings forms.
GET
/
api
/
settings
/
agent-schema
Get Agent Settings Schema
curl --request GET \
--url https://api.example.com/api/settings/agent-schema \
--header 'X-Session-API-Key: <api-key>'import requests
url = "https://api.example.com/api/settings/agent-schema"
headers = {"X-Session-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Session-API-Key': '<api-key>'}};
fetch('https://api.example.com/api/settings/agent-schema', 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.example.com/api/settings/agent-schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Session-API-Key: <api-key>"
],
]);
$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.example.com/api/settings/agent-schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Session-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/settings/agent-schema")
.header("X-Session-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/settings/agent-schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Session-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"model_name": "<string>",
"sections": [
{
"fields": [
{
"key": "<string>",
"label": "<string>",
"section": "<string>",
"section_label": "<string>",
"value_type": "string",
"choices": [
{
"label": "<string>",
"value": true
}
],
"default": "<unknown>",
"depends_on": [
"<string>"
],
"description": "<string>",
"prominence": "minor",
"secret": false,
"variant": "<string>"
}
],
"key": "<string>",
"label": "<string>",
"variant": "<string>"
}
]
}Was this page helpful?