Sign in

v1

latestOpenAPI 3.1.02026-07-26252382475.4 KB
Agents

Get A Registered Agent By Id.

Retrieves details of a specific agent by its id.

get/v1/orchestrate/agents/{id}

Path parameters

idstring required

Response

Successful Response

idstring uuid required

Unique identifier for the agent

tenant_idstring required

ID of the tenant that owns this agent

workspace_idstring uuid nullable

ID of the workspace that owns this agent

namestring required

Name of the agent

descriptionstring required

Description of what the agent does

instructionsstring nullable

Instructions for the agent

toolsstring[]

List of tool names available to the agent

collaboratorsstring[]

List of other agent names this agent can collaborate with

knowledge_basestring[]
llmstring nullable

LLM identifier for the agent

style'default' | 'react' | 'planner' | 'custom' | 'react_intrinsic' | 'experimental_customer_care' | 'code_act' required
supported_appsSupportedApp[] nullable

Supported apps of the agent

created_bystring required

ID of the user who created the agent

created_onstring date-time required

Creation timestamp

updated_bystring required

ID of the user who updated the agent

updated_atstring date-time required

Last update timestamp

deleted_bystring nullable
deleted_atstring date-time nullable
agent_mappingobject nullable
hiddenboolean

To show or hide agent when agents are listed

display_namestring nullable

Display name of the agent

structured_outputobject nullable

JSON schema defining the structure for agent responses

custom_join_toolstring nullable

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

tagsstring[] nullable

List of tags associated to agent

voice_configuration_idstring uuid nullable

Voice configuration for the agent

voice_webhook_connectionsobject nullable

Voice webhook connections organized by environment (draft/live)

context_access_enabledboolean

Enable access to context variables for this agent

connection_idsstring[]

List of connection IDs for direct agent-to-connection bindings

context_variablesstring[]

List of context variable names that this agent can access

hide_reasoningboolean

Enable/disable reasoning trace

sync_tool_flow_interactionsboolean

Enable/disable syncing user interactions from tool flow to the agent

restrictionsstring

Enable editable for the colloborator agent

bundledboolean nullable

Catalog Agent bundled flag

bundled_agent_idstring uuid nullable

Base agent id

toolkitsstring[]

List of toolkit ids available to the agent

memory_enabledboolean

Enable/disable agentic memory for this agent

is_schedulableboolean

Indicates whether this agent can be scheduled for tasks

deleted_semantic_versionsstring[]

Track deleted semantic versions to prevent reuse (V2 API)