Skip to main content
GET
Get custom tool

Path Parameters

ai_agent_id
string
required
tool_id
string
required

Response

Successful Response

openai_tool
OpenAIFormatFunctionDefinition · object
required

OpenAI function definition containing the tool's interface specification

Example:
additional_tool_info
AdditionalCustomToolInfo · object
required

Complete configuration for the custom tool including API details

created_at
string<date-time>
required

Timestamp indicating when this custom tool was created

updated_at
string<date-time>
required

Timestamp indicating when this custom tool was last modified

tool_id
string

Unique identifier for the custom tool

tool_start_message
string | null

Optional message to display when the tool is started

tool_delayed_message
string | null

Optional message to display when the tool is delayed

tool_complete_message
string | null

Optional message to display when the tool is completed

tool_failed_message
string | null

Optional message to display when the tool fails