Share via


ItemCustomToolCallOutput interface

The output of a custom tool call from your code, being sent back to the model.

Extends

Properties

call_id

The call ID, used to map this custom tool call output to a custom tool call.

id

The unique ID of the custom tool call output in the OpenAI platform.

output

The output from the custom tool call generated by your code. Can be a string or an list of output content.

type

The type of the custom tool call output. Always custom_tool_call_output.

Property Details

call_id

The call ID, used to map this custom tool call output to a custom tool call.

call_id: string

Property Value

string

id

The unique ID of the custom tool call output in the OpenAI platform.

id?: string

Property Value

string

output

The output from the custom tool call generated by your code. Can be a string or an list of output content.

output: string | FunctionAndCustomToolCallOutputUnion[]

Property Value

type

The type of the custom tool call output. Always custom_tool_call_output.

type: "custom_tool_call_output"

Property Value

"custom_tool_call_output"