Skip to main content
POST
/
rules
/
preview
Preview rule audio
curl --request POST \
  --url https://api.beyondwords.io/v1/rules/preview \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "key": "CO2",
  "value": "carbon dioxide",
  "type": "substitute",
  "project": {
    "id": 1
  },
  "content": {
    "id": "d8414aee-4171-419e-be42-bd57e9e2ccd2"
  }
}
'
import requests

url = "https://api.beyondwords.io/v1/rules/preview"

payload = {
"key": "CO2",
"value": "carbon dioxide",
"type": "substitute",
"project": { "id": 1 },
"content": { "id": "d8414aee-4171-419e-be42-bd57e9e2ccd2" }
}
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({
key: 'CO2',
value: 'carbon dioxide',
type: 'substitute',
project: {id: 1},
content: {id: 'd8414aee-4171-419e-be42-bd57e9e2ccd2'}
})
};

fetch('https://api.beyondwords.io/v1/rules/preview', 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.beyondwords.io/v1/rules/preview",
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([
'key' => 'CO2',
'value' => 'carbon dioxide',
'type' => 'substitute',
'project' => [
'id' => 1
],
'content' => [
'id' => 'd8414aee-4171-419e-be42-bd57e9e2ccd2'
]
]),
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.beyondwords.io/v1/rules/preview"

payload := strings.NewReader("{\n \"key\": \"CO2\",\n \"value\": \"carbon dioxide\",\n \"type\": \"substitute\",\n \"project\": {\n \"id\": 1\n },\n \"content\": {\n \"id\": \"d8414aee-4171-419e-be42-bd57e9e2ccd2\"\n }\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.beyondwords.io/v1/rules/preview")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"CO2\",\n \"value\": \"carbon dioxide\",\n \"type\": \"substitute\",\n \"project\": {\n \"id\": 1\n },\n \"content\": {\n \"id\": \"d8414aee-4171-419e-be42-bd57e9e2ccd2\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/rules/preview")

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 \"key\": \"CO2\",\n \"value\": \"carbon dioxide\",\n \"type\": \"substitute\",\n \"project\": {\n \"id\": 1\n },\n \"content\": {\n \"id\": \"d8414aee-4171-419e-be42-bd57e9e2ccd2\"\n }\n}"

response = http.request(request)
puts response.read_body

Authorizations

X-Api-Key
string
header
required

Body

application/json
type
enum<string>

The rule type. Possible values are substitute, say_as_word, say_as_letter_sequence, ipa_transcription, pinyin_transcription, jyutping_transcription. Please note that not all voices support all rules

Available options:
substitute,
say_as_word,
say_as_letter_sequence,
ipa_transcription,
pinyin_transcription,
jyutping_transcription
key
string

The exact text to match in content when previewing this rule

value
string | null

Replacement text or phonetic transcription (depending on rule type)

project
object | null
content
object | null
language
object | null
preview_voice
object | null

Response

200

successful