Skip to main content
POST
Create Ai Agent
Create a new AI agent with custom configuration. The agent will be created and ready for configuration and deployment.

Request Body

string
required
Display name for the agent
string
Description of the agent’s purpose and capabilities
string
Deployment infrastructure: serverless or container. Defaults to serverless if not specified.
container deployment type is in beta and creates agents using container-based framework execution.
string
LLM provider: openai (default), anthropic, etc.
string
Specific model version (e.g., gpt-4o, gpt-4.1)
string
Emoji icon for the agent (e.g., ”🚀”, ”📊”)
object
System instructions configuration
string
Access control scope for the agent. Determines who can see and use the agent.Possible values: personal (visible only to the creator) or organizational (visible to the entire organization). Defaults to organizational if not specified.
string
Target environment ID (optional)
boolean
Use Nvidia NeMo (default: false)
string
Custom API base URL for LLM provider (for AI Gateway configurations)
object
Custom HTTP headers to include in LLM requests for gateway integration
string
Reasoning effort level for the LLM (e.g., low, medium, high)
string
Agent type: manager (default), regular, a2a, curl
string
Output format: text (default) or json
object
JSON schema for structured output when output_format is json
string
Natural-language description of the desired output
string
Agent framework (e.g., agno)
array
Array of connector tool attachments with connection IDs and selected operation IDs
array
Agent workflow graph configuration defining tool execution order
array
Array of knowledge base IDs to attach to the agent
object
Advanced agent settings including memory, session storage, tool limits, and safety features
object
Task-level strategies for retry, stop conditions, and iteration
object
Notification configuration (Slack, email, webhook) for agent events
object
Deep planning configuration for complex multi-step tasks
string
Voice ID for text-to-speech output
array
Source node configurations (e.g., Slack, web UI triggers)
boolean
Whether the agent requires human approval for tool calls

Response

Returns a complete AIAgent object:
string
Unique identifier for the created agent (UUID)
string
Display name of the agent
string
Agent description
string
Emoji icon representing the agent
string
Current deployment status: ACTIVE or INACTIVE
string
UUID of the organization that owns this agent
string
Deployment infrastructure: serverless, container, or null
object
System instructions configuration
string
Access control scope: personal or organizational
string
AI model provider (e.g., openai)
string
Specific model version (e.g., gpt-4o, gpt-4.1)
string
Agent framework used (e.g., agno)
string
Auto-generated human-friendly slug identifier (e.g., “beige-swallow”)
integer
Agent version number
array
Array of tools available to the agent
array
Array of knowledge bases attached to the agent
array
Agent workflow graph configuration
string
Auto-generated webhook URL for agent invocations

Example Request

Minimal create request (required fields only):
With full configuration:

Example Response

Notes

  • Only name is required. All other fields are optional and will use platform defaults.
  • The unique_name is auto-generated as a human-friendly slug (e.g., “jade-bass”)
  • The webhook_url is auto-generated for agent invocations
  • Agent starts in ACTIVE status immediately upon creation and is ready for invocation
  • version starts at 2 and increments with each deployment
  • has_pending_changes indicates whether there are unpublished configuration changes
  • The API may auto-upgrade model_name (e.g., requested gpt-4.1 returns gpt-5.2)

Next Steps

After creating an agent:
  1. Update instructions using Update Agent
  2. Add tools and knowledge bases to the agent
  3. Deploy the agent using Deploy Agent
  4. Invoke the agent using the task execution endpoints

Authorizations

x-api-key
string
header
required

API Key for authentication

Body

application/json

Request model for creating a new AI agent on the xpander.ai platform.

Only name is required. All other fields have sensible defaults matching the platform's standard agent configuration. The agent will be created with type 'manager' by default, which supports tool use, sub-agent delegation, and multi-step task execution.

Fields like organization_id, id, status, version, and other system-managed properties are set automatically by the platform and should not be provided.

name
string
required

Human-readable name for the agent. Must be unique within the organization. Examples: 'Customer Support Agent', 'Research Assistant'.

description
string | null
default:""

A brief description of what the agent does. Shown in agent listings and used by other agents when deciding delegation. Keep it concise and action-oriented.

icon
string | null
default:🚀

Emoji icon displayed next to the agent name in the UI. Single emoji character.

avatar
string | null
default:male-avatar

Avatar identifier for the agent's visual representation in chat interfaces.

type
enum<string> | null
default:manager

The agent type. 'manager' is the standard type that supports tools, sub-agents, and multi-step execution. 'regular' is a simpler agent without orchestration capabilities. 'a2a' and 'curl' are for external agent integrations. Do NOT set to 'orchestration' — use the Workflows API instead.

Available options:
manager,
regular,
a2a,
curl,
orchestration
created_by
string | null

User ID of the creator. Auto-populated from the API key if not provided.

model_provider
enum<string> | null
default:anthropic

The LLM provider to use for this agent's reasoning. Must match an available provider from GET /llm_providers. Common values: 'anthropic', 'openai', 'gemini'.

Available options:
openai,
nim,
amazon_bedrock,
azure_ai_foundary,
huggingFace,
friendlyAI,
anthropic,
gemini,
fireworks,
google_ai_studio,
helicone,
bytedance,
tzafon_lightcone,
cerebras,
open_router,
nebius,
cloudflare_ai_gw,
z_ai
model_name
string | null
default:claude-sonnet-5

The specific model identifier within the chosen provider. Must match a model from GET /llm_providers/{provider}/models. Examples: 'claude-sonnet-5', 'gpt-4o', 'gemini-2.0-flash'.

llm_reasoning_effort
enum<string> | null
default:medium

Controls the depth of reasoning the LLM applies. 'low' for simple tasks, 'medium' for balanced performance, 'high' for complex reasoning, 'xhigh' for maximum reasoning depth (slower, more expensive).

Available options:
low,
medium,
high,
xhigh
llm_api_base
string | null

Custom API base URL for the LLM provider. Use this when connecting to a self-hosted or proxied LLM endpoint instead of the provider's default URL. Leave None to use the provider's standard endpoint.

llm_credentials_key
string | null

Reference key to stored LLM API credentials in the xpander.ai vault. When set, the agent uses these credentials instead of the organization's default. Create credentials via the platform settings.

llm_credentials_key_type
enum<string> | null
default:xpander

Type of credential storage. 'xpander' uses xpander.ai's built-in credential vault. 'custom' indicates externally managed credentials.

Available options:
xpander,
custom
llm_credentials
LLMCredentials · object | null

Direct LLM credentials object. Prefer using llm_credentials_key for secure credential management. Only use this for testing or when vault access is unavailable.

llm_extra_headers
Llm Extra Headers · object | null

Additional HTTP headers to include in every LLM API request. Useful for custom authentication, routing through gateways (e.g., Helicone, Cloudflare AI Gateway), or passing metadata.

instructions
AIAgentInstructions · object | null

Structured instructions that define the agent's behavior. Contains 'role' (list of role descriptions), 'goal' (list of objectives), and 'general' (free-form instructions text). These are injected into the agent's system prompt.

expected_output
string | null
default:""

Description of the expected output format and content. Guides the agent on what the final response should look like. Used in the system prompt to set output expectations.

output_format
enum<string> | null
default:markdown

The format for the agent's final response. 'markdown' for rich text, 'text' for plain text, 'json' for structured JSON output (pair with output_schema), 'voice' for speech synthesis.

Available options:
text,
markdown,
json,
voice
output_schema
Output Schema · object | null

JSON Schema defining the structure of the agent's output when output_format is 'json'. The agent will conform its response to match this schema. Must be a valid JSON Schema object.

framework
string | null
default:agno

The execution framework for this agent. 'agno' is the default xpander.ai framework with full feature support. Other options: 'langchain', 'open-ai-agents', 'google-adk', 'strands-agents'.

deep_planning
boolean | null
default:false

Enable deep planning mode where the agent creates a detailed execution plan before taking actions. Useful for complex multi-step tasks. Increases latency but improves accuracy on complex workflows.

enforce_deep_planning
boolean | null
default:false

When True, forces the agent to always use deep planning regardless of task complexity. When False (default), the agent decides when to plan based on the task.

tools
(AddActionTool · object | AddCustomFunctionTool · object | AddMcpTool · object | AddSubAgentTool · object | AddWorkflowTool · object | AddSkillTool · object)[] | null

Tools to attach to the agent, in the unified simplified shape (the same payload as POST /v1/agents/{agent_id}/tools). This is the preferred way to attach tools — the API resolves catalog ids and wires the graph for you.

Each entry is one of (discriminated on type):

  • {"type": "action", "connection_id": "<connection_id>", "operation_ids": ["<catalog_op_id>", ...]}
  • {"type": "custom_function", "custom_function_id": ""}
  • {"type": "mcp", "mcp_id": "<registry_id>"} OR {"type": "mcp", "url": "https://...", "name": "...", "transport": "...", "auth_type": "...", "allowed_tools": [...]}
  • {"type": "agent", "agent_id": ""}
  • {"type": "workflow", "workflow_id": ""}
  • {"type": "skill", "skill_name": ""}

Resolves into attached_tools + graph server-side, so you don't need to construct those by hand. For advanced control you may still pass attached_tools/graph directly; when both are provided, tools are resolved and merged on top.

Attach connector operations as agent tools.

attached_tools
Connector · object[] | null

Advanced/low-level: list of connector connections with their operation IDs that this agent can use as tools. Prefer tools for the simplified shape. Each entry binds a connection (connector_organization) to specific operations the agent is allowed to invoke.

Structure: [{"id": "<connection_id>", "operation_ids": ["<catalog_operation_id_1>", "<catalog_operation_id_2>"]}]

  • 'id' is the connection ID (connector_organization.id) from POST /connectors/{connector_id}/connect
  • 'operation_ids' are the catalog operation _id values from GET /connectors/{connector_id}/{connection_id}/operations

If you provide attached_tools without corresponding graph entries, the API will automatically create graph items of type 'tool' for each operation, resolving catalog _id to operationId.

Special cases:

  • Custom functions: use id="xpander-custom-functions" and operation_ids=["<custom_function_id>", ...] Custom function IDs are the function UUIDs, not catalog operation IDs.
  • Sub-agents: do NOT use attached_tools. Add sub-agents directly to the 'graph' field with type='agent'.
  • MCP servers: do NOT use attached_tools. Add MCP servers directly to the 'graph' field with type='mcp'.

Example (connector operations): [{"id": "770832b8-c32b-4e4c-9ca2-232fec8099a7", "operation_ids": ["694bddfcd72d937c39875cf7"]}]

Example (custom functions): [{"id": "xpander-custom-functions", "operation_ids": ["my-function-uuid-1", "my-function-uuid-2"]}]

graph
AIAgentGraphItem · object[] | null

The agent's tool graph — defines which tools are available to the LLM and their execution flow. Each graph item represents a tool the agent can call during task execution.

For connector operations (type='tool'):

  • item_id: the operationId string (e.g., 'XpanderEmailServiceSendEmailWithHtmlOrTextContent')
  • name: human-readable name shown to the LLM (e.g., 'Send Email')
  • type: 'tool'
  • targets: list of graph item IDs that should execute after this tool (empty [] for no chaining)
  • NOTE: auto-created from attached_tools if not provided

For sub-agents (type='agent'):

  • item_id: the agent ID (UUID) to delegate work to
  • name: display name of the sub-agent
  • type: 'agent'
  • NO attached_tools entry needed — sub-agents are graph-only

For custom functions (type='tool', sub_type='custom_function'):

  • item_id: the custom function UUID
  • name: function name
  • type: 'tool'
  • Requires attached_tools entry with id='xpander-custom-functions'

For MCP servers (type='mcp'):

  • item_id: a unique ID for this MCP server instance
  • name: display name of the MCP server
  • type: 'mcp'
  • settings.mcp_settings: {url, transport, auth_type, name, allowed_tools, ...}
  • NO attached_tools entry needed — MCP servers are graph-only

NOTE: If you provide attached_tools with operation_ids but no corresponding graph items, the API will auto-create graph items with resolved operationId and pretty_name from catalog.

Examples: Connector tool: {"item_id": "SlackPostMessage", "name": "Send Slack Message", "type": "tool", "targets": []} Sub-agent: {"item_id": "agent-uuid-here", "name": "Research Agent", "type": "agent", "targets": []} MCP server: {"item_id": "mcp-uuid", "name": "Notion", "type": "mcp", "targets": [], "settings": {"mcp_settings": {"url": "https://mcp.notion.com/sse", "transport": "sse", "name": "Notion"}}}

knowledge_bases
AgentKnowledgeBase · object[] | null

Knowledge bases attached to this agent for RAG (Retrieval-Augmented Generation). Each entry references a knowledge base by ID and specifies the retrieval strategy ('vanilla' for simple retrieval, 'agentic_rag' for agent-driven retrieval).

source_nodes
AIAgentSourceNode · object[] | null

Entry points that can trigger this agent. Defines how the agent can be invoked — via SDK, scheduled tasks, webhooks, assistant UI, MCP, A2A protocol, Telegram, or Slack.

deployment_type
enum<string> | null
default:serverless

Where the agent runs. 'serverless' runs on xpander.ai's managed infrastructure (recommended). 'container' runs on your own infrastructure as a Docker container.

Available options:
serverless,
container
access_scope
enum<string> | null
default:personal

Who can access this agent. 'personal' restricts access to the creating user. 'organizational' makes it available to all organization members.

Available options:
personal,
organizational
environment_id
string | null

Target deployment environment ID. Leave None for the organization's default environment. Use this to deploy agents to specific on-premise or regional environments.

connectivity_details
AIAgentConnectivityDetailsA2A · object

Connection details for external agent integrations (A2A protocol or CURL-based). Only relevant when type is 'a2a' or 'curl'. For standard agents, leave as empty dict.

agno_settings
AgnoSettings · object | null

Configuration specific to the Agno framework. Controls session storage, coordinate mode (multi-agent), learning, memory strategies, guardrails (PII detection, prompt injection), tool call limits, and plan retry strategies. Only applies when framework is 'agno'.

task_level_strategies
TaskLevelStrategies · object | null

Execution strategies applied at the task level. Configure retry behavior (max retries), iterative execution (max iterations with stop conditions), stop strategies, daily run limits, and agentic context (persistent memory across runs).

notification_settings
NotificationSettings · object | null

Notification configuration for task completion events. Define notifications to send on success or error via email, Slack, or webhook. Each channel supports custom subject, body, and branding.

voice_id
string | null

Voice ID for text-to-speech output when output_format is 'voice'. References a voice profile in the platform's TTS service.

using_nemo
boolean | null
default:false

Enable NVIDIA NeMo guardrails integration for this agent. Provides additional safety and content filtering capabilities.

is_supervised
boolean | null
default:false

Enable supervised mode where the agent requires human approval before executing mutating operations (write/update/delete). Non-mutating operations (read/search) execute automatically.

is_autonomous
boolean | null
default:false

Run the agent in autonomous mode.

discoverable
boolean | null
default:true

When True, the agent is exposed to agent-discovery surfaces (e.g. omni). When False, it is hidden from discovery and can only be invoked directly.

with_auto_context_management
boolean | null
default:true

When True, the SDK runs its automatic context optimizer (compaction). When False, context management is skipped.

developer_access
boolean | null
default:true

When True, the agent is reachable from the developer API and webhook entry points. When False, external API/webhook invocation is rejected.

should_stage_before_publish
boolean | null
default:true

When True, edits are staged as a draft version before being published. When False, edits publish directly.

on_prem_event_streaming
boolean | null
default:true

Enable real-time event streaming for on-premise deployments. When True, task progress events are streamed to connected clients.

use_oidc_pre_auth
boolean | null
default:false

Enable OIDC pre-authentication for this agent. When enabled, the agent requires a valid OIDC token from the invoking user before execution. Used for user-context-aware operations.

pre_auth_audiences
string[] | null

List of allowed OIDC token audiences for pre-authentication validation. Only tokens with matching audience claims are accepted.

use_oidc_pre_auth_token_for_llm
boolean | null
default:false

When True, the user's OIDC token is forwarded to the LLM provider for authenticated LLM calls. Requires use_oidc_pre_auth to be enabled.

oidc_pre_auth_token_llm_audience
string | null

The audience claim to request when exchanging the user's OIDC token for LLM provider access. Only used when use_oidc_pre_auth_token_for_llm is True.

oidc_pre_auth_token_mcp_audience
string | null

The audience claim to request when exchanging the user's OIDC token for MCP server access. Enables user-context-aware MCP tool execution.

Response

Successful Response

name
string
required
organization_id
string
required
webhook_url
string
required
read-only
id
string | null
unique_name
string | null
origin_template
string | null
environment_id
string | null
deployment_type
enum<string> | null
default:serverless
Available options:
serverless,
container
prompts
string[] | null
is_latest
boolean | null
default:false
has_pending_changes
boolean | null
default:false
deep_planning
boolean | null
default:true
enforce_deep_planning
boolean | null
default:true
use_agent_gateway
boolean | null
default:false
connectivity_details
AIAgentConnectivityDetailsA2A · object
framework
string | null
default:agno
description
string | null
default:""
tools
any[] | null
icon
string | null
default:🚀
avatar
string | null
default:male-avatar
source_nodes
AIAgentSourceNode · object[] | null
attached_tools
Connector · object[] | null
access_scope
enum<string> | null
default:personal
Available options:
personal,
organizational
instructions
AIAgentInstructions · object | null
oas
Oas · object | null
graph
AIAgentGraphItem · object[] | null
is_omni
boolean | null
default:false
skills
Skills · object[] | null
status
enum<string> | null
default:ACTIVE

Enumeration of possible agent statuses.

Attributes: DRAFT: Agent is in a draft state. ACTIVE: Agent is active and operational. INACTIVE: Agent is inactive and not operational.

Available options:
DRAFT,
ACTIVE,
INACTIVE
knowledge_bases
AgentKnowledgeBase · object[] | null
version
integer | null
default:1
created_by
string | null
created_at
string<date-time> | null
type
enum<string> | null

Enumeration of the agent types.

Attributes: Manager: marks the agent as a Managing agent. Regular: marks the agent as a regular agent. A2A: marks the agent as an external agent used via A2A protocol. Curl: marks the agent as an external agent used via a CURL. Orchestration: marks the agent as an Orchestration object.

Available options:
manager,
regular,
a2a,
curl,
orchestration
using_nemo
boolean | null
default:false
deletable
boolean | null
default:true
model_provider
enum<string> | null
default:amazon_bedrock
Available options:
openai,
nim,
amazon_bedrock,
azure_ai_foundary,
huggingFace,
friendlyAI,
anthropic,
gemini,
fireworks,
google_ai_studio,
helicone,
bytedance,
tzafon_lightcone,
cerebras,
open_router,
nebius,
cloudflare_ai_gw,
z_ai
model_name
string | null
default:global.anthropic.claude-sonnet-5
llm_reasoning_effort
enum<string> | null
default:medium
Available options:
low,
medium,
high,
xhigh
llm_api_base
string | null
output_format
enum<string> | null
default:markdown
Available options:
text,
markdown,
json,
voice
voice_id
string | null
output_schema
Output Schema · object | null
llm_credentials_key
string | null
llm_credentials_key_type
enum<string> | null
default:xpander
Available options:
xpander,
custom
llm_credentials
LLMCredentials · object | null
llm_extra_headers
Llm Extra Headers · object | null
expected_output
string | null
default:""
agno_settings
AgnoSettings · object | null
on_prem_event_streaming
boolean | null
default:true
is_supervised
boolean | null
default:false
orchestration_nodes
OrchestrationNode · object[] | null
notification_settings
NotificationSettings · object | null

Configuration for event-based notifications.

Attributes: on_success: Notifications to send when an operation succeeds. Maps notification types to a list of notification configurations. on_error: Notifications to send when an operation fails. Maps notification types to a list of notification configurations. on_budget: Notifications to send on budget threshold crossings. A dedicated category — budget alerts are not errors.

task_level_strategies
TaskLevelStrategies · object | null

Configuration object for task-level execution strategies.

This model groups optional strategy configurations that control how a task is executed and managed over time, including retries, iterative execution, stopping conditions, and daily run limits.

Attributes: retry_strategy: Optional retry policy configuration that defines how the task should behave when execution fails (e.g., max attempts, backoff rules).

use_oidc_pre_auth
boolean | null
default:false
pre_auth_audiences
string[] | null
use_oidc_pre_auth_token_for_llm
boolean | null
default:false
oidc_pre_auth_token_llm_audience
string | null
oidc_pre_auth_token_mcp_audience
string | null
can_self_schedule
boolean | null
default:false
max_self_schedules
integer | null
default:3
Required range: 1 <= x <= 1000
use_dynamic_tools
boolean | null
default:false
workspace_tools_enabled
boolean | null
default:true
is_autonomous
boolean | null
default:false
discoverable
boolean | null
default:true
with_auto_context_management
boolean | null
default:true
developer_access
boolean | null
default:true
should_stage_before_publish
boolean | null
default:true