> ## Documentation Index > Fetch the complete documentation index at: https://docs.nugen.in/llms.txt > Use this file to discover all available pages before exploring further. # 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:** ```json GET /api/v3/agents Headers: {"Authorization": "Bearer "} ``` **Example Response:** ```json { "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 } ] } ``` ## OpenAPI ````yaml https://api.nugen.in/openapi-public.json get /api/v3/agents openapi: 3.1.0 info: title: Nugen Intelligence API description: 'Nugen Intelligence : Powering Specialized Intelligence At Scale' version: 25.4.20 servers: [] security: [] paths: /api/v3/agents: get: tags: - Agents summary: List Agents description: >- 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:** ```json GET /api/v3/agents Headers: {"Authorization": "Bearer "} ``` **Example Response:** ```json { "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 } ] } ``` operationId: list_agents parameters: - name: include_inactive in: query required: false schema: anyOf: - type: boolean - type: 'null' default: false title: Include Inactive responses: '200': description: Returns a comprehensive list of all agents created by the user content: application/json: schema: $ref: '#/components/schemas/AgentListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: AgentListResponse: properties: agents: items: $ref: '#/components/schemas/AgentData' type: array title: Agents description: >- List of agent objects with their configuration, status, deployment info, and usage statistics type: object required: - agents title: AgentListResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError AgentData: properties: id: type: string title: Id description: Unique agent identifier example: agent-12345 name: type: string title: Name description: Agent name example: Customer Support Agent description: type: string title: Description description: Agent description example: An agent designed to handle customer support queries base_model: type: string title: Base Model description: Base model identifier example: nugen-flash-instruct base_model_name: type: string title: Base Model Name description: Base model display name example: Nugen Flash Instruct created_date: type: string title: Created Date description: Agent creation date example: '2024-01-15T10:30:00Z' status: $ref: '#/components/schemas/AgentStatus' description: Agent status example: ACTIVE creator: type: string title: Creator description: Agent creator username example: youremail@domain.com endpoint: type: string title: Endpoint description: Agent API endpoint example: https://api.nugen.in/api/v3/inference/completions/agent-12345 usage_count: type: integer title: Usage Count description: Number of times agent has been used example: 150 last_used: anyOf: - type: string - type: 'null' title: Last Used description: Last usage timestamp example: '2024-01-20T14:30:00Z' performance_metrics: $ref: '#/components/schemas/AgentPerformanceMetrics' description: Agent performance metrics system_prompt: type: string title: System Prompt description: System prompt for the agent example: You are a helpful customer support assistant. temperature: type: number title: Temperature description: Temperature for model responses (0.0-2.0) example: 0.7 conversation_saving_enabled: type: boolean title: Conversation Saving Enabled description: Whether conversation saving is enabled for this agent default: false example: true type: object required: - id - name - description - base_model - base_model_name - created_date - status - creator - endpoint - usage_count - performance_metrics - system_prompt - temperature title: AgentInfo ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError AgentStatus: type: string enum: - ACTIVE - INACTIVE title: AgentStatus AgentPerformanceMetrics: properties: average_uncertainty: type: number title: Average Uncertainty description: Average uncertainty across all agent responses example: 0.15 human_interventions: type: integer title: Human Interventions description: Number of times human intervention was required example: 5 average_response_time: type: number title: Average Response Time description: Average response time in seconds example: 1.2 user_satisfaction_score: type: number title: User Satisfaction Score description: Average user satisfaction score from 0.0 to 1.0 example: 0.85 type: object required: - average_uncertainty - human_interventions - average_response_time - user_satisfaction_score title: AgentPerformanceMetrics securitySchemes: HTTPBearer: type: http scheme: bearer ````