Skip to content

List available built-in tools for function calling

GET
/api/v3/organizations/{organisation}/ai/tools

Retrieves all available built-in tools that can be used with function calling. These tools can be included in toolConfig when making AI inference requests. * * Available Built-in Tools: * - get_weather: Get current weather for a location using Open-Meteo API * - calculate: Perform basic mathematical calculations (add, subtract, multiply, divide) * - search_web: Search the web for information (mock implementation) * - generate_image: Generate images with Amazon Nova Canvas (async execution, 10-15s typical runtime) * * Use Cases: * - Discover available tools dynamically without hardcoding * - Get complete tool specifications including input schemas * - Build UI for tool selection * - Validate tool names before sending requests * * Dynamic Tool Discovery: * This endpoint enables clients to: * 1. Fetch all available tools on page load * 2. Display tool capabilities to users * 3. Filter tools based on user permissions * 4. Use allowedTools whitelist for security * * Alternative Endpoint: * - GET /ai/tools/names - Returns only tool names (faster, lighter response)

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

Responses

200

Available tools retrieved successfully

object
tools
required

Array of available tool specifications

Array<object>
object
toolSpec
object
name
string
get_weather
description
string
Get current weather for a location. Returns temperature, conditions, humidity, wind, and more.
inputSchema
object
json

JSON Schema defining function parameters

object
{
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "City name"
},
"unit": {
"type": "string",
"enum": [
"celsius",
"fahrenheit"
]
}
},
"required": [
"location"
]
}
count
required

Number of available tools

integer
4

403

Access denied

500

Failed to fetch tools