Sign in

v1

latestOpenAPI 3.1.02026-07-26252382475.4 KB
Agents

Register A New Agent

Registers a new agent in the system.

Authorization:

  • For IBM Cloud: Uses PDP (Policy Decision Point) authorization via check_pdp_authorization_with_session
  • For other platforms: Uses tenant-level permission check via verify_agent_access
post/v1/orchestrate/agents

Request body

namestring nullable

Name of the agent

display_namestring nullable

Display name of the agent

descriptionstring required

Description of what the agent does

instructionsstring nullable

Instructions for the agent

toolsstring[] nullable

List of tool names available to the agent

collaboratorsstring[] nullable

List of other agent names this agent can collaborate with

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

glossarystring[] nullable

List of glossary available to the agent

knowledge_basestring[] nullable

List of knowledge_base available to the agent

hiddenboolean

To show or hide agent when agents are listed

structured_outputobject nullable

JSON schema defining the structure for agent responses

custom_join_toolstring 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

context_access_enabledboolean

Enable access to context variables for this agent

context_variablesstring[] nullable

List of context variable names that this agent can access

connection_idsstring[] nullable

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

hide_reasoningboolean

Enable/disable reasoning trace

sync_tool_flow_interactionsboolean

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

voice_configuration_idstring uuid nullable

Voice configuration for the agent

restrictions'editable' | 'non_editable' | 'custom'
bundled_agent_idstring uuid nullable

Base agent id

workspace_idstring uuid nullable

ID of the workspace that owns this agent

toolkitsstring[] nullable

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

Response

Successful Response

{"stackTrail":"paths:/v1/orchestrate/agents:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}