List Agents

Retrieve all agents owned by the user.

This endpoint returns a comprehensive list of all agents created by the user, including their configuration, usage statistics, and conversation settings.

Query Parameters:

• include_inactive (optional): Set to true to include inactive agents. Default: false

Response includes:

• Usage statistics (total usage count and last used timestamp)
• Conversation saving status based on user settings
• Full endpoint URL for executing the agent

Returns:

• agents: List of agent objects, each containing:
  • id: Unique agent identifier
  • name: Agent name (normalized, URL-friendly)
  • description: Agent description
  • base_model: Model ID used by the agent
  • base_model_name: Human-readable model name
  • created_date: ISO 8601 timestamp of creation
  • status: Agent status (e.g., “ACTIVE”, “INACTIVE”)
  • creator: Username/email of the agent creator
  • endpoint: Full API endpoint URL for running the agent
  • usage_count: Total number of times the agent has been invoked
  • last_used: ISO 8601 timestamp of last usage (null if never used)
  • performance_metrics: Performance statistics (average_uncertainty, human_interventions, average_response_time, user_satisfaction_score)
  • system_prompt: Full system instructions for the agent
  • temperature: Temperature for model responses (0.0-2.0)
  • conversation_saving_enabled: Whether conversations are saved

Example Request:

GET /api/v3/agents
Headers: {"Authorization": "Bearer <api_key>"}

Example Response:

{
  "agents": [
    {
      "id": "agent-123",
      "name": "customer_support_bot",
      "description": "Handles customer inquiries",
      "base_model": "nugen-flash-instruct",
      "base_model_name": "Nugen Flash Instruct",
      "created_date": "2024-01-15T10:30:00Z",
      "status": "ACTIVE",
      "creator": "user@example.com",
      "endpoint": "https://api.nugen.in/api/v3/agents/run-agents/customer_support_bot/run",
      "usage_count": 42,
      "last_used": "2024-01-20T15:45:00Z",
      "performance_metrics": {
        "average_uncertainty": 0.0,
        "human_interventions": 0,
        "average_response_time": 0.0,
        "user_satisfaction_score": 0.0
      },
      "system_prompt": "You are a helpful customer support agent. Be empathetic and solution-oriented.",
      "temperature": 0.7,
      "conversation_saving_enabled": true
    }
  ]
}