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

# Test Http Tool

> Send an HTTP tool's request once with sample values, without saving it.

Returns what the agent would get back (``result``), the request as sent
with auth masked, the raw response, and the function schema the model
would see - everything the wizard shows on its test step.



## OpenAPI

````yaml /api-reference/openapi.en.json post /api/v1/tools/test-http
openapi: 3.1.0
info:
  title: Brosbots API
  description: >
    The public Brosbots REST API. Build and manage voice agents, run outbound

    campaigns, read calls and usage, and manage phone numbers, tools,

    knowledge bases and integrations.


    ## Authentication


    Every request must include your organization's API key in the

    `X-API-Key` header:


    ```

    X-API-Key: bb_live_...

    ```


    You create and revoke keys in the dashboard:

    click your account in the bottom-left corner of the sidebar, then **Brosbots
    API**.


    ## Base URL


    ```

    https://app.brosbots.com/api/v1

    ```


    ## Conventions


    - Request and response bodies are JSON (`Content-Type: application/json`).

    - Timestamps are ISO 8601 with a timezone.

    - Lists are paginated with `page` / `limit` parameters; responses include
      `total_count` / `total_pages`.
    - Errors use standard HTTP status codes with a JSON body:
      `{"detail": "a human-readable reason"}`.
    - `{agent_id}` accepts the agent's public ID (`agent_...`) or its number.


    ## Limits


    There is no fixed per-key request-rate limit today. `429` comes from the

    calling endpoints (`POST /agents/{agent_id}/calls` and

    `POST /triggers/{trigger_id}/calls`) when every outbound channel is busy;
    its `Retry-After` header says how many seconds to wait. Handle `429`

    generally: wait as long as `Retry-After` says, or back off exponentially
    when

    it is absent. A request-rate limit may be introduced.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
paths:
  /api/v1/tools/test-http:
    post:
      tags:
        - Tools
      summary: Test Http Tool
      description: |-
        Send an HTTP tool's request once with sample values, without saving it.

        Returns what the agent would get back (``result``), the request as sent
        with auth masked, the raw response, and the function schema the model
        would see - everything the wizard shows on its test step.
      operationId: post_tools_test_http
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestHttpToolRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestHttpToolResponse'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TestHttpToolRequest:
      properties:
        name:
          type: string
          maxLength: 255
          default: test
        description:
          anyOf:
            - type: string
            - type: 'null'
        config:
          $ref: '#/components/schemas/HttpApiConfig'
        arguments:
          additionalProperties: true
          type: object
        call_variables:
          additionalProperties: true
          type: object
          description: Stand-ins for call variables such as caller_number
      type: object
      required:
        - config
      title: TestHttpToolRequest
      description: A dry run of an HTTP tool that is not saved (the wizard's test step).
    TestHttpToolResponse:
      properties:
        result:
          additionalProperties: true
          type: object
        request:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
        response:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
        function_schema:
          additionalProperties: true
          type: object
      type: object
      required:
        - result
        - function_schema
      title: TestHttpToolResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
      title: HTTPValidationError
    HttpApiConfig:
      properties:
        method:
          type: string
          description: HTTP method (GET, POST, PUT, PATCH, DELETE)
        url:
          type: string
          description: Target URL
        headers:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          description: Static headers to include
        credential_uuid:
          anyOf:
            - type: string
            - type: 'null'
          description: ID of the stored credential used for authentication.
        parameters:
          anyOf:
            - items:
                $ref: '#/components/schemas/ToolParameter'
              type: array
            - type: 'null'
          description: Parameters that the tool accepts from LLM
        timeout_ms:
          anyOf:
            - type: integer
            - type: 'null'
          description: Request timeout in milliseconds
          default: 5000
        trigger_phrases:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: What callers say when this tool is the right one
        wait_message:
          anyOf:
            - type: string
            - type: 'null'
          description: Said to the caller while the request runs
        response_fields:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: Dotted paths of the response fields read back to the model
        error_message:
          anyOf:
            - type: string
            - type: 'null'
          description: What the agent tells the caller when the request fails
        template_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Wizard template the tool was created from
      type: object
      required:
        - method
        - url
      title: HttpApiConfig
      description: Configuration for HTTP API tools.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ToolParameter:
      properties:
        name:
          type: string
          description: Parameter name (used as key in request body)
        type:
          type: string
          description: 'Parameter type: string, number, or boolean'
        description:
          type: string
          description: Description of what this parameter is for
        required:
          type: boolean
          description: Whether this parameter is required
          default: true
      type: object
      required:
        - name
        - type
        - description
      title: ToolParameter
      description: A parameter that the tool accepts.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your organization's API key (account in the bottom-left of the dashboard
        → Brosbots API).

````

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