Create a Voice AI API tool

Served by the separate Voice API. Requires verified workspace owner/admin membership and VOICE_AI_API_TOOLS enabled. Credentials never appear in responses.

POST

https://api.channelautomation.com/api/workspaces/{workspaceId}/voice-ai/tools

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

workspaceId
string
required

Request body JSON required

version
optional
integer
Required current saved version for update, archive and test.
definition
optional
object
Validated HTTP tool definition with typed parameters and request/result mappings.
enabled
optional
boolean
default: false
credential
optional
string
format: password
clearCredential
optional
boolean
default: false

Returns

201

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

Create a Voice AI API tool

curl --request POST \
  --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/tools' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 0,
  "definition": {},
  "enabled": false,
  "credential": "pa$$word",
  "clearCredential": false
}
'

const url = 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/tools';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    version: 0,
    definition: {},
    enabled: false,
    credential: 'pa$$word',
    clearCredential: false
  })
};

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

import requests

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

payload = {
    "version": 0,
    "definition": {},
    "enabled": False,
    "credential": "pa$$word",
    "clearCredential": False
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

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

print(response.text)