Skip to main content
GET
/
agents
/
types
/
{agent_type_id}
Get Agent Type
curl --request GET \
  --url https://api.example.com/agents/types/{agent_type_id}
import requests

url = "https://api.example.com/agents/types/{agent_type_id}"

response = requests.get(url)

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

fetch('https://api.example.com/agents/types/{agent_type_id}', 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/agents/types/{agent_type_id}",
  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/agents/types/{agent_type_id}"

	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/agents/types/{agent_type_id}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/types/{agent_type_id}")

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
{
  "name": "<string>",
  "display_name": "<string>",
  "provider": "<string>",
  "model": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "temperature": 123,
  "context_window": 123,
  "system_instructions": "<string>",
  "mcp_servers": [
    "<string>"
  ],
  "builtin_tools": [
    "<string>"
  ],
  "default_plan_template": [
    "<string>"
  ],
  "agent_resource_id": "<string>",
  "runner_resource_id": "<string>",
  "created_by": "<string>",
  "version": 1,
  "conversation_routing": {
    "when": "<string>",
    "examples": [
      "<string>"
    ],
    "avoid": "<string>"
  },
  "role": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

​
agent_type_id
string
required

Response

Successful Response

Domain model for agent types with LLM configuration and tooling.

Agent types live inside the tenant SurrealDB namespace — the namespace is the organization boundary, so the record itself carries no organization_id field.

Identity fields (frozen - immutable after creation): name: Machine-readable name unique within the namespace.

Configuration fields (mutable): display_name: Human-readable name shown in UI. description: Agent purpose and capabilities. icon: Icon identifier or URL. provider: LLM provider (e.g., "anthropic", "openai"). model: Model identifier (e.g., "claude-opus-4", "gpt-4"). temperature: Sampling temperature for generation. context_window: Maximum context window size in tokens. system_instructions: System prompt for the agent. mcp_servers: MCP server identifiers available to the agent. builtin_tools: Built-in tool identifiers available to the agent. default_plan_template: Default plan steps for new tasks. conversation_routing: Routing rules for conversation assignment.

Resource fields (linking to pragma resources): agent_resource_id: SurrealDB resource ID for the agent type. runner_resource_id: SurrealDB resource ID for the runner resource.

Platform fields (system-managed): role: Optional platform role marker. "main_router" identifies the single entry-point agent for POST /agents/chat. None for user-created types.

Audit fields: created_by: User ID of the creator. version: Schema version for migration support.

Inherited from PragmaModel: created_at: Creation timestamp (frozen). updated_at: Last update timestamp (mutable).

​
name
string
required
​
display_name
string
required
​
provider
string
required
​
model
string
required
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
id
string | null
​
description
string | null
​
icon
string | null
​
temperature
number | null
​
context_window
integer | null
​
system_instructions
string | null
​
mcp_servers
string[]
​
builtin_tools
string[]
​
default_plan_template
string[] | null
​
agent_resource_id
string | null
​
runner_resource_id
string | null
​
created_by
string | null
​
version
integer
default:1
​
conversation_routing
ConversationRoutingManifest · object | null

Routing rules for conversation-to-agent assignment.

Attributes: when: Natural language description of when this agent should handle a conversation. examples: Example messages that should route to this agent. avoid: Natural language description of messages this agent should not handle.

​
role
string | null