Sign in

Creates tool

Data needed to create a new tool

post/sdk/v1/tools

Request body

namestring 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.

descriptionstring required

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

parametersToolParameters 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

Successful operation

idstring required

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

namestring 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.

descriptionstring required

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

parametersToolParameters 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.

Changes

No recorded changes to this endpoint across all 50 revisions of this API.