# Test Tool

> POST /api/v1/tools/{tool_uuid}/test — request parameters and responses from the Menace Voice API schema.

`POST /api/v1/tools/{tool_uuid}/test`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| tool_uuid | path | string | yes |  |
| authorization | header | string or null | no |  |
| X-API-Key | header | string or null | no |  |

### Request body: application/json

Required body. Schema: ToolTestRequest (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| llm_params | object | no | Values for parameters normally supplied by the model. |
| preset_params | object | no | Resolved values for parameters normally supplied from presets. |

### Response 200

Successful Response

application/json: ToolTestResponse (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| status | string | yes |  |
| status_code | integer or null | no |  |
| data | unspecified or null | no |  |
| error | string or null | no |  |
| hint | string or null | no |  |
| request_method | string | yes |  |
| request_url | string | yes |  |
| request_headers | object | no |  |
| request_body | object or null | no |  |
| request_params | object or null | no |  |
| duration_ms | integer | yes |  |

### Response 404

Not found

### Response 422

Validation Error

application/json: HTTPValidationError (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| detail | array of ValidationError (object) | no |  |

## OpenAPI

````yaml api-reference/openapi.json post /api/v1/tools/{tool_uuid}/test
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/tools/{tool_uuid}/test:
    post:
      tags:
        - main
      summary: Test Tool
      description: Execute an HTTP API tool with sample LLM and preset parameters.
      operationId: test_tool_api_v1_tools__tool_uuid__test_post
      parameters:
        - name: tool_uuid
          in: path
          required: true
          schema:
            type: string
            title: Tool Uuid
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ToolTestRequest"
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ToolTestResponse"
        "404":
          description: Not found
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ToolTestRequest:
      properties:
        llm_params:
          additionalProperties: true
          type: object
          title: Llm Params
          description: Values for parameters normally supplied by the model.
        preset_params:
          additionalProperties: true
          type: object
          title: Preset Params
          description: Resolved values for parameters normally supplied from presets.
      type: object
      title: ToolTestRequest
      description: Request body for testing an HTTP API tool outside a live call.
    ToolTestResponse:
      properties:
        status:
          type: string
          title: Status
        status_code:
          anyOf:
            - type: integer
            - type: "null"
          title: Status Code
        data:
          anyOf:
            - {}
            - type: "null"
          title: Data
        error:
          anyOf:
            - type: string
            - type: "null"
          title: Error
        hint:
          anyOf:
            - type: string
            - type: "null"
          title: Hint
        request_method:
          type: string
          title: Request Method
        request_url:
          type: string
          title: Request Url
        request_headers:
          additionalProperties:
            type: string
          type: object
          title: Request Headers
        request_body:
          anyOf:
            - additionalProperties: true
              type: object
            - type: "null"
          title: Request Body
        request_params:
          anyOf:
            - additionalProperties: true
              type: object
            - type: "null"
          title: Request Params
        duration_ms:
          type: integer
          title: Duration Ms
      type: object
      required:
        - status
        - request_method
        - request_url
        - duration_ms
      title: ToolTestResponse
      description: Result of testing an HTTP API tool.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
````