Skip to main content
POST
Create Tool

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Body

application/json

Configuration for an inline Python tool. The "code" field should contain a self-contained executable Python function. Example value of "code" string could be: def add( a: float, b: float, ) -> float: return float(a + b)

logical_id
string | null

Unique identifier for the tool

tool_id
string | null

Reference to the tool already created in the Workflow System. If not provided, the tool config is assumed to be provided inline here.

name
string | null

Name for the tool

description
string | null

Human friendly description for the tool (not used by AI)

category
string | null

Category for the tool. E.g math, ehr, etc

signature
string | null

Docstring or signature for the tool used by AI. If provided and there is a default signature already, it will override the default signature.

args_schema
Tool Arguments Schema · object | null

Schema for the arguments that the tool accepts. This should be a JSON schema dictionary. Information provided here will override any default arguments schema.

static_messages_config
StaticMessagesConfig · object | null

Static messages that an LLM node should emit while this tool is being invoked

result_runtime_variable_name
string | null
default:tool_result

Name of the runtime variable to store the result from this tool call

ignore_content_received_during_llm_tool_call_specification
boolean
default:false

If true, any free-text content the LLM returns in the same response as a call to this tool is ignored: not emitted via AssistantResponseEvent, not added to chat history, and not added to the node's structured output. When a response contains multiple tool calls, the text is ignored only if every tool call targets a tool for which this flag is set.

type
string
default:inline_python

Type of the tool. Must be 'inline_python'

Allowed value: "inline_python"
code
string | null

Python code to be executed by the tool. It should define a function with proper signature and descriptions for its parameters.

Response

Successful Response

Response model for a single tool. Contains a ToolsModel object.

tool
ToolsModel · object
required

Single tool object