POST

Run Tool


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Runs a tool exposed by the service plugin.

Wix calls this method when Aria invokes one of the tools declared in the app's App Tools extension.

Wix passes the tool's response back to Aria, and presents the result to the Wix user in natural language.

Note: Wix doesn’t check if the payload matches your requestSchema before calling your service plugin. Handle missing or unexpected fields in your implementation. Learn more about requestSchema in App Tools extension.

Error handling: If your implementation returns an error or times out, Aria continues the conversation without the tool result.

Endpoint
POST
{DEPLOYMENT-URI}/v1/run-tool
Did this help?