Tool
Invoke a tool version
Invoke a specified tool version with the given input parameters.
Permissions
This endpoint requires the following permissions:
- Tool:InvokeTool for the tool to invoke.
post/v1/{organization}/tool/{tool_id}/version/{version}/invoke
Request
- Base URLhttps://api.amigo.ai
- AuthHTTP bearer and API key in header X-ORG-ID and HTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
organizationstring required
tool_idstring required
The ID of the tool to invoke
versionstring required
The version of the tool to invoke
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
Response
Succeeded
Changes
No operation changes recorded.