Skip to main content
POST
Get tool function parameters

Authorizations

Authorization
string
header
required

Headers

TR-Dataset
string<uuid>
required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Body

application/json

JSON request payload to get the parameters for a tool function

Request payload for getting the parameters of a tool function

tool_function
object
required

Function for a LLM tool call

Example:
audio_input
string | null

The base64 encoded audio input of the user message to attach to the topic and then generate an assistant message in response to.

image_url
string | null
deprecated

Image URL to attach to the message to generate the parameters for the tool function.

image_urls
string[] | null

Image URLs to attach to the message to generate the parameters for the tool function.

model
string | null

Model name to use for the completion. If not specified, this defaults to the dataset's model.

temperature
number<double> | null

Temperature to use for the completion. If not specified, this defaults to the dataset's temperature.

user_message_text
string | null

Text of the user's message to the assistant which will be used to generate the parameters for the tool function.

Response

A JSON object containing the parameters for the tool function

Response body for getting the parameters of a tool function

parameters
any | null

Parameters for the tool function.