XPxpander
API v1
Agents
Agents Import/Export

Import Agent

Imports an AI agent from a template and creates a new agent instance

post/v1/agents/template_import/{template_id}

Request

  • Base URL
    https://api.xpander.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-api-key

Path parameters

template_idstring required

Request body

namestring nullable

Name for the new agent. Omit to keep the template's name.

descriptionstring nullable

Description for the new agent. Omit to keep the template's.

iconstring nullable

Icon for the new agent (xpi:<icon>:<colour>). Omit to keep the template's.

with_knowledge_basesboolean nullable

Copy the template's knowledge bases into new ones.

connectors_mappingobject nullable

Template connector root id to your connection id.

project_idstring nullable

Project for the new agent; unset means the key's project or the org's Default.

Response

Successful Response

idstring nullable
unique_namestring nullable
origin_templatestring nullable
environment_idstring nullable
runtime_environment_idstring nullable
deployment_type'serverless' | 'container'
promptsstring[] nullable
is_latestboolean nullable
has_pending_changesboolean nullable
deep_planningboolean nullable
enforce_deep_planningboolean nullable
use_agent_gatewayboolean nullable
namestring required
frameworkstring nullable
descriptionstring nullable
iconstring nullable
avatarstring nullable
access_scope'personal' | 'organizational' | 'project'
project_idstring nullable
oasobject nullable
is_omniboolean nullable
kind'gateway' | 'cloud_code'

A platform-made agent: the gateway one is hidden from lists, counts and delegation; every kind stays out of the agents quota.

skillsobject[] nullable
runtime_environmentobject nullable
company_brain_enabledboolean
agent_brainsstring[] nullable
secret_bindingsobject[] nullable
required_secretsobject[]
gated_commandsobject[] nullable
status'DRAFT' | 'ACTIVE' | 'INACTIVE'

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.

versioninteger nullable
organization_idstring required
created_bystring nullable
default_user_idstring nullable

Organization user to run as when a non-UI invocation has no resolved user.

background_user_overridesobject
created_atstring date-time nullable
type'manager' | 'regular' | 'a2a' | 'curl' | 'orchestration'

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.

using_nemoboolean nullable
deletableboolean nullable
model_provider'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_namestring nullable
llm_reasoning_effort'low' | 'medium' | 'high' | 'xhigh'
llm_api_basestring nullable
output_format'text' | 'markdown' | 'json' | 'voice'
voice_idstring nullable
output_schemaobject nullable
llm_credentials_keystring nullable
llm_credentials_key_type'xpander' | 'custom'
llm_extra_headersobject nullable
expected_outputstring nullable
on_prem_event_streamingboolean nullable
is_supervisedboolean nullable
use_oidc_pre_authboolean nullable
pre_auth_audiencesstring[] nullable
use_oidc_pre_auth_token_for_llmboolean nullable
oidc_pre_auth_token_llm_audiencestring nullable
oidc_pre_auth_token_mcp_audiencestring nullable
can_self_scheduleboolean nullable
can_archive_conversationsboolean nullable
max_self_schedulesinteger nullable
use_dynamic_toolsboolean nullable
workspace_tools_enabledboolean nullable
live_surface_sharing_enabledboolean nullable
is_autonomousboolean nullable
discoverableboolean nullable
conversation_retentionAgentConversationRetention
with_auto_context_managementboolean nullable
developer_accessboolean nullable
should_stage_before_publishboolean nullable
webhook_urlstring required

Changes

No recorded changes to this operation across all 6 revisions of this API.