Skip to main content
GET
/
v1
/
agents
/
full
List Agents (Full)
curl --request GET \
  --url https://api.xpander.ai/v1/agents/full \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "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": [
        "<string>"
      ],
      "name": "<string>",
      "framework": "<string>",
      "description": "<string>",
      "tools": [
        "<any>"
      ],
      "icon": "<string>",
      "avatar": "<string>",
      "source_nodes": [
        {
          "id": "<string>",
          "type": "workbench",
          "targets": [
            "<string>"
          ],
          "metadata": {}
        }
      ],
      "attached_tools": [
        {
          "id": "<string>",
          "operation_ids": [
            "<string>"
          ]
        }
      ],
      "access_scope": "personal",
      "instructions": {
        "role": [
          "<string>"
        ],
        "goal": [
          "<string>"
        ],
        "general": "<string>"
      },
      "oas": {},
      "graph": [
        {
          "id": "<string>",
          "item_id": "<string>",
          "name": "<string>",
          "type": "source_node",
          "sub_type": "sdk",
          "targets": [
            "<string>"
          ],
          "settings": {
            "instructions": "<string>",
            "description": "<string>",
            "schemas": {
              "input": {},
              "output": {}
            },
            "advanced_filtering_options": {
              "returnables": [
                "<any>"
              ],
              "searchables": [
                "<any>"
              ],
              "globally_enabled": true
            },
            "hitl_options": {
              "title": "<string>",
              "description": "<string>",
              "recipients": [
                "<any>"
              ],
              "hitl_type": "slack",
              "slack_app": "<string>",
              "should_approve_with_current_user": true
            },
            "a2a_options": {
              "url": "<string>"
            },
            "coding_agent_settings": {
              "type": "<string>"
            },
            "mcp_settings": {
              "type": "local",
              "name": "<string>",
              "command": "<string>",
              "url": "<string>",
              "transport": "stdio",
              "auth_type": "api_key",
              "api_key": "<string>",
              "headers": {},
              "env_vars": {},
              "allowed_tools": [
                "<any>"
              ]
            },
            "use_cache": true
          },
          "llm_settings": [
            {
              "type": "before",
              "provider": "<string>",
              "model": "<string>",
              "temperature": 123
            }
          ],
          "is_first": true
        }
      ],
      "llm_settings": [
        {
          "type": "before",
          "provider": "<string>",
          "model": "<string>",
          "temperature": 123
        }
      ],
      "status": "DRAFT",
      "knowledge_bases": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "strategy": "vanilla",
          "rw": true,
          "documents": [
            "<string>"
          ]
        }
      ],
      "version": 123,
      "organization_id": "<string>",
      "created_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "type": "manager",
      "delegation_type": "router",
      "delegation_memory_strategy": "full",
      "is_ai_employee": true,
      "using_nemo": true,
      "deletable": true,
      "model_provider": "openai",
      "model_name": "<string>",
      "llm_api_base": "<string>",
      "output_format": "text",
      "output_schema": {},
      "llm_credentials_key": "<string>",
      "llm_credentials_key_type": "xpander",
      "llm_credentials": {
        "name": "<string>",
        "description": "<string>",
        "value": "<string>"
      },
      "expected_output": "<string>",
      "agno_settings": {
        "session_storage": true,
        "user_memories": true,
        "session_summaries": true,
        "num_history_runs": 123,
        "max_tool_calls_from_history": 123,
        "tool_call_limit": 123,
        "coordinate_mode": true,
        "pii_detection_enabled": true,
        "pii_detection_mask": true,
        "prompt_injection_detection_enabled": true,
        "openai_moderation_enabled": true,
        "openai_moderation_categories": [
          "<string>"
        ]
      },
      "on_prem_event_streaming": true,
      "prompts_caching_enabled": true,
      "is_generalist": true,
      "webhook_url": "<string>"
    }
  ],
  "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
integer
default:1
Page number (starting from 1)
per_page
integer
default:20
Items per page (maximum 50)

Response

Returns a paginated list of agents with complete details:
items
array
Array of complete agent objects
total
integer
Total number of agents across all pages
page
integer
Current page number
per_page
integer
Number of items per page
total_pages
integer
Total number of pages available

Example Request

curl -X GET -H "x-api-key: YOUR_API_KEY" \
  "https://api.xpander.ai/v1/agents/full?page=1&per_page=2"

Example Response

{
  "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

x-api-key
string
header
required

API Key for authentication

Query Parameters

page
integer
default:1

Page number (starting from 1)

Required range: x >= 1
per_page
integer
default:20

Items per page (max 50)

Required range: 1 <= x <= 50

Response

Successful Response

items
AIAgent · object[]
required
total
integer
required
page
integer
required
per_page
integer
required
total_pages
integer
required