API ReferenceTools

Execute tool

Execute a specific tool operation with provided arguments and authentication. This is the primary endpoint for integrating with third-party services and executing tools. You can provide structured arguments or use natural language processing by providing a text description of what you want to accomplish.

Path parameters

tool_slugstringRequired
The tool slug to execute

Headers

x-api-keystringRequired

Request

This endpoint expects an object.
connected_account_idstringOptional
Unique identifier for the connected account to use for authentication
user_idstringOptional

User id for multi-user connected accounts (e.g. multiple users, organizations)

versionstringOptional

Tool version to execute (defaults to “latest” if not specified)

custom_auth_paramsobjectOptional
Custom authentication parameters for tools that support parameterized authentication
argumentsmap from strings to anyOptional

Key-value pairs of arguments required by the tool (mutually exclusive with text)

textstringOptional

Natural language description of the task to perform (mutually exclusive with arguments)

allow_tracingbooleanOptional

Enable debug tracing for tool execution (useful for debugging)

Response

Successfully executed action and received response
datamap from strings to any
Tool execution output data that varies based on the specific tool
successfulboolean
Indicates if the tool execution was successful
errorstring or null

Error message if the tool execution was not successful (null if successful)

session_infoany or null
log_idstring or null

Unique identifier for the execution log (useful for debugging and support)

Errors