---
title: "Test a saved Voice AI API tool"
description: "Shared workspace limit is two active requests and ten starts per minute across all server instances.  Served by the separate Voice API. Requires verified workspace owner/admin membership and VOICE_AI_API_TOOLS enabled. Credentials never appear in responses."
---

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

Path: Channel Automation API › Workspaces

`POST /api/workspaces/{workspaceId}/voice-ai/tools/{toolId}/test`

Shared workspace limit is two active requests and ten starts per minute across all server instances.  Served by the separate Voice API. Requires verified workspace owner/admin membership and VOICE_AI_API_TOOLS enabled. Credentials never appear in responses.

## Authentication

- `BearerAuth`, http, header `Authorization`, format `JWT`

## Path parameters

- `workspaceId` (`post/api/workspaces/workspaceId/voice-ai/tools/toolId/test.path.workspaceId`; string, required)
- `toolId` (`post/api/workspaces/workspaceId/voice-ai/tools/toolId/test.path.toolId`; string, required)
  - format `uuid`

## Header parameters

- `Idempotency-Key` (`post/api/workspaces/workspaceId/voice-ai/tools/toolId/test.header.Idempotency-Key`; string, required) — Generate a fresh UUID for a new test; retain it when retrying an uncertain test request.
  - format `uuid`

## Request body

_Required._

- `version` (`post/api/workspaces/workspaceId/voice-ai/tools/toolId/test.version`; integer, optional) — Required current saved version for update, archive and test.
- `args` (`post/api/workspaces/workspaceId/voice-ai/tools/toolId/test.args`; object, optional) — Tool arguments; sends a real request using the saved tool and credential.

## Example request

```json
{
  "version": 0,
  "args": {}
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/tools/<toolId>/test' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  --data '
{
  "version": 0,
  "args": {}
}
'
```

### TypeScript

```typescript
const url = 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/tools/<toolId>/test';
const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Idempotency-Key': '497f6eca-6276-4993-bfeb-53cbbbba6f08',
    Authorization: 'Bearer <token>'
  },
  body: JSON.stringify({version: 0, args: {}})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/tools/<toolId>/test"

payload = {
    "version": 0,
    "args": {}
}
headers = {
    "Content-Type": "application/json",
    "Idempotency-Key": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Successful operation

### 400

Invalid request

### 401

Missing or invalid access token

### 403

Workspace admin required or feature disabled

### 404

Tool not found

### 409

Version, name or execution conflict

### 413

Request too large

### 429

Test rate limit exceeded

### 503

Storage or credential service unavailable


Source: https://developer.channelautomations.com/api/post-api-workspaces-workspace-id-voice-ai-tools-tool-id-test/index.md