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