Set an agent's knowledge-base tags
curl --request PUT \ --url https://api.sipstack.com/api/v2/aura/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/kb \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "tags": [ "Billing", "billing", "onboarding " ] }'import requests
url = "https://api.sipstack.com/api/v2/aura/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/kb"
payload = { "tags": ["Billing", "billing", "onboarding "] }headers = { "x-api-key": "<x-api-key>", "Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())const url = 'https://api.sipstack.com/api/v2/aura/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/kb';const options = { method: 'PUT', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"tags":["Billing","billing","onboarding "]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}import axios from 'axios';
const options = { method: 'PUT', url: 'https://api.sipstack.com/api/v2/aura/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/kb', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, data: {tags: ['Billing', 'billing', 'onboarding ']}};
try { const { data } = await axios.request(options); console.log(data);} catch (error) { console.error(error);}Replaces the agent’s knowledge-base tag-set. Tags are normalized exactly
as in Switchboard (trimmed, lower-cased, de-duplicated, empties dropped),
so the API and GUI can never disagree on what a tag-set means. Requires
aura:write — an aura:read-only key gets 403 (checked before any
existence lookup, so it can’t be used to probe for agent ids). The
response echoes the stored tag-set.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Request Body required
Section titled “Request Body required ”Replaces the agent’s KB tag-set. Tags are normalized to match the Switchboard GUI: trimmed, lower-cased, de-duplicated, empties dropped.
object
Example
[ "Billing", "billing", "onboarding "]Responses
Section titled “ Responses ”The updated KB tag-set.
object
A voice agent’s knowledge-base tag-set. In-call retrieval only surfaces documents whose tags intersect this set.
object
Example
{ "data": { "tags": [ "billing", "onboarding" ] }}tags was missing or not an array of strings.
Inline error shape used by the messaging API and management endpoints.
object
Example
{ "success": false, "error": "Recipient phone number (to) is required"}Missing or invalid API key.
Inline error shape used by the messaging API and management endpoints.
object
Example
{ "success": false, "error": "Recipient phone number (to) is required"}The key is missing the aura:write scope.
Inline error shape used by the messaging API and management endpoints.
object
Example
{ "success": false, "error": "Recipient phone number (to) is required"}Voice agent not found in your organization.
Inline error shape used by the messaging API and management endpoints.
object
Example
{ "success": false, "error": "Recipient phone number (to) is required"}