POST
/
sdk
/
v1
/
tools
import PromptFoundry from '@prompt-foundry/typescript-sdk';

const client = new PromptFoundry({
  apiKey: process.env['PROMPT_FOUNDRY_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const tool = await client.tools.create({
    description: 'description',
    name: 'name',
    parameters: { foo: 'bar' },
  });

  console.log(tool.id);
}

main();
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "parameters": {}
}

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

201
application/json
Successful operation
​
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.

Was this page helpful?

Suggest editsRaise issue