CustomToolParam interface

A custom tool that processes input using a specified format. Learn more about custom tools

Properties

allowed_callers	The callers that may invoke this custom tool, either directly or programmatically.
async	Whether the tool response can be returned asynchronously versus immediately returned on next response creation.
defer_loading	Whether this tool should be deferred and discovered via tool search.
description	Optional description of the custom tool, used to provide more context.
format	The input format for the custom tool. Default is unconstrained text.
name	The name of the custom tool, used to identify it in tool calls.
type	The type of the custom tool. Always `custom`.

The callers that may invoke this custom tool, either directly or programmatically.

allowed_callers?: CallableToolAllowedCaller[]

Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

async?: boolean

boolean

Whether this tool should be deferred and discovered via tool search.

defer_loading?: boolean

boolean

Optional description of the custom tool, used to provide more context.

description?: string

string

The input format for the custom tool. Default is unconstrained text.

format?: CustomToolParamFormatUnion

The name of the custom tool, used to identify it in tool calls.

name: string

string

The type of the custom tool. Always custom.

type: "custom"

"custom"