Sign in

v1

latestOpenAPI 3.1.02026-07-26252382475.4 KB
Agent Releases

Get An Agent Version By Id And Version

Get an agent version by id and version.

get/v1/orchestrate/agents/{id}/releases/{version}

Path parameters

idstring uuid required
versioninteger required

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

instructionsstring nullable

Instructions for the agent

llmstring nullable

LLM identifier for the agent

created_bystring required

ID of the user who created the agent

created_onstring date-time required

Creation timestamp

updated_atstring date-time required

Last update timestamp

updated_bystring required

ID of the user who updated the agent

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

Supported apps of the agent

agent_mappingobject required

Mapping of agent IDs to their respective agent types

deleted_bystring nullable
deleted_atstring date-time nullable
hiddenboolean

To show or hide agent when agents are listed

points_tostring[]

Environment IDs points to this version

display_namestring nullable

Display name of the agent

commentsstring nullable

Comments added by the user while deploying an agent

knowledge_basestring[] nullable

List of knowledge_base available to 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

deployment_statusstring nullable

Status of the agent deployment

tagsstring[] nullable

List of tags associated to agent

voice_configuration_idstring uuid nullable

Voice configuration for the agent

name_for_llmstring nullable
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