Skip to main content
GET
/
agents
/
types
/
List Agent Types
curl --request GET \
  --url https://api.example.com/agents/types/
import requests

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

response = requests.get(url)

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

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

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

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

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>"
  }
]

Response

200 - application/json

Successful Response

​
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