API Reference
- POSTCompletion
- GETGet Prompt
- PUTUpdate Prompt
- POSTGet Model Parameters
- DELDelete Prompt
- GETList Prompts
- POSTCreate Prompt
- GETList tools
- POSTCreates tool
- GETGet Tool
- PUTUpdate tool
- DELDelete tool
- GETList Evaluation Assertions
- POSTCreate Evaluation Assertion
- GETGet Evaluation Assertion
- PUTUpdate Evaluation Assertion
- DELDelete Evaluation Assertion
- GETList Evaluations
- POSTCreate Evaluation
- GETGet Evaluation
- PUTUpdate Evaluation
- DELDelete Evaluation
API Reference
Creates tool
Data needed to create a new tool
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
Response
201
application/json
Successful operation
The response is of type object
.
Was this page helpful?
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": {}
}
Assistant
Responses are generated using AI and may contain mistakes.