plugin.json

{
    "id": "tavilySearch",
    "version": "0.1.0",
    "uuid": "918b3f3d-a5f0-4645-bb04-7583ae6f4496",
    "emoji": "↗️",
    "title": "Tavily Search",
    "iconURL": "https://i.imgur.com/mNmig81.png",
    "openaiSpec": {
        "name": "tavilySearch",
        "parameters": {
            "type": "object",
            "required": [
                "query"
            ],
            "properties": {
                "query": {
                    "type": "string",
                    "description": "The search query to use. For example: 'Latest news on Nvidia stock performance'"
                }
            }
        },
        "description": "Get information on recent events from the web."
    },
    "outputType": "respond_to_ai",
    "userSettings": [
        {
            "name": "tavilyAPIKey",
            "type": "password",
            "label": "Tavily API Key",
            "required": true,
            "description": "Your Tavily API Key for authentication."
        },
        {
            "name": "search_depth",
            "type": "enum",
            "label": "Search Depth",
            "values": [
                "basic",
                "advanced"
            ],
            "description": "Optional, default: \"basic\". Determines the depth of the search.",
            "defaultValue": "basic"
        },
        {
            "name": "topic",
            "type": "enum",
            "label": "Search Topic",
            "values": [
                "general",
                "news"
            ],
            "description": "Optional, default: \"general\". Specifies the search category.",
            "defaultValue": "general"
        },
        {
            "name": "days",
            "type": "number",
            "label": "Days",
            "description": "Optional, only applicable for 'news' topic. Default is 3 days back.",
            "defaultValue": 3
        },
        {
            "name": "time_range",
            "type": "enum",
            "label": "Time Range",
            "values": [
                "day",
                "week",
                "month",
                "year",
                "d",
                "w",
                "m",
                "y"
            ],
            "description": "Optional, filter search results by time range. Default is no filter.",
            "defaultValue": null
        },
        {
            "name": "max_results",
            "type": "number",
            "label": "Max Results",
            "description": "Optional, default: 5. Maximum number of search results to return.",
            "defaultValue": 5
        },
        {
            "name": "include_images",
            "type": "enum",
            "label": "Include Images",
            "values": [
                "false",
                "true"
            ],
            "description": "Optional, default: false. Include query-related images in the response.",
            "defaultValue": "false"
        },
        {
            "name": "include_image_descriptions",
            "type": "enum",
            "label": "Include Image Descriptions",
            "values": [
                "false",
                "true"
            ],
            "description": "Optional, default: false. Add descriptive text for each image when images are included.",
            "defaultValue": "false"
        },
        {
            "name": "include_answer",
            "type": "enum",
            "label": "Include Answer",
            "values": [
                "false",
                "basic",
                "advanced"
            ],
            "description": "Optional, default: false. Generate an answer based on search results: 'basic' for a quick answer or 'advanced' for detailed response.",
            "defaultValue": "false"
        },
        {
            "name": "include_raw_content",
            "type": "enum",
            "label": "Include Raw Content",
            "values": [
                "false",
                "true"
            ],
            "description": "Optional, default: false. Include cleaned and parsed HTML content of each search result.",
            "defaultValue": "false"
        },
        {
            "name": "include_domains",
            "type": "text",
            "label": "Include Domains",
            "description": "Optional. A list of domains to specifically include in the search results.",
            "placeholder": "Comma-separated list of domains"
        },
        {
            "name": "exclude_domains",
            "type": "text",
            "label": "Exclude Domains",
            "description": "Optional. A list of domains to specifically exclude from the search results.",
            "placeholder": "Comma-separated list of domains"
        }
    ],
    "authenticationType": "AUTH_TYPE_API_KEY",
    "implementationType": "javascript"
}