# System Tool Object

div
strong
🔨 In Development
 — This section is still being developed and may change.


Represents a built-in Freddy AI system tool with its configuration options and capabilities.

## Properties

**`id`** string

Unique identifier for the system tool. Format: `tool_` followed by alphanumeric characters.

**`name`** string

Human-readable name for the tool (e.g., "Web Search", "Code Interpreter").

**`description`** string

Detailed description of what the tool does and its capabilities.

**`category`** string

Tool category classification. Values: `search`, `computation`, `generation`, `automation`, `analysis`.

**`toolKey`** string

The configuration key used in assistant toolConfigurations. Example: `webSearch`, `codeInterpreter`.

**`capabilities`** object

Technical capabilities and features of this tool.

details
summary
Show capabilities
**`modes`** array of strings

Available configuration modes. Values: `on`, `off`, `auto`.

**`parameters`** array of objects

Available configuration parameters for this tool.

details
summary
Show parameter structure
**`name`** string

Parameter name (e.g., "sources", "outputs").

**`type`** string

Parameter data type (e.g., "boolean", "string", "integer").

**`default`** any

Default value for the parameter.

**`description`** string

Description of what the parameter controls.

**`modelCompatibility`** object

Which model types this tool is compatible with.

details
summary
Show model compatibility
**`text`** boolean

Compatible with text-only models.

**`vision`** boolean

Compatible with vision-capable models.

**`voice`** boolean

Compatible with voice models.

**`multimodal`** boolean

Compatible with multimodal models.

**`isPreview`** boolean

Whether this tool is in preview/beta status.

**`pricing`** object optional

Pricing information for tool usage.

details
summary
Show pricing
**`costPerUse`** number optional

Cost per tool execution.

**`freeTier`** integer optional

Number of free uses per month.

**`createdAt`** integer

Unix timestamp (seconds) when the tool was created.

**`updatedAt`** integer

Unix timestamp (seconds) when the tool was last updated.

## Returns

A [ApiResponse](#apiresponse) object containing the API response data.

## Example System Tools

Web Search Tool

```json
{
  "id": "tool_web_search",
  "name": "Web Search",
  "description": "Real-time web search capabilities for current information and research.",
  "category": "search",
  "toolKey": "webSearch",
  "capabilities": {
    "modes": ["on", "off", "auto"],
    "parameters": [
      {
        "name": "sources",
        "type": "boolean",
        "default": true,
        "description": "Include source URLs and metadata in search results"
      }
    ],
    "modelCompatibility": {
      "text": true,
      "vision": true,
      "voice": true,
      "multimodal": true
    }
  },
  "isPreview": false,
  "pricing": {
    "costPerUse": 0.001,
    "freeTier": 1000
  },
  "createdAt": 1728057600,
  "updatedAt": 1728057600
}
```

Code Interpreter Tool

```json
{
  "id": "tool_code_interpreter",
  "name": "Code Interpreter",
  "description": "Python code execution environment for computational tasks and data analysis.",
  "category": "computation",
  "toolKey": "codeInterpreter",
  "capabilities": {
    "modes": ["on", "off", "auto"],
    "parameters": [
      {
        "name": "outputs",
        "type": "boolean",
        "default": true,
        "description": "Include execution outputs and generated files in responses"
      }
    ],
    "modelCompatibility": {
      "text": true,
      "vision": false,
      "voice": false,
      "multimodal": true
    }
  },
  "isPreview": false,
  "pricing": {
    "costPerUse": 0.01,
    "freeTier": 100
  },
  "createdAt": 1728057600,
  "updatedAt": 1728057600
}
```

Image Generation Tool

```json
{
  "id": "tool_image_generation",
  "name": "Image Generation",
  "description": "AI-powered image creation and manipulation using various providers.",
  "category": "generation",
  "toolKey": "imageGeneration",
  "capabilities": {
    "modes": ["on", "off", "auto"],
    "parameters": [
      {
        "name": "provider",
        "type": "string",
        "default": "openai",
        "description": "Image generation provider (openai, clipdrop)"
      }
    ],
    "modelCompatibility": {
      "text": true,
      "vision": true,
      "voice": false,
      "multimodal": true
    }
  },
  "isPreview": false,
  "pricing": {
    "costPerUse": 0.1,
    "freeTier": 10
  },
  "createdAt": 1728057600,
  "updatedAt": 1728057600
}
```