Sign in

v1

latestOpenAPI 3.1.02026-07-26252382475.4 KB
Agent Releases

List Versioned Agents By Environment Name

Lists all registered agents.

get/v1/orchestrate/agents/environment/{environment_name}/releases

Path parameters

environment_namestring required

Query parameters

include_hiddenboolean
show_bundledboolean

Response

Successful Response

idstring uuid required

Unique identifier for the agent

tenant_idstring required

ID of the tenant that owns this agent

namestring required

Name of the agent

descriptionstring required

Description of what the agent does

version_labelinteger required

Version of the deployed agent

semantic_versionstring nullable

Semantic version (e.g., 1.2.0)

version_namestring nullable

Human-readable version name

version_descriptionstring nullable

Description of changes in this version

instructionsstring nullable

Instructions for the agent

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

points_tostring[]

Environment IDs points to this version

commentsstring nullable

Comments added by the user while deploying an 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
hiddenboolean

To show or hide agent when agents are listed

deleted_atstring date-time nullable
knowledge_basestring[] nullable

List of knowledge_base available to the agent

display_namestring nullable

Display name of the agent

structured_outputobject nullable

JSON schema defining the structure for agent responses

custom_join_toolobject nullable

Reference to a Python tool ID 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

deployment_statusstring nullable

V1 API: Single deployment status for backward compatibility

deployment_statusesobject nullable

V2 API: Per-environment deployment statuses {env_id: status}

connection_idsstring[]

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

context_access_enabledboolean

Enable access to context variables for this agent

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

memory_enabledboolean

Enable/disable agentic memory for this agent