Get all Agents

Retrieves a list of agents with support for pagination and advanced filters, enabling users to explore and manage agents effectively.

Purpose:

Allows users to fetch agents with optional filters such as search query, carousel ID, and teammate view.

Supports pagination and tag-based filtering to refine large datasets.

Query Parameters:

query (string, optional): Search term to filter agents by name.

carousel_id (string, optional): Filter agents associated with a specific carousel.

published_as_teammate (boolean, optional): Filter agents published as teammates.

tags (list of strings, optional): Filter agents by associated tags.

paginated (boolean, optional): Toggle between paginated or full results.

page (int, optional): Page number (used if paginated=true).

items_per_page (int, optional): Items per page (used if paginated=true).

team_id (int, optional): Filter agents by team ID.

project_id (int, optional): Filter agents by project ID.

Returns:

A list of serialized agents based on applied filters.

Supports both paginated and unpaginated responses based on user preference.

If no agents are found or if an error occurs, returns an appropriate error response.

Current Version:

2.0.0

{ "success": true, "message": "string", "data": { "count": 0, "num_pages": 0, "current_page": 0, "agents": [ { "id": 0, "user": { "id": 0, "email": "[email protected]", "first_name": "string", "last_name": "string", "organization": 0 }, "agent_type": { "id": 0, "created_by": "string", "created_on": "2019-08-24T14:15:22Z", "modified_by": "string", "modified_on": "2019-08-24T14:15:22Z", "name": "string", "description": "string" }, "instructions": [ { "id": 0, "instruction": "string", "is_deleted": true, "created_by": "string", "created_on": "2019-08-24T14:15:22Z", "agent": 0 } ], "project": { "id": 0, "project_name": "string", "team": { "id": 0, "team_name": "string" } }, "connected_tool_names": [ "string" ], "tags": [ "string" ], "character_voice": { "id": 0, "voice_name": "string", "voice_identifier": "string", "gender": "male" }, "pattern": { "id": 0, "name": "string", "description": "string" }, "agent_name": "string", "industry_area": "string", "domain": "string", "sample_q1": "string", "sample_q2": "string", "sample_q3": "string", "sample_q4": "string", "prefix_prompt": "string", "alias": "string", "is_active": true, "is_deleted": true, "created_by": "string", "created_on": "2019-08-24T14:15:22Z", "agent_image": "string", "access": "string", "status": "string", "caching_enabled": true, "chunk_count": -2147483648, "attachment_chunk_count": -2147483648, "attachment_chunking": true, "react_enabled": true, "react_max_iteration_count": -2147483648, "reasoning_mode": "react", "call_enabled": true, "is_published_as_teammate": true, "chat_count": -2147483648, "likes_count": -2147483648, "conversation_starter_enabled": true, "enable_embed": true, "llm_config": 0, "cloned_from": 0 } ] } }

Request

Responses