Tool

Deprecate a tool

Deprecate the specified tool. All versions of the tool will be deprecated and the tool will no longer be used.

After the endpoint concludes, the deprecation will take around 1 minute to propagate across the system.

Permissions

This endpoint requires the following permissions:

Tool:DeleteTool on the tool to deprecate.

delete/v1/{organization}/tool/{tool_id}

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/:tool_id/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationstring required

tool_idstring required

The ID of the tool to deprecate.

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[]

Response

Succeeded.

Changes

No operation changes recorded.