Get all Tools in an Organization

GET

/api/v2/organizations/{organization_id}/tools

This endpoint allows clients to retrieve a list of all tools available in an organization.
It provides details about each tool, including its name, description, and status.

Path Parameters:

organization_id (int): The ID of the organization.

Query Parameters:

include_draft (str): Whether to include draft tools. Default is 'False'.

default (str): Whether to include default tools. Default is 'False'.

enabled (str): Whether to include enabled tools. Default is 'False'.

paginated (str): Whether to paginate the response. Default is 'True'.

page (int): In case of paginated response, the page number to return. Default is 1.

items_per_page (int): In case of paginated response, the number of items per page. Default is 50.

Returns:

A response containing a list of all tools in the organization.

Current Version:

2.0.0

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v2/organizations//tools' \
--header 'Ocp-Apim-Subscription-Key;'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "count": 0,
        "num_pages": 0,
        "current_page": 0,
        "tools": [
            {
                "id": 0,
                "name": "string",
                "description": "string",
                "org": 0,
                "tool_type": "rag",
                "created_by": "string",
                "is_enabled": true,
                "is_default": true,
                "connection": true,
                "search_engine": "string",
                "search_engine_url": "string",
                "search_engine_key": "string",
                "top_k": 0,
                "include_domains": [
                    "string"
                ],
                "headers": {},
                "system_prompt": "",
                "base_template": 0,
                "n_attachments": 0
            }
        ]
    }
}

Request

Authorization

API Key

Add parameter in header

Ocp-Apim-Subscription-Key

Example:

Ocp-Apim-Subscription-Key: ********************

Path Params

Query Params

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Get the Model Deployment for an Organization

Disable a Tool for all Agents in an Organization