List Registered Agents

curl --request GET \
  --url https://{api_endpoint}/v1/orchestrate/agents \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_endpoint}/v1/orchestrate/agents"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_endpoint}/v1/orchestrate/agents', 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_endpoint}/v1/orchestrate/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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_endpoint}/v1/orchestrate/agents"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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_endpoint}/v1/orchestrate/agents")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_endpoint}/v1/orchestrate/agents")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "created_by": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "workspace_id": "00000000-0000-0000-0000-000000000001",
    "instructions": "<string>",
    "tools": [
      "<string>"
    ],
    "collaborators": [
      "<string>"
    ],
    "knowledge_base": [],
    "llm": "<string>",
    "supported_apps": [
      "slack/askhr"
    ],
    "deleted_by": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "environments": [],
    "agent_mapping": {},
    "hidden": true,
    "display_name": "<string>",
    "structured_output": {},
    "custom_join_tool": "<string>",
    "guidelines": [],
    "tags": [],
    "chat_with_docs": {
      "enabled": false,
      "supports_full_document": true,
      "vector_index": {
        "embeddings_model_name": "<string>",
        "chunk_size": 400,
        "chunk_overlap": 50,
        "limit": 10,
        "extraction_strategy": "standard"
      },
      "generation": {
        "model_id": "<string>",
        "prompt_instruction": "",
        "max_docs_passed_to_llm": 5,
        "generated_response_length": "Moderate",
        "display_text_no_results_found": "I searched my knowledge base, but did not find anything related to your query",
        "display_text_connectivity_issue": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment",
        "idk_message": "I'm afraid I don't understand. Please rephrase your question.",
        "enabled": false
      },
      "query_rewrite": {
        "enabled": true,
        "model_id": "<string>"
      },
      "confidence_thresholds": {
        "retrieval_confidence_threshold": "Lowest",
        "response_confidence_threshold": "Lowest"
      },
      "citations": {
        "citation_title": "How do we know?",
        "citations_shown": -1
      },
      "hap_filtering": {
        "output": {
          "enabled": false,
          "threshold": 0.5
        }
      },
      "query_source": "Agent",
      "agent_query_description": "The query to search for in the knowledge base"
    },
    "voice_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "voice_webhook_connections": {},
    "additional_properties": {
      "icon": "<string>",
      "starter_prompts": {},
      "welcome_content": {},
      "context_settings": {
        "context_compaction_enabled": true,
        "context_compaction_threshold": 123,
        "compaction_sliding_window": 123,
        "large_message_threshold": 123,
        "large_message_chunk_size": 123,
        "large_message_target_summary": 123,
        "large_message_detect_structured": true
      },
      "realtime_agent_settings": {
        "enabled": true
      }
    },
    "context_access_enabled": true,
    "connection_ids": [],
    "context_variables": [],
    "hide_reasoning": false,
    "sync_tool_flow_interactions": true,
    "restrictions": "editable",
    "bundled": false,
    "bundled_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "llm_config": {
      "decoding_method": "<string>",
      "prompt": "<string>",
      "max_tokens": 123,
      "max_completion_tokens": 123,
      "temperature": 123,
      "top_p": 123,
      "n": 123,
      "stream": true,
      "logprobs": 123,
      "top_logprobs": true,
      "echo": true,
      "stop": "<string>",
      "presence_penalty": 123,
      "frequency_penalty": 123,
      "best_of": 123,
      "logit_bias": {},
      "user": "<string>",
      "context": "<string>",
      "examples": [
        {
          "input": "<unknown>",
          "output": "<unknown>"
        }
      ],
      "top_k": 123,
      "response_format": {
        "type": "<string>",
        "json_schema": null
      },
      "seed": 123,
      "store": true,
      "metadata": {},
      "modalities": [
        "<string>"
      ],
      "audio": {
        "voice": "<string>",
        "format": "<string>"
      },
      "service_tier": "<string>",
      "prediction": {
        "type": "<string>",
        "content": [
          {
            "type": "<string>",
            "text": "<string>"
          }
        ]
      },
      "safety_settings": null,
      "anthropic_beta": "<string>",
      "anthropic_version": "<string>",
      "thinking": {
        "budget_tokens": 123,
        "type": "<string>"
      },
      "space_id": "<string>",
      "project_id": "<string>",
      "reasoning_effort": "<string>",
      "parallel_tool_calls": true,
      "disable_parallel_tool_use": true,
      "disable_tool_validation": true,
      "verbosity": "<string>",
      "thinking_level": "<string>"
    },
    "plugins": {
      "agent_pre_invoke": [
        {
          "plugin_id": "<string>"
        }
      ],
      "agent_post_invoke": [
        {
          "plugin_id": "<string>"
        }
      ]
    },
    "toolkits": [
      "<string>"
    ],
    "memory_enabled": false,
    "is_schedulable": false,
    "custom_agents_metadata": {
      "language": "<string>",
      "framework": "<string>",
      "tool_count": 123,
      "tool_names": [
        "<string>"
      ],
      "connection_requirements": {}
    },
    "deleted_semantic_versions": []
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

List Registered Agents

curl --request GET \
  --url https://{api_endpoint}/v1/orchestrate/agents \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_endpoint}/v1/orchestrate/agents"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_endpoint}/v1/orchestrate/agents', 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_endpoint}/v1/orchestrate/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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_endpoint}/v1/orchestrate/agents"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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_endpoint}/v1/orchestrate/agents")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_endpoint}/v1/orchestrate/agents")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "created_by": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "workspace_id": "00000000-0000-0000-0000-000000000001",
    "instructions": "<string>",
    "tools": [
      "<string>"
    ],
    "collaborators": [
      "<string>"
    ],
    "knowledge_base": [],
    "llm": "<string>",
    "supported_apps": [
      "slack/askhr"
    ],
    "deleted_by": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "environments": [],
    "agent_mapping": {},
    "hidden": true,
    "display_name": "<string>",
    "structured_output": {},
    "custom_join_tool": "<string>",
    "guidelines": [],
    "tags": [],
    "chat_with_docs": {
      "enabled": false,
      "supports_full_document": true,
      "vector_index": {
        "embeddings_model_name": "<string>",
        "chunk_size": 400,
        "chunk_overlap": 50,
        "limit": 10,
        "extraction_strategy": "standard"
      },
      "generation": {
        "model_id": "<string>",
        "prompt_instruction": "",
        "max_docs_passed_to_llm": 5,
        "generated_response_length": "Moderate",
        "display_text_no_results_found": "I searched my knowledge base, but did not find anything related to your query",
        "display_text_connectivity_issue": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment",
        "idk_message": "I'm afraid I don't understand. Please rephrase your question.",
        "enabled": false
      },
      "query_rewrite": {
        "enabled": true,
        "model_id": "<string>"
      },
      "confidence_thresholds": {
        "retrieval_confidence_threshold": "Lowest",
        "response_confidence_threshold": "Lowest"
      },
      "citations": {
        "citation_title": "How do we know?",
        "citations_shown": -1
      },
      "hap_filtering": {
        "output": {
          "enabled": false,
          "threshold": 0.5
        }
      },
      "query_source": "Agent",
      "agent_query_description": "The query to search for in the knowledge base"
    },
    "voice_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "voice_webhook_connections": {},
    "additional_properties": {
      "icon": "<string>",
      "starter_prompts": {},
      "welcome_content": {},
      "context_settings": {
        "context_compaction_enabled": true,
        "context_compaction_threshold": 123,
        "compaction_sliding_window": 123,
        "large_message_threshold": 123,
        "large_message_chunk_size": 123,
        "large_message_target_summary": 123,
        "large_message_detect_structured": true
      },
      "realtime_agent_settings": {
        "enabled": true
      }
    },
    "context_access_enabled": true,
    "connection_ids": [],
    "context_variables": [],
    "hide_reasoning": false,
    "sync_tool_flow_interactions": true,
    "restrictions": "editable",
    "bundled": false,
    "bundled_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "llm_config": {
      "decoding_method": "<string>",
      "prompt": "<string>",
      "max_tokens": 123,
      "max_completion_tokens": 123,
      "temperature": 123,
      "top_p": 123,
      "n": 123,
      "stream": true,
      "logprobs": 123,
      "top_logprobs": true,
      "echo": true,
      "stop": "<string>",
      "presence_penalty": 123,
      "frequency_penalty": 123,
      "best_of": 123,
      "logit_bias": {},
      "user": "<string>",
      "context": "<string>",
      "examples": [
        {
          "input": "<unknown>",
          "output": "<unknown>"
        }
      ],
      "top_k": 123,
      "response_format": {
        "type": "<string>",
        "json_schema": null
      },
      "seed": 123,
      "store": true,
      "metadata": {},
      "modalities": [
        "<string>"
      ],
      "audio": {
        "voice": "<string>",
        "format": "<string>"
      },
      "service_tier": "<string>",
      "prediction": {
        "type": "<string>",
        "content": [
          {
            "type": "<string>",
            "text": "<string>"
          }
        ]
      },
      "safety_settings": null,
      "anthropic_beta": "<string>",
      "anthropic_version": "<string>",
      "thinking": {
        "budget_tokens": 123,
        "type": "<string>"
      },
      "space_id": "<string>",
      "project_id": "<string>",
      "reasoning_effort": "<string>",
      "parallel_tool_calls": true,
      "disable_parallel_tool_use": true,
      "disable_tool_validation": true,
      "verbosity": "<string>",
      "thinking_level": "<string>"
    },
    "plugins": {
      "agent_pre_invoke": [
        {
          "plugin_id": "<string>"
        }
      ],
      "agent_post_invoke": [
        {
          "plugin_id": "<string>"
        }
      ]
    },
    "toolkits": [
      "<string>"
    ],
    "memory_enabled": false,
    "is_schedulable": false,
    "custom_agents_metadata": {
      "language": "<string>",
      "framework": "<string>",
      "tool_count": 123,
      "tool_names": [
        "<string>"
      ],
      "connection_requirements": {}
    },
    "deleted_semantic_versions": []
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

show_bundled

boolean

default:false

include_hidden

boolean

default:false

ids

string<uuid>[] | null

names

string[] | null

workspace_id

string<uuid> | null

default:00000000-0000-0000-0000-000000000001

Filter agents by workspace ID. If not provided, returns agents from global workspace (workspace_id is null)

include

string[] | null

Include additional workspace scopes. Use 'global' to include global workspace agents along with workspace-specific agents

Response

Successful Response

ListAgent · object[]
ListAgentVersion · object[]

Schema for fetching agent.

string<uuid>

required

Unique identifier for the agent

tenant_id

string

required

ID of the tenant that owns this agent

name

string

required

Name of the agent

description

string

required

Description of what the agent does

style

enum<string>

required

Style of the agent

Available options:

default,

react,

planner,

custom,

react_intrinsic,

experimental_customer_care,

code_act

created_by

string

required

ID of the user who created the agent

created_on

string<date-time>

required

Creation timestamp

updated_by

string

required

ID of the user who updated the agent

updated_at

string<date-time>

required

Last update timestamp

workspace_id

string<uuid> | null

default:00000000-0000-0000-0000-000000000001

ID of the workspace that owns this agent

instructions

string | null

Instructions for the agent

tools

string[]

List of tool names available to the agent

collaborators

string[]

List of other agent names this agent can collaborate with

knowledge_base

string[]

llm

string | null

LLM identifier for the agent

supported_apps

enum<string>[] | null

Supported apps of the agent

Available options:

slack/askhr

deleted_by

string | null

deleted_at

string<date-time> | null

environments

EnvironmentSchema · object[]

List of simplified environments associated with the agent

Show child attributes

agent_mapping

Agent Mapping · object | null

hidden

boolean

To show or hide agent when agents are listed

display_name

string | null

Display name of the agent

structured_output

Structured Output · object | null

JSON schema defining the structure for agent responses

custom_join_tool

string | null

Reference to a Python tool that will be used for custom synthesis of task results

guidelines

Guideline · object[]

List of guidelines for the agent behavior

Show child attributes