---
title: "Test API Tool connectivity and validate configuration."
method: POST
path: "/v1/voice-agents/web-tool/test-api-tool"
---

# Test API Tool connectivity and validate configuration.

`POST /v1/voice-agents/web-tool/test-api-tool`

Validates API connectivity with retry logic and streams real-time test results via Server-Sent Events.

## Request body

- TestApiToolRequest
  - `projectId` string, uuid, required — UUID of the project.
  - `apiKey` string, uuid — API key UUID (optional).
  - `userId` string, uuid — UUID of the user (optional).
  - `serverUrl` string, uri, required — The API endpoint URL to test. Must be a valid external URL.
  - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE', required — HTTP method to use for the API call.
  - `authPrefix` string — Authorization header prefix (e.g., 'Bearer', 'Basic').
  - `authToken` string — Authentication token to include in the request.
  - `timeout` number — Request timeout in seconds (1-15 seconds).
  - `httpHeaders` object — Custom HTTP headers to include in the request.
  - `queryParams` object — Query parameters to append to the URL.
  - `body` union — Request body (max 10MB). Can be string, number, boolean, object, array, or null.
    - string
    - number
    - boolean
    - object

## Response `200`

Server-Sent Events stream with test results

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Server Side Error

---

[API](https://skmtc.net/tryhamsa/apis/hamsa-api.md) · [All operations](https://skmtc.net/tryhamsa/apis/hamsa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tryhamsa/hamsa-api/versions/ecbeb5d8dc13/schema)