Sign in
Tool

Publish a new version of a tool

Publish a new version of the specified tool. After this endpoint finishes, the new version will be immediately available for use.

This endpoint will take roughly 1-5 minutes to complete, so please adjust the timeout settings of your HTTP client accordingly.

Permissions

This endpoint requires the following permissions:

  • Tool:ModifyTool for the tool.
post/v1/{organization}/tool/{tool_id}/version

Path parameters

organizationstring required
tool_idstring required

The ID of the tool to publish

The ID of the tool to publish

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.

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

project_pathstring required

The directory in the tools repo that contains the pyproject.toml file corresponding to the tool version to publish.

bump_type'major' | 'minor' | 'patch' required

The type of bump to apply to the version. For initial version of the tool, use major.

Response

Succeeded.

new_versionstring required

The new version of the tool.

Changes

No changes recorded. 1 of the 17 revisions has no diff computed, so it could not be searched.