Tool

Create a new tool

Create a new tool. The tool will not contain any versions initially so is not usable until at least one version is published.

Permissions

This endpoint requires the following permissions:

Tool:CreateTool for the tool to create.

post/v1/{organization}/tool/

Request

Base URL
https://api.amigo.ai
Auth
HTTP bearer and API key in header X-ORG-ID and HTTP basic
TypeScript
https://skmtc.dev/amigo/apis/amigo-api/docs/v1/:organization/tool/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

namestring required

descriptionstring required

tagsobject required

The tags of this tool.

Response

Succeeded.

idstring required

The ID of the tool.

Changes

No operation changes recorded.