Skip to main content
GET
/
agent
/
schema
Get JSON Schema fragments for the agent form
curl --request GET \
  --url https://api.example.com/agent/schema
import requests

url = "https://api.example.com/agent/schema"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/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/agent/schema",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/agent/schema"

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

	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/agent/schema")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/agent/schema")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "identity": {},
  "context_config": {},
  "react_config": {}
}

Response

Successful Response

JSON Schema fragments used by the frontend to render the agent create / edit forms.

Each fragment is a self-contained JSON Schema object so the frontend doesn't need to follow $ref links across fragments. The frontend pairs each property with an i18n key derived from its path, so labels and descriptions remain localizable independently of the backend.

identity
Identity · object
required

Schema for the agent's identity fields (name, system_prompt).

context_config
Context Config · object
required

Schema for ContextConfig.

react_config
React Config · object
required

Schema for ReActConfig.