Skip to main content
List Registered Agents.
curl --request GET \
  --url https://{api_endpoint}/api/v1/orchestrate/agents \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "instructions": "<string>",
    "tools": [
      "<string>"
    ],
    "collaborators": [
      "<string>"
    ],
    "knowledge_base": [],
    "llm": "<string>",
    "style": "default",
    "supported_apps": [
      "slack/askhr"
    ],
    "created_by": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "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": [
      "<string>"
    ],
    "chat_with_docs": {
      "enabled": true,
      "supports_full_document": true,
      "vector_index": {
        "embeddings_model_name": "<string>",
        "chunk_size": 123,
        "chunk_overlap": 123,
        "limit": 123,
        "extraction_strategy": "express"
      },
      "generation": {
        "model_id": "<string>",
        "prompt_instruction": "<string>",
        "max_docs_passed_to_llm": 123,
        "generated_response_length": "Concise",
        "display_text_no_results_found": "<string>",
        "display_text_connectivity_issue": "<string>",
        "idk_message": "<string>",
        "enabled": true
      },
      "query_rewrite": {
        "enabled": true,
        "model_id": "<string>"
      },
      "confidence_thresholds": {
        "retrieval_confidence_threshold": "Off",
        "response_confidence_threshold": "Off"
      },
      "citations": {
        "citation_title": "<string>",
        "citations_shown": 123
      },
      "hap_filtering": {
        "output": {
          "enabled": true,
          "threshold": 123
        }
      },
      "query_source": "SessionHistory",
      "agent_query_description": "<string>"
    },
    "voice_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "additional_properties": {
      "starter_prompts": {
        "customize": [
          {
            "id": "<any>",
            "title": "<any>",
            "subtitle": "<any>",
            "prompt": "<any>",
            "state": "<any>"
          }
        ]
      },
      "welcome_content": {
        "welcome_message": "<string>",
        "description": "<string>"
      }
    },
    "context_access_enabled": true,
    "context_variables": [],
    "hide_reasoning": false,
    "restrictions": "editable",
    "bundled_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

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

Response

Successful Response

  • ListAgent · object[]
  • ListAgentVersion · object[]
​
id
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,
react_intrinsic
​
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

​
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

​
deleted_by
string | null
​
deleted_at
string<date-time> | null
​
environments
EnvironmentSchema · object[]

List of simplified environments associated with the agent

​
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
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

​
tags
string[] | null

List of tags associated to agent

​
chat_with_docs
object

Chat with Documents config for Agent

​
voice_configuration_id
string<uuid> | null

Voice configuration for the agent

​
additional_properties
object | null

Agent Additional Settings A specification for settings within an agent

​
context_access_enabled
boolean
default:true

Enable access to context variables for this agent

​
context_variables
string[]

List of context variable names that this agent can access

​
hide_reasoning
boolean
default:false

Enable/disable reasoning trace

​
restrictions
string
default:editable

Enable editable for the colloborator agent

​
bundled_agent_id
string<uuid> | null

Base agent id