Replace entries
curl --request PUT \
--url https://api.withhopper.com/pronunciation-dicts/{id}/entries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entries": [
{
"grapheme": "<string>",
"alias": "<string>",
"phoneme": "<string>",
"case_sensitive": false
}
]
}
'import requests
url = "https://api.withhopper.com/pronunciation-dicts/{id}/entries"
payload = { "entries": [
{
"grapheme": "<string>",
"alias": "<string>",
"phoneme": "<string>",
"case_sensitive": False
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entries: [
{
grapheme: '<string>',
alias: '<string>',
phoneme: '<string>',
case_sensitive: false
}
]
})
};
fetch('https://api.withhopper.com/pronunciation-dicts/{id}/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.withhopper.com/pronunciation-dicts/{id}/entries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'entries' => [
[
'grapheme' => '<string>',
'alias' => '<string>',
'phoneme' => '<string>',
'case_sensitive' => false
]
]
]),
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.withhopper.com/pronunciation-dicts/{id}/entries"
payload := strings.NewReader("{\n \"entries\": [\n {\n \"grapheme\": \"<string>\",\n \"alias\": \"<string>\",\n \"phoneme\": \"<string>\",\n \"case_sensitive\": false\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.withhopper.com/pronunciation-dicts/{id}/entries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entries\": [\n {\n \"grapheme\": \"<string>\",\n \"alias\": \"<string>\",\n \"phoneme\": \"<string>\",\n \"case_sensitive\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withhopper.com/pronunciation-dicts/{id}/entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entries\": [\n {\n \"grapheme\": \"<string>\",\n \"alias\": \"<string>\",\n \"phoneme\": \"<string>\",\n \"case_sensitive\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"dict_id": "<string>",
"entries": [
{
"grapheme": "<string>",
"alias": "<string>",
"phoneme": "<string>",
"case_sensitive": false
}
]
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "Incorrect API key provided. Check your key at https://withhopper.com/dashboard.",
"type": "invalid_request_error",
"code": "invalid_api_key",
"param": null
}
}{
"error": {
"message": "You have run out of credits. Contact us to add more.",
"type": "insufficient_quota",
"code": "insufficient_quota",
"param": null
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "Rate limit reached: 600 requests per minute per key. Retry after 21s.",
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"param": null
}
}Pronunciation
Replace entries
Replaces the dictionary’s entries. Each entry maps a grapheme to exactly one of alias (whole-word text substitution, expanded at the gateway) or phoneme (passed to the model). Max 1,000 entries.
PUT
/
pronunciation-dicts
/
{id}
/
entries
Replace entries
curl --request PUT \
--url https://api.withhopper.com/pronunciation-dicts/{id}/entries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entries": [
{
"grapheme": "<string>",
"alias": "<string>",
"phoneme": "<string>",
"case_sensitive": false
}
]
}
'import requests
url = "https://api.withhopper.com/pronunciation-dicts/{id}/entries"
payload = { "entries": [
{
"grapheme": "<string>",
"alias": "<string>",
"phoneme": "<string>",
"case_sensitive": False
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entries: [
{
grapheme: '<string>',
alias: '<string>',
phoneme: '<string>',
case_sensitive: false
}
]
})
};
fetch('https://api.withhopper.com/pronunciation-dicts/{id}/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.withhopper.com/pronunciation-dicts/{id}/entries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'entries' => [
[
'grapheme' => '<string>',
'alias' => '<string>',
'phoneme' => '<string>',
'case_sensitive' => false
]
]
]),
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.withhopper.com/pronunciation-dicts/{id}/entries"
payload := strings.NewReader("{\n \"entries\": [\n {\n \"grapheme\": \"<string>\",\n \"alias\": \"<string>\",\n \"phoneme\": \"<string>\",\n \"case_sensitive\": false\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.withhopper.com/pronunciation-dicts/{id}/entries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entries\": [\n {\n \"grapheme\": \"<string>\",\n \"alias\": \"<string>\",\n \"phoneme\": \"<string>\",\n \"case_sensitive\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withhopper.com/pronunciation-dicts/{id}/entries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entries\": [\n {\n \"grapheme\": \"<string>\",\n \"alias\": \"<string>\",\n \"phoneme\": \"<string>\",\n \"case_sensitive\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"dict_id": "<string>",
"entries": [
{
"grapheme": "<string>",
"alias": "<string>",
"phoneme": "<string>",
"case_sensitive": false
}
]
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "Incorrect API key provided. Check your key at https://withhopper.com/dashboard.",
"type": "invalid_request_error",
"code": "invalid_api_key",
"param": null
}
}{
"error": {
"message": "You have run out of credits. Contact us to add more.",
"type": "insufficient_quota",
"code": "insufficient_quota",
"param": null
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"message": "Rate limit reached: 600 requests per minute per key. Retry after 21s.",
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"param": null
}
}Authorizations
API key in the Authorization header: Bearer sk_hopper_... Keys are minted in the dashboard at withhopper.com/console/keys and shown once at creation. WebSocket connections also accept ?api_key=.
Path Parameters
Pronunciation dictionary id.
Body
application/json
Maximum array length:
1000Show child attributes
Show child attributes
⌘I