Custom tools

Execute a developer test for a custom tool

Requires tools:execute. Deprecated compatibility API; retained route, response shape and legacy scope. Migrate to test_http_action, actions:http:execute. Use actionId=http:<toolId>; diagnosticId=logId. New grants must be explicitly approved. No retirement date is assigned. See /api-docs/actions-api#tools-migration. Makes a real HTTP request; never retry automatically. Write-capable tests require confirmExternalEffects=true and the current configurationVersion. Obtain explicit user confirmation for this individual real HTTP request; never infer consent from management scopes or retry automatically. Missing/stale confirmation returns HTTP_TEST_CONFIRMATION_REQUIRED (403) before dispatch. Read-only tests do not require consent. This confirmation requirement also applies to deprecated Tools write tests: older clients must explicitly confirm and send configurationVersion. Explicit new Off mode returns ACTION_INACTIVE (403); historical inactive definitions without an explicit mode retain direct-test eligibility. No test endpoint for Sheets or collection actions; use Playground.

post/tools/{toolId}/test

Request

  • Base URL
    https://platform-api.visitoai.com/m2m/v1
  • Auth
    HTTP bearer

Path parameters

toolIdstring required

Request body

inputobject
confirmExternalEffectsboolean

Set true only after explicit user confirmation for this real write-capable HTTP test. Read-only tests do not require confirmation.

configurationVersionstring

Exact current configurationVersion from the tool configuration; required for write-capable tests.

Response

Tool test result. An invocation failure is represented by ok: false in this response.

okboolean required
outputobject
durationMsinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.