v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

Test API Tool connectivity and validate configuration.

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

post/v1/voice-agents/web-tool/test-api-tool

Request body

projectIdstring uuid required

UUID of the project.

apiKeystring uuid

API key UUID (optional).

userIdstring uuid

UUID of the user (optional).

serverUrlstring 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.

authPrefixstring

Authorization header prefix (e.g., 'Bearer', 'Basic').

authTokenstring

Authentication token to include in the request.

timeoutnumber

Request timeout in seconds (1-15 seconds).

httpHeadersobject

Custom HTTP headers to include in the request.

queryParamsobject

Query parameters to append to the URL.

Example request

{
  "projectId": "d949f13f-40d2-4e48-ac86-b66633070603",
  "apiKey": "d949f13f-40d2-4e48-ac86-b66633070603",
  "userId": "d949f13f-40d2-4e48-ac86-b66633070603",
  "serverUrl": "https://api.example.com/endpoint",
  "method": "POST",
  "authPrefix": "Bearer",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "timeout": 5,
  "httpHeaders": {
    "Content-Type": "application/json",
    "X-Custom-Header": "value"
  },
  "queryParams": {
    "filter": "active",
    "limit": "10"
  }
}

Response

Server-Sent Events stream with test results