PUT
/
sdk
/
v1
/
tools
/
{id}
curl --request PUT \
  --url https://api.promptfoundry.ai/sdk/v1/tools/{id} \
  --header 'Content-Type: application/json'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "parameters": {}
}

Path Parameters

id
string
required

Body

application/json
name
string
required

The name of the tool to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

description
string
required

A description of what the tool does, used by the model to choose when and how to call the tool.

parameters
object
required

The parameters the functions accepts, described as a JSON Schema object. This schema is designed to match the TypeScript Record<string, unknown>, allowing for any properties with values of any type.

Response

200 - application/json
id
string
required

The initial messages to be included with your call to the LLM API.

name
string
required

The name of the tool to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

description
string
required

A description of what the tool does, used by the model to choose when and how to call the tool.

parameters
object
required

The parameters the functions accepts, described as a JSON Schema object. This schema is designed to match the TypeScript Record<string, unknown>, allowing for any properties with values of any type.

Get ToolDelete tool