Skip to main content
Register A New Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Schema for creating a new agent.

description
string
required

Description of what the agent does

style
enum<string>
required

Style of the agent

Available options:
default,
react,
planner,
custom,
react_intrinsic,
experimental_customer_care,
code_act
name
string | null

Name of the agent

display_name
string | null

Display name of the agent

instructions
string | null

Instructions for the agent

tools
string[] | null

List of tool names available to the agent

collaborators
string[] | null

List of other agent names this agent can collaborate with

llm
string | null

LLM identifier for the agent

supported_apps
enum<string>[] | null

Supported apps of the agent

Available options:
slack/askhr
glossary
string[] | null

List of glossary available to the agent

guidelines
Guideline · object[] | null

List of guidelines for the agent behavior

knowledge_base
string[] | null

List of knowledge_base available to the agent

hidden
boolean
default:false

To show or hide agent when agents are listed

structured_output
Structured Output · object | null

JSON schema defining the structure for agent responses

custom_join_tool
string | null

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

additional_properties
AgentAdditionalPropertiesIn · object | null

Agent Additional Settings

tags
string[] | null

List of tags associated to agent

chat_with_docs
ChatWithDocsConfig · object | null

Chat with Documents config for Agent

context_access_enabled
boolean
default:true

Enable access to context variables for this agent

context_variables
string[] | null

List of context variable names that this agent can access

connection_ids
string[] | null

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

hide_reasoning
boolean
default:false

Enable/disable reasoning trace

sync_tool_flow_interactions
boolean
default:true

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

voice_configuration_id
string<uuid> | null

Voice configuration for the agent

restrictions
enum<string>
default:editable

Enable editable for the collaborator agent

Available options:
editable,
non_editable,
custom
bundled_agent_id
string<uuid> | null

Base agent id

workspace_id
string<uuid> | null
default:00000000-0000-0000-0000-000000000001

ID of the workspace that owns this agent

llm_config
ModelConfig · object | null
plugins
Plugins · object | null

Plugins and hook points associated to the agents

toolkits
string[] | null

List of toolkit ids available to the agent

memory_enabled
boolean
default:false

Enable/disable agentic memory for this agent

is_schedulable
boolean
default:false

Indicates whether this agent can be scheduled

Response

Successful Response