Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
Successful Response
Schema for a complete agent version.
Unique identifier for the agent
ID of the tenant that owns this agent
Name of the agent
Description of what the agent does
Version of the deployed agent
ID of the user who created the agent
Creation timestamp
Last update timestamp
ID of the user who updated the agent
Style of the agent
default
, react
, planner
Mapping of agent IDs to their respective agent types
Instructions for the agent
List of tool names available to the agent
List of other agent names this agent can collaborate with
LLM identifier for the agent
Supported apps of the agent
To show or hide agent when agents are listed
Environment IDs points to this version
Display name of the agent
Comments added by the user while deploying an agent
List of Environments points to the agent version
List of knowledge_base available to the agent
List of simplified environments associated with the agent
JSON schema defining the structure for agent responses
List of guidelines for the agent behavior
Reference to a Python tool ID that will be used for custom synthesis of task results
Status of the agent deployment
List of tags associated to agent
Agent Additional Settings A specification for settings within an agent
Voice configuration for the agent
Chat with Documents config for Agent Version
Enable access to context variables for this agent
List of context variable names that this agent can access