Dictionaries
Create a dictionary
Creates a new speech-recognition dictionary for the partner. Terms are normalized server-side: whitespace is trimmed, empty/whitespace-only entries are dropped, non-string entries are silently skipped, and the dedupe is case-insensitive but preserves first-occurrence casing. A blank description is stored as null. Dictionary names must be unique per partner.
POST
/
dictionaries
Create a dictionary
curl --request POST \
--url https://api.vocobase.com/api/v2/dictionaries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Vocobase Product Catalog",
"description": "Product names, SKUs, and plan tiers referenced on support calls.",
"terms": [
"Vocobase",
"SKU-4471",
"Pro Annual Plan",
"Voice Sandbox",
"Meera Iyer"
]
}
'import requests
url = "https://api.vocobase.com/api/v2/dictionaries"
payload = {
"name": "Vocobase Product Catalog",
"description": "Product names, SKUs, and plan tiers referenced on support calls.",
"terms": ["Vocobase", "SKU-4471", "Pro Annual Plan", "Voice Sandbox", "Meera Iyer"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Vocobase Product Catalog',
description: 'Product names, SKUs, and plan tiers referenced on support calls.',
terms: ['Vocobase', 'SKU-4471', 'Pro Annual Plan', 'Voice Sandbox', 'Meera Iyer']
})
};
fetch('https://api.vocobase.com/api/v2/dictionaries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vocobase.com/api/v2/dictionaries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Vocobase Product Catalog',
'description' => 'Product names, SKUs, and plan tiers referenced on support calls.',
'terms' => [
'Vocobase',
'SKU-4471',
'Pro Annual Plan',
'Voice Sandbox',
'Meera Iyer'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vocobase.com/api/v2/dictionaries"
payload := strings.NewReader("{\n \"name\": \"Vocobase Product Catalog\",\n \"description\": \"Product names, SKUs, and plan tiers referenced on support calls.\",\n \"terms\": [\n \"Vocobase\",\n \"SKU-4471\",\n \"Pro Annual Plan\",\n \"Voice Sandbox\",\n \"Meera Iyer\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vocobase.com/api/v2/dictionaries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Vocobase Product Catalog\",\n \"description\": \"Product names, SKUs, and plan tiers referenced on support calls.\",\n \"terms\": [\n \"Vocobase\",\n \"SKU-4471\",\n \"Pro Annual Plan\",\n \"Voice Sandbox\",\n \"Meera Iyer\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/dictionaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Vocobase Product Catalog\",\n \"description\": \"Product names, SKUs, and plan tiers referenced on support calls.\",\n \"terms\": [\n \"Vocobase\",\n \"SKU-4471\",\n \"Pro Annual Plan\",\n \"Voice Sandbox\",\n \"Meera Iyer\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "d1234567-abcd-1234-abcd-123456789012",
"name": "Vocobase Product Catalog",
"description": "Product names, SKUs, and plan tiers referenced on support calls.",
"terms": [
"Vocobase",
"SKU-4471",
"Pro Annual Plan",
"Voice Sandbox",
"Meera Iyer"
],
"term_count": 5,
"char_count": 52,
"attached_agent_count": 0,
"created_at": "2026-04-24T10:30:00.000Z",
"updated_at": "2026-04-24T10:30:00.000Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "agent_name is required and must be max 50 characters"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "DICTIONARY_NAME_TAKEN",
"message": "A dictionary with this name already exists."
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}Authorizations
API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.
Body
application/json
Previous
Get a dictionaryReturns the full detail for a single dictionary, including the `terms` array.
Next
⌘I
Create a dictionary
curl --request POST \
--url https://api.vocobase.com/api/v2/dictionaries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Vocobase Product Catalog",
"description": "Product names, SKUs, and plan tiers referenced on support calls.",
"terms": [
"Vocobase",
"SKU-4471",
"Pro Annual Plan",
"Voice Sandbox",
"Meera Iyer"
]
}
'import requests
url = "https://api.vocobase.com/api/v2/dictionaries"
payload = {
"name": "Vocobase Product Catalog",
"description": "Product names, SKUs, and plan tiers referenced on support calls.",
"terms": ["Vocobase", "SKU-4471", "Pro Annual Plan", "Voice Sandbox", "Meera Iyer"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Vocobase Product Catalog',
description: 'Product names, SKUs, and plan tiers referenced on support calls.',
terms: ['Vocobase', 'SKU-4471', 'Pro Annual Plan', 'Voice Sandbox', 'Meera Iyer']
})
};
fetch('https://api.vocobase.com/api/v2/dictionaries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vocobase.com/api/v2/dictionaries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Vocobase Product Catalog',
'description' => 'Product names, SKUs, and plan tiers referenced on support calls.',
'terms' => [
'Vocobase',
'SKU-4471',
'Pro Annual Plan',
'Voice Sandbox',
'Meera Iyer'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vocobase.com/api/v2/dictionaries"
payload := strings.NewReader("{\n \"name\": \"Vocobase Product Catalog\",\n \"description\": \"Product names, SKUs, and plan tiers referenced on support calls.\",\n \"terms\": [\n \"Vocobase\",\n \"SKU-4471\",\n \"Pro Annual Plan\",\n \"Voice Sandbox\",\n \"Meera Iyer\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vocobase.com/api/v2/dictionaries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Vocobase Product Catalog\",\n \"description\": \"Product names, SKUs, and plan tiers referenced on support calls.\",\n \"terms\": [\n \"Vocobase\",\n \"SKU-4471\",\n \"Pro Annual Plan\",\n \"Voice Sandbox\",\n \"Meera Iyer\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/dictionaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Vocobase Product Catalog\",\n \"description\": \"Product names, SKUs, and plan tiers referenced on support calls.\",\n \"terms\": [\n \"Vocobase\",\n \"SKU-4471\",\n \"Pro Annual Plan\",\n \"Voice Sandbox\",\n \"Meera Iyer\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "d1234567-abcd-1234-abcd-123456789012",
"name": "Vocobase Product Catalog",
"description": "Product names, SKUs, and plan tiers referenced on support calls.",
"terms": [
"Vocobase",
"SKU-4471",
"Pro Annual Plan",
"Voice Sandbox",
"Meera Iyer"
],
"term_count": 5,
"char_count": 52,
"attached_agent_count": 0,
"created_at": "2026-04-24T10:30:00.000Z",
"updated_at": "2026-04-24T10:30:00.000Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "agent_name is required and must be max 50 characters"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "DICTIONARY_NAME_TAKEN",
"message": "A dictionary with this name already exists."
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}