List all Tools with their enabled status for the given Agent

List all tools with their enabled status for the given agent.

Staging behaviour:

Pass agent_version=staging as a query parameter to list all tools with their enabled status for the staging version instead of the published agent.

Purpose:

Enables users to view all tools with their enabled status for a given agent.

Path Parameters:

agent_id (int): ID of the agent.

Query Parameters:

is_connected: Whether to filter tools by connection status. Accepts 'true' for connected tools and 'false' for disconnected tools. No is_connected will return all tools.

verbosity: The verbosity of the response. Accepts 'low', 'medium', 'high'. Default is 'medium'.

is_enabled: Whether to filter tools by enabled status. Accepts 'true' for enabled tools and 'false' for disabled tools. No is_enabled will return all tools.

paginated (optional): Whether to paginate the response.

page (optional): The page number to return.

items_per_page (optional): The number of items per page.

query (optional): The query to search for tools.

sort_by (optional): The field to sort the tools by. Default is 'created_on'. Options are 'modified_on', 'created_on', 'name', 'description', 'tool_type', 'is_enabled', 'is_default', 'created_by', 'connection'.

search (str): Search term to filter tools by name or description (case-insensitive substring match).

category (str): Filter by category name.

tool_classification (str): Filter by tool classification ('Internal' or 'External').

tool_type (str): Filter by tool type (rag, api, web_search, attachment, retriever, mcp).

Returns:

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

A 400 Bad Request error if the version is invalid.

A 500 Internal Server Error for any unexpected failures.

Current Version:

2.1.6

Changelog:

2.0.1: Added tool ordering by modified_on field

2.1.0: Added pagination support

2.1.1: Added query parameter to search for tools

2.1.2: Added sort_by parameter to sort the tools

2.1.3: Added category parameter to filter tools by category

2.1.4: Added tool_classification parameter to filter tools by tool classification

2.1.5: Added category, tool_classification, tool_type filters in logic alignment with organization endpoint

2.1.6: Modified is_enabled and is_connected filters to allow both true and false values

2.1.7: Added is_internal filter to filter tools by is_internal

curl --location --globoff 'https:///api/v2/agents//tools?category=undefined&include_internal=undefined&is_connected=undefined&is_enabled=undefined&items_per_page=undefined&page=undefined&paginated=undefined&query=undefined&search=undefined&sort_by=undefined&tool_classification=undefined&tool_type=undefined&verbosity=undefined' \ --header 'Ocp-Apim-Subscription-Key: ' \ --header 'Authorization: Bearer '

{ "success": true, "message": "string", "data": { "items": [ { "id": 0, "name": "string", "description": "string", "org": 0, "tool_type": "rag", "created_by": "string", "is_enabled": true, "is_default": true, "connection": true, "tool_classification": "string", "category": "string" } ], "meta": { "property1": "string", "property2": "string" } } }

List all Tools with their enabled status for the given Agent

Request

Responses