agents
agents.test
conversations
events
custom_messages
prompts
session_labels
sessions.transcript
channels.targets
Create Tool
Create a new tool
The name of the tool
The definition of the tool
The action to take when GPT calls the tool.
The tool definition to be used by the OpenAI API.
Always function
.
The tool definition including the JSON Schema of its parameters.
The name of the function/tool call.
The description of the tool.
The JSON Schema of parameters of the function/tool call.
The configuration for an HTTP API call.
The endpoint URL of the external service to call.
The HTTP method to use for the service call.
How to pass the arguments to the request.
The default values for the parameters of the function/tool call.
The optional result of the tool call. Only used for context
tools.
The service this tool belongs to
Authorizations
Body
The name of the tool
The definition of the tool
The tool definition to be used by the OpenAI API.
The tool definition including the JSON Schema of its parameters.
Always function
.
"function"
The action to take when GPT calls the tool.
action
, endpoint
, context
, log
The configuration for an HTTP API call.
The endpoint URL of the external service to call.
The HTTP method to use for the service call.
get
, post
How to pass the arguments to the request.
body
, form
, path
, query
The default values for the parameters of the function/tool call.
The optional result of the tool call. Only used for context
tools.
The service this tool belongs to
Response
The name of the tool
The definition of the tool
The tool definition to be used by the OpenAI API.
The tool definition including the JSON Schema of its parameters.
Always function
.
"function"
The action to take when GPT calls the tool.
action
, endpoint
, context
, log
The configuration for an HTTP API call.
The endpoint URL of the external service to call.
The HTTP method to use for the service call.
get
, post
How to pass the arguments to the request.
body
, form
, path
, query
The default values for the parameters of the function/tool call.
The optional result of the tool call. Only used for context
tools.
The service this tool belongs to
The ID of the tool
The name of the service this tool belongs to