> ## Documentation Index
> Fetch the complete documentation index at: https://docs.visitoai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Execute a developer test for a custom tool

> Requires `tools:execute`.



## OpenAPI

````yaml /openapi.json post /tools/{toolId}/test
openapi: 3.0.3
info:
  title: Visito M2M API
  version: 1.0.0
  description: >-
    Tenant-scoped server-to-server API for channels, conversations, commerce,
    custom AI tools, and WhatsApp templates. Send operations are asynchronous
    and return queued acknowledgements. Expansion adds conversation controls,
    knowledge, sales opportunities, delivery status, reporting, and signed
    webhooks.
servers:
  - url: https://platform-api.visitoai.com/m2m/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Channels
  - name: Conversations
  - name: Commerce
  - name: Custom tools
  - name: WhatsApp templates
  - name: Properties
  - name: Knowledge
  - name: Sales CRM
  - name: Delivery
  - name: Reporting
  - name: Webhooks
paths:
  /tools/{toolId}/test:
    post:
      tags:
        - Custom tools
      summary: Execute a developer test for a custom tool
      description: Requires `tools:execute`.
      operationId: testTool
      parameters:
        - $ref: '#/components/parameters/ToolId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolTestRequest'
      responses:
        '200':
          description: >-
            Tool test result. An invocation failure is represented by `ok:
            false` in this response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolTestResponse'
        default:
          $ref: '#/components/responses/Error'
components:
  parameters:
    ToolId:
      name: toolId
      in: path
      required: true
      schema:
        type: string
  schemas:
    ToolTestRequest:
      type: object
      properties:
        input:
          type: object
          additionalProperties: true
      additionalProperties: false
    ToolTestResponse:
      type: object
      required:
        - ok
        - durationMs
      properties:
        ok:
          type: boolean
        output:
          type: object
          additionalProperties: true
        error:
          $ref: '#/components/schemas/ToolInvocationError'
        durationMs:
          type: integer
    ToolInvocationError:
      type: object
      required:
        - code
        - message
        - retryable
      properties:
        code:
          type: string
        message:
          type: string
        retryable:
          type: boolean
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: M2M_AUTH_INSUFFICIENT_SCOPE
            message:
              type: string
            details:
              type: object
              additionalProperties: true
      example:
        error:
          code: M2M_AUTH_INSUFFICIENT_SCOPE
          message: M2M credential does not have required scope.
          details:
            requiredScopes:
              - conversations:write
            missingScopes:
              - conversations:write
  responses:
    Error:
      description: Structured error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Visito M2M API key
      description: Server-side tenant-scoped credential created from Build > API Keys.

````