Look up knowledge for a voice preview

Served by the standalone Voice API. Requires a Bearer session for a workspace owner/admin/manager when VOICE_AI_TELEPHONY_TURN_CONTROL_V2 is enabled. Legacy flag-off access is preserved. Existing route-specific validation still applies.

POST

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

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

workspaceId
string
required

Request body JSON

query
optional
string
Knowledge search question.
category
optional
string
Optional category.
limit
optional
integer
Requested result count; defaults to 3.

Returns

200

Successful operation

400

Invalid call or preview parameters

401

Missing or invalid session

403

Workspace owner/admin/manager required

404

Requested resource not found

409

Call is not in a state permitting this operation

500

Operation failed

503

Access verification or service unavailable

Look up knowledge for a voice preview

curl --request POST \
  --url 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/lookup-knowledge' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "string",
  "category": "string",
  "limit": 0
}
'

const url = 'https://api.channelautomation.com/api/workspaces/<workspaceId>/voice-ai/lookup-knowledge';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({query: 'string', category: 'string', limit: 0})
};

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/lookup-knowledge"

payload = {
    "query": "string",
    "category": "string",
    "limit": 0
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

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

print(response.text)