curl --request POST \
--url https://api.voxnexus.ai/v1/tts/intervention/entries \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"pattern": "<string>",
"intervention_group_id": "default",
"match_type": "literal",
"action": "replace",
"lang": "und",
"replacement": "<string>",
"case_sensitive": true,
"whole_word": true,
"priority": 0,
"status": "draft",
"note": ""
}
'import requests
url = "https://api.voxnexus.ai/v1/tts/intervention/entries"
payload = {
"pattern": "<string>",
"intervention_group_id": "default",
"match_type": "literal",
"action": "replace",
"lang": "und",
"replacement": "<string>",
"case_sensitive": True,
"whole_word": True,
"priority": 0,
"status": "draft",
"note": ""
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pattern: '<string>',
intervention_group_id: 'default',
match_type: 'literal',
action: 'replace',
lang: 'und',
replacement: '<string>',
case_sensitive: true,
whole_word: true,
priority: 0,
status: 'draft',
note: ''
})
};
fetch('https://api.voxnexus.ai/v1/tts/intervention/entries', 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.voxnexus.ai/v1/tts/intervention/entries",
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([
'pattern' => '<string>',
'intervention_group_id' => 'default',
'match_type' => 'literal',
'action' => 'replace',
'lang' => 'und',
'replacement' => '<string>',
'case_sensitive' => true,
'whole_word' => true,
'priority' => 0,
'status' => 'draft',
'note' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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.voxnexus.ai/v1/tts/intervention/entries"
payload := strings.NewReader("{\n \"pattern\": \"<string>\",\n \"intervention_group_id\": \"default\",\n \"match_type\": \"literal\",\n \"action\": \"replace\",\n \"lang\": \"und\",\n \"replacement\": \"<string>\",\n \"case_sensitive\": true,\n \"whole_word\": true,\n \"priority\": 0,\n \"status\": \"draft\",\n \"note\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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.voxnexus.ai/v1/tts/intervention/entries")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pattern\": \"<string>\",\n \"intervention_group_id\": \"default\",\n \"match_type\": \"literal\",\n \"action\": \"replace\",\n \"lang\": \"und\",\n \"replacement\": \"<string>\",\n \"case_sensitive\": true,\n \"whole_word\": true,\n \"priority\": 0,\n \"status\": \"draft\",\n \"note\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voxnexus.ai/v1/tts/intervention/entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pattern\": \"<string>\",\n \"intervention_group_id\": \"default\",\n \"match_type\": \"literal\",\n \"action\": \"replace\",\n \"lang\": \"und\",\n \"replacement\": \"<string>\",\n \"case_sensitive\": true,\n \"whole_word\": true,\n \"priority\": 0,\n \"status\": \"draft\",\n \"note\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"intervention_group_id": "default",
"match_type": "literal",
"action": "replace",
"lang": "und",
"pattern": "<string>",
"replacement": "<string>",
"case_sensitive": true,
"whole_word": true,
"priority": 0,
"status": "draft",
"note": "",
"id": 2,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}Create a pronunciation rule
curl --request POST \
--url https://api.voxnexus.ai/v1/tts/intervention/entries \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"pattern": "<string>",
"intervention_group_id": "default",
"match_type": "literal",
"action": "replace",
"lang": "und",
"replacement": "<string>",
"case_sensitive": true,
"whole_word": true,
"priority": 0,
"status": "draft",
"note": ""
}
'import requests
url = "https://api.voxnexus.ai/v1/tts/intervention/entries"
payload = {
"pattern": "<string>",
"intervention_group_id": "default",
"match_type": "literal",
"action": "replace",
"lang": "und",
"replacement": "<string>",
"case_sensitive": True,
"whole_word": True,
"priority": 0,
"status": "draft",
"note": ""
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pattern: '<string>',
intervention_group_id: 'default',
match_type: 'literal',
action: 'replace',
lang: 'und',
replacement: '<string>',
case_sensitive: true,
whole_word: true,
priority: 0,
status: 'draft',
note: ''
})
};
fetch('https://api.voxnexus.ai/v1/tts/intervention/entries', 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.voxnexus.ai/v1/tts/intervention/entries",
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([
'pattern' => '<string>',
'intervention_group_id' => 'default',
'match_type' => 'literal',
'action' => 'replace',
'lang' => 'und',
'replacement' => '<string>',
'case_sensitive' => true,
'whole_word' => true,
'priority' => 0,
'status' => 'draft',
'note' => ''
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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.voxnexus.ai/v1/tts/intervention/entries"
payload := strings.NewReader("{\n \"pattern\": \"<string>\",\n \"intervention_group_id\": \"default\",\n \"match_type\": \"literal\",\n \"action\": \"replace\",\n \"lang\": \"und\",\n \"replacement\": \"<string>\",\n \"case_sensitive\": true,\n \"whole_word\": true,\n \"priority\": 0,\n \"status\": \"draft\",\n \"note\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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.voxnexus.ai/v1/tts/intervention/entries")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"pattern\": \"<string>\",\n \"intervention_group_id\": \"default\",\n \"match_type\": \"literal\",\n \"action\": \"replace\",\n \"lang\": \"und\",\n \"replacement\": \"<string>\",\n \"case_sensitive\": true,\n \"whole_word\": true,\n \"priority\": 0,\n \"status\": \"draft\",\n \"note\": \"\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voxnexus.ai/v1/tts/intervention/entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pattern\": \"<string>\",\n \"intervention_group_id\": \"default\",\n \"match_type\": \"literal\",\n \"action\": \"replace\",\n \"lang\": \"und\",\n \"replacement\": \"<string>\",\n \"case_sensitive\": true,\n \"whole_word\": true,\n \"priority\": 0,\n \"status\": \"draft\",\n \"note\": \"\"\n}"
response = http.request(request)
puts response.read_body{
"intervention_group_id": "default",
"match_type": "literal",
"action": "replace",
"lang": "und",
"pattern": "<string>",
"replacement": "<string>",
"case_sensitive": true,
"whole_word": true,
"priority": 0,
"status": "draft",
"note": "",
"id": 2,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}{
"error": "Invalid request parameters",
"code": "INVALID_REQUEST",
"details": "Detailed error information",
"request_id": "req_1234567890"
}Authorizations
Authenticate using X-Api-Key header
Query Parameters
Used only to resolve the provider; rules belong to the authenticated user.
Used only to resolve the provider; rules belong to the authenticated user.
Used only to resolve the provider; rules belong to the authenticated user.
Select a group owned by the authenticated user. For GET, PATCH, and DELETE, omission selects default. For POST, query or body may select the group; both must match if supplied, and omission of both selects default. PATCH and DELETE verify that the rule belongs to this group. Opaque group ID owned by the authenticated user; default is the built-in group. Use the ID returned by group creation.
1 - 64^[A-Za-z0-9_-]+$"default"
Body
Literal patterns allow up to 64 characters; regex patterns allow up to 256.
1 - 256Optional group selection. If query and body both specify a group they must match; defaults to default when both are omitted.
1 - 64^[A-Za-z0-9_-]+$"default"
literal, regex replace, phoneme, spellout Canonical rule language in BCP 47 language[-Script]. Region aliases normalize to their language scope; zh is Chinese of any script, zh-Hans and zh-Hant restrict the script, and und means any language by product convention.
64Required and nonempty for replace or phoneme; must be null or omitted for spellout. Regex rules cannot use phoneme.
256Applies only to literal rules. For regex, specify case handling in the pattern.
Applies only to literal rules. For regex, specify boundaries in the pattern.
-32768 <= x <= 32767draft, active, inactive 1024Response
Success
Group that owns this rule.
1 - 64^[A-Za-z0-9_-]+$"default"
literal, regex replace, phoneme, spellout Canonical rule language in BCP 47 language[-Script]. Region aliases normalize to their language scope; zh is Chinese of any script, zh-Hans and zh-Hant restrict the script, and und means any language by product convention.
zh, zh-Hans, zh-Hant, en, fr, und 64Literal patterns allow up to 64 characters; regex patterns allow up to 256.
1 - 256Required and nonempty for replace or phoneme; must be null or omitted for spellout. Regex rules cannot use phoneme.
256Applies only to literal rules. For regex, specify case handling in the pattern.
Applies only to literal rules. For regex, specify boundaries in the pattern.
-32768 <= x <= 32767draft, active, inactive 1024x >= 1
