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

# Test Tool

> Tests a tool by executing it with the provided parameters



## OpenAPI

````yaml post /api/tools/{tool_id}/test
openapi: 3.0.3
info:
  title: Ultravox
  version: 0.1.0
  description: API for the Ultravox service.
servers:
  - url: https://api.ultravox.ai
security: []
paths:
  /api/tools/{tool_id}/test:
    post:
      tags:
        - tools
      description: >-
        Test a tool by executing it with the provided parameters.


        Every property other than `authTokens` is treated as a value for one of
        the tool's dynamic parameters, matched by parameter name and sent in
        whichever location that parameter declares (query, path, header, or
        body). Properties that don't match a dynamic parameter are ignored. The
        tool's static and automatic parameters are filled in automatically, so
        they should not be supplied here.


        Only HTTP tools can be tested. Tools requiring an Ultravox call token
        are rejected, since no call exists to issue one against.
      operationId: tools_test_create
      parameters:
        - in: path
          name: tool_id
          schema:
            type: string
            format: uuid
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                authTokens:
                  type: object
                  additionalProperties:
                    type: string
                  description: >-
                    Values satisfying the tool's security requirements, keyed by
                    requirement name. Applied the same way as for a real call: a
                    headerApiKey requirement sends its value as the named
                    header, a queryApiKey requirement as the named query
                    parameter, and an httpAuth requirement as an Authorization
                    header prefixed with the requirement's scheme.
                  example:
                    myServiceApiKey: my-secret-value
              additionalProperties: true
      responses:
        default:
          content:
            '*/*':
              schema: {}
          description: ''
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.