Get all Tags grouped by Agent for a given Project or Organization

GET

/api/v2/agents/tags/grouped-by-agent

Retrieves all tags grouped by tag name, each with its list of agents (for a given project or organization).

Purpose:

Enables users to view all tags grouped by agent.

Query Parameters (all optional):

project_id (int): Filter agents by project ID.

org_id (int): Filter agents by organization ID.

team_id (int): Filter agents by team ID.

carousel_id (int): Filter agents by carousel ID.

published_as_teammate (bool): Filter agents published as teammates.

tag (str): Comma-separated list of exact tag names to filter on.

sort_by (str): Sort order for tag names. Use 'tag' (asc) or '-tag' (desc). Default is '-tag'.

paginated (bool): Enable pagination. Default is false.

page (int): Page number when paginated. Default is 1.

items_per_page (int): Number of items per page when paginated. Default is 20.

Returns:

A JSON response with the serialized agent tags data or an error message.

A 400 Bad Request error if the version and query parameters are invalid.

A 500 Internal Server Error for any unexpected failures.

Current Version:

2.0.0

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Success

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agents/tags/grouped-by-agent?carousel_id=&items_per_page=&org_id=&page=&paginated=&project_id=&published_as_teammate=&sort_by=&tag=&team_id=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "items": [
            {
                "tag": "string",
                "agents": [
                    {
                        "id": 0,
                        "created_by": "string",
                        "modified_by": "string",
                        "created_on": "2019-08-24T14:15:22.123Z",
                        "modified_on": "2019-08-24T14:15:22.123Z",
                        "user": {
                            "id": 0,
                            "email": "[email protected]",
                            "first_name": "string",
                            "last_name": "string",
                            "organization": 0
                        },
                        "agent_type": {
                            "id": 0,
                            "created_by": "string",
                            "modified_by": "string",
                            "created_on": "2019-08-24T14:15:22.123Z",
                            "modified_on": "2019-08-24T14:15:22.123Z",
                            "name": "string",
                            "description": "string",
                            "parent": 0
                        },
                        "instructions": [
                            {
                                "id": 0,
                                "created_by": "string",
                                "modified_by": "string",
                                "created_on": "2019-08-24T14:15:22.123Z",
                                "modified_on": "2019-08-24T14:15:22.123Z",
                                "instruction": "string",
                                "is_deleted": true,
                                "parent": 0,
                                "agent": 0
                            }
                        ],
                        "project": {
                            "id": 0,
                            "project_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"
                        },
                        "staging_agent_id": "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,
                        "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,
                        "langfuse_tracing_enabled": true,
                        "parent": 0,
                        "llm_config": 0,
                        "cloned_from": 0,
                        "voice_llm_config": 0
                    }
                ]
            }
        ],
        "meta": {
            "count": 0,
            "num_pages": 0,
            "current_page": 0
        }
    }
}

Get all Tags for a given Project or Organization

Agent Chat Threads