Skip to main content
GET
/
v1
/
agents
List Agents (Minimal)
curl --request GET \
  --url https://api.xpander.ai/v1/agents \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "name": "<string>",
      "organization_id": "<string>",
      "created_by": "<string>",
      "created_by_details": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "id": "<string>",
      "description": "<string>",
      "icon": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "instructions": {
        "role": [],
        "goal": [],
        "general": ""
      },
      "llm_api_base": "<string>",
      "model_name": "<string>",
      "framework": "<string>",
      "using_nemo": true,
      "is_coordinate_mode": true,
      "has_pending_changes": true,
      "use_oidc_pre_auth": false,
      "pre_auth_audiences": [],
      "use_oidc_pre_auth_token_for_llm": false,
      "oidc_pre_auth_token_llm_audience": "<string>",
      "oidc_pre_auth_token_mcp_audience": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123,
  "total_pages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.xpander.ai/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a paginated list of agents for browsing and selection. Although this is the lighter-weight listing endpoint, the payload typically includes core deployment and model metadata and may include additional summary fields such as instructions or compatibility flags.

​
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 agent summaries. Treat unknown fields as forward-compatible metadata.
​
items
array
Array of 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?page=1&per_page=2"

​
Example Response

{
  "items": [
    {
      "id": "<agent-id>",
      "name": "Product Specialist",
      "description": "Processes queries to provide comprehensive product information",
      "icon": "🚀",
      "status": "ACTIVE",
      "organization_id": "<org-id>",
      "deployment_type": "serverless",
      "created_at": "2026-02-05T18:35:04.724091Z",
      "created_by": "<user-id>",
      "created_by_details": {
        "id": "<user-id>",
        "name": "Jane Doe",
        "email": "jane@acme.com"
      },
      "instructions": {
        "role": [
          "Answer product questions clearly and accurately"
        ],
        "goal": [
          "Help users find the right product quickly"
        ],
        "general": "I am a product specialist focused on concise, accurate answers."
      },
      "model_provider": "openai",
      "model_name": "gpt-5.2",
      "framework": "agno",
      "type": "manager",
      "llm_api_base": null,
      "has_pending_changes": false
    }
  ],
  "total": 12,
  "page": 1,
  "per_page": 20,
  "total_pages": 1
}

​
Notes

  • /v1/agents is the lighter-weight listing endpoint, but the response includes more than just id, name, and status
  • Additional fields may appear over time; client code should ignore unknown keys
  • The items array is sorted by creation date (newest first)
  • Use pagination to handle large result sets efficiently
  • Status values are: ACTIVE (deployed and ready), INACTIVE (not deployed)
  • See List Agents (Full Details) for complete agent configuration

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
MinimalAIAgent · object[]
required
​
total
integer
required
​
page
integer
required
​
per_page
integer
required
​
total_pages
integer
required