REST API - Agents
REST API - Knowledge
REST API - Toolkits
REST API - Misc
Python SDK - Core Modules
Python SDK - API Reference
CLI Reference
List Agents (Full)
Copy
Ask AI
curl --request GET \
--url https://api.xpander.ai/v1/agents/full \
--header 'x-api-key: <api-key>'Copy
Ask AI
{
"items": [
{
"name": "<string>",
"organization_id": "<string>",
"webhook_url": "<string>",
"id": "<string>",
"unique_name": "<string>",
"origin_template": "<string>",
"delegation_end_strategy": "return-to-start",
"environment_id": "<string>",
"sub_agents_continuous_thread": true,
"deployment_type": "serverless",
"created_by_prompt": "<string>",
"prompts": [],
"is_latest": true,
"framework": "agno",
"description": "",
"tools": [],
"icon": "🚀",
"avatar": "male-avatar",
"source_nodes": [],
"attached_tools": [],
"access_scope": "organizational",
"instructions": {
"role": [],
"goal": [],
"general": ""
},
"oas": {},
"graph": [],
"llm_settings": [],
"status": "ACTIVE",
"knowledge_bases": [],
"version": 1,
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"type": "manager",
"delegation_type": "router",
"delegation_memory_strategy": "summarization",
"is_ai_employee": false,
"using_nemo": false,
"deletable": true,
"model_provider": "openai",
"model_name": "gpt-4.1",
"llm_api_base": "<string>",
"output_format": "markdown",
"output_schema": {},
"llm_credentials_key": "<string>",
"llm_credentials_key_type": "xpander",
"llm_credentials": {
"name": "<string>",
"value": "<string>",
"description": "<string>"
},
"expected_output": "",
"agno_settings": {
"session_storage": true,
"user_memories": false,
"session_summaries": false,
"num_history_runs": 3,
"max_tool_calls_from_history": 0,
"tool_call_limit": 0,
"coordinate_mode": true,
"pii_detection_enabled": false,
"pii_detection_mask": false,
"prompt_injection_detection_enabled": false,
"openai_moderation_enabled": false
},
"on_prem_event_streaming": true,
"prompts_caching_enabled": false,
"is_generalist": false
}
],
"total": 123,
"page": 123,
"per_page": 123,
"total_pages": 123
}REST API - Agents
List Agents (Full Details)
Retrieve a paginated list of AI agents with complete configuration details
GET
/
v1
/
agents
/
full
List Agents (Full)
Copy
Ask AI
curl --request GET \
--url https://api.xpander.ai/v1/agents/full \
--header 'x-api-key: <api-key>'Copy
Ask AI
{
"items": [
{
"name": "<string>",
"organization_id": "<string>",
"webhook_url": "<string>",
"id": "<string>",
"unique_name": "<string>",
"origin_template": "<string>",
"delegation_end_strategy": "return-to-start",
"environment_id": "<string>",
"sub_agents_continuous_thread": true,
"deployment_type": "serverless",
"created_by_prompt": "<string>",
"prompts": [],
"is_latest": true,
"framework": "agno",
"description": "",
"tools": [],
"icon": "🚀",
"avatar": "male-avatar",
"source_nodes": [],
"attached_tools": [],
"access_scope": "organizational",
"instructions": {
"role": [],
"goal": [],
"general": ""
},
"oas": {},
"graph": [],
"llm_settings": [],
"status": "ACTIVE",
"knowledge_bases": [],
"version": 1,
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"type": "manager",
"delegation_type": "router",
"delegation_memory_strategy": "summarization",
"is_ai_employee": false,
"using_nemo": false,
"deletable": true,
"model_provider": "openai",
"model_name": "gpt-4.1",
"llm_api_base": "<string>",
"output_format": "markdown",
"output_schema": {},
"llm_credentials_key": "<string>",
"llm_credentials_key_type": "xpander",
"llm_credentials": {
"name": "<string>",
"value": "<string>",
"description": "<string>"
},
"expected_output": "",
"agno_settings": {
"session_storage": true,
"user_memories": false,
"session_summaries": false,
"num_history_runs": 3,
"max_tool_calls_from_history": 0,
"tool_call_limit": 0,
"coordinate_mode": true,
"pii_detection_enabled": false,
"pii_detection_mask": false,
"prompt_injection_detection_enabled": false,
"openai_moderation_enabled": false
},
"on_prem_event_streaming": true,
"prompts_caching_enabled": false,
"is_generalist": false
}
],
"total": 123,
"page": 123,
"per_page": 123,
"total_pages": 123
}Retrieve a paginated list of AI agents with complete information including configuration, tools, knowledge bases, and deployment details. This endpoint provides more detailed information than the minimal list endpoint.
Query Parameters
Page number (starting from 1)
Items per page (maximum 50)
Response
Returns a paginated list of agents with complete details:Array of complete agent objects
Show Agent Object
Show Agent Object
Unique identifier for the agent (UUID format)
Display name of the agent
Emoji icon representing the agent
Current deployment status: ACTIVE, INACTIVE
Organization UUID this agent belongs to
Deployment method: serverless, container, or null
Complete system instructions configuration
LLM provider: openai, anthropic, etc.
Specific model version (e.g., gpt-4o, gpt-4.1)
Agent framework used (e.g., agno)
ISO timestamp of when the agent was created
Array of tool configurations attached to this agent
Array of knowledge base IDs attached to this agent
Total number of agents across all pages
Current page number
Number of items per page
Total number of pages available
Example Request
Copy
Ask AI
curl -X GET -H "x-api-key: YOUR_API_KEY" \
"https://api.xpander.ai/v1/agents/full?page=1&per_page=2"
Example Response
Copy
Ask AI
{
"items": [
{
"id": "0045cf07-8af6-4c69-8d13-0a13c631a5d0",
"unique_name": "lavender-wolverine",
"name": "DevOps AI Agent",
"icon": "🚀",
"avatar": "male-avatar",
"status": "ACTIVE",
"organization_id": "91fbe9bc-35b3-41e8-b59d-922fb5a0f031",
"deployment_type": "container",
"framework": "agno",
"model_provider": "openai",
"model_name": "gpt-4.1",
"type": "manager",
"delegation_type": "router",
"created_at": "2025-08-22T01:45:30.341088Z",
"instructions": {
"role": [
"users can't access your files so upload the files and use markdown when comment with public link.",
"Don't stop until complete all tools are valid.",
"generate_diagram can fail, retry with different code"
],
"goal": [],
"general": "AI DevOps"
},
"tools": [],
"knowledge_bases": [],
"deletable": true,
"using_nemo": false,
"source_nodes": [
{
"id": "283a165d-c8d7-4b2b-8d38-5d479ffef236",
"type": "assistant",
"targets": null,
"metadata": {}
}
],
"attached_tools": [],
"access_scope": "organizational",
"graph": []
}
],
"total": 24,
"page": 1,
"per_page": 2,
"total_pages": 12
}
Notes
- This endpoint returns complete agent configurations, which may be slower than the minimal list endpoint
- Use the minimal list endpoint (
GET /v1/agents) if you only need basic agent information - The response is automatically filtered based on your API key’s permissions
See Also
- [List Agents (Minimal)](/API reference/v1/agents/list-agents) - Lightweight endpoint for basic agent info
- [Get Agent](/API reference/v1/agents/get-agent) - Get complete details for a single agent
Authorizations
API Key for authentication
Query Parameters
Page number (starting from 1) Page number (starting from 1)
Required range:
x >= 1Items per page (max 50) Items per page (max 50)
Required range:
1 <= x <= 50Response
Successful Response
Show child attributes
Show child attributes
Enumeration of the agent delegation end strategies.
Attributes: ReturnToStart: when last agent is finished and about to announce "finish" it will summarize and return to the first agent. FinishWithLast: finish at the last agent.
Available options:
return-to-start, finish-with-last Available options:
serverless, container Whether this is the latest version of the agent
Available options:
personal, organizational Show child attributes
Show child attributes
Available options:
source_node, agent, tool, human_in_the_loop, custom_agent, storage, coding_agent, mcp Available options:
sdk, task, assistant, webhook, operation, custom_function, local_tool Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
slack Show child attributes
Show child attributes
Available options:
local, remote Available options:
stdio, sse, streamable-http Available options:
api_key, custom_headers, none 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 Show child attributes
Show child attributes
Available options:
vanilla, agentic_rag Enumeration of the agent types.
Attributes: Manager: marks the agent as a Managing agent. Regular: marks the agent as a regular agent.
Available options:
manager, regular Enumeration of the agent delegation types.
Attributes: Router: Marks the agent as a router agent - xpanderAI's LLM will decide which sub-agent to trigger. Sequence: Marks the agent as a sequence agent - sub-agents will delegate to other sub-agents.
Available options:
router, sequence Enumeration of the agent delegation memory strategies.
Attributes: Full: The memory object will be passed completely between agents. Summarization: Between each sub-agent delegation, a summarization will occur, and a new thread will be created for each agent. OriginalInput: the sub agent will get the initial task with a fresh memory thread
Available options:
full, summarization, original-input Available options:
openai, nim, amazon_bedrock, huggingFace, friendlyAI, anthropic, gemini, fireworks Available options:
text, markdown, json Available options:
xpander, custom Show child attributes
Show child attributes
Was this page helpful?
⌘I