​
List Interfaces Command

The agent interfaces list command displays all API interfaces that are available or currently configured for a specific AI Agent. Each interface represents a group of related API endpoints that the agent can use.

​
Usage

xpander agent interfaces list <agent_id> [--status <status>] [--format <format>]

​
Options

OptionDescription
--status <status>Optional. Filter by status: available, configured, all (default)
--format <format>Optional. Output format: table (default), json, or wide

​
Examples

​
List All Interfaces

xpander agent interfaces list agent_123

Response:

INTERFACE           STATUS       ENDPOINTS    CALLS/DAY    LATENCY
articles            Active       8            1250         120ms
knowledge_base      Active       5            850          180ms
user_management     Available    12           -            -
notifications       Available    6            -            -
analytics          Available    10           -            -

​
List Active Interfaces

xpander agent interfaces list agent_123 --status configured

Response:

INTERFACE           STATUS       ENDPOINTS    CALLS/DAY    LATENCY
articles            Active       8            1250         120ms
knowledge_base      Active       5            850          180ms

​
JSON Format

xpander agent interfaces list agent_123 --format json

Response:

{
  "interfaces": {
    "configured": [
      {
        "name": "articles",
        "status": "active",
        "metrics": {
          "endpoints": 8,
          "calls_today": 1250,
          "avg_latency": 120
        },
        "endpoints": [
          {
            "name": "search_articles",
            "type": "function",
            "description": "Search articles in the system with optional filters",
            "parameters": {
              "type": "object",
              "properties": {
                "query_params": {
                  "type": "object",
                  "properties": {
                    "tag": { "type": "string" },
                    "author": { "type": "string" }
                  }
                },
                "path_params": {
                  "type": "object",
                  "properties": {}
                },
                "body_params": {
                  "type": "object",
                  "properties": {}
                }
              },
              "required": ["query_params", "path_params", "body_params"]
            }
          },
          // ... more endpoints
        ]
      },
      {
        "name": "knowledge_base",
        "status": "active",
        "metrics": {
          "endpoints": 5,
          "calls_today": 850,
          "avg_latency": 180
        },
        "endpoints": [
          // ... endpoint definitions
        ]
      }
    ],
    "available": [
      {
        "name": "user_management",
        "description": "User management and authentication APIs",
        "endpoint_count": 12,
        "auth_type": "oauth2"
      },
      // ... more available interfaces
    ]
  }
}

​
Notes

  • Interfaces represent groups of related API endpoints
  • Each interface contains:
    • Multiple API endpoints
    • Function definitions
    • Parameter schemas
    • Authentication requirements
  • The wide format includes additional details like:
    • Endpoint specifications
    • Usage statistics
    • Performance metrics
    • Schema definitions
  • Use xpander agent interfaces add to configure available interfaces
  • Each endpoint follows OpenAPI specification format
  • Metrics are tracked per interface and per endpoint

​
Changelog

Previous
Add Interface
Next