Skip to main content
POST
/
rules
/
transcribe
Transcribe rule text
curl --request POST \
  --url https://api.beyondwords.io/v1/rules/transcribe \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "text": "<string>",
  "type": "ipa",
  "language": {
    "code": "<string>"
  }
}
'
import requests

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

payload = {
"text": "<string>",
"type": "ipa",
"language": { "code": "<string>" }
}
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({text: '<string>', type: 'ipa', language: {code: '<string>'}})
};

fetch('https://api.beyondwords.io/v1/rules/transcribe', 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/transcribe",
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([
'text' => '<string>',
'type' => 'ipa',
'language' => [
'code' => '<string>'
]
]),
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/transcribe"

payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"type\": \"ipa\",\n \"language\": {\n \"code\": \"<string>\"\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/transcribe")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"type\": \"ipa\",\n \"language\": {\n \"code\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"text\": \"<string>\",\n \"type\": \"ipa\",\n \"language\": {\n \"code\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "transcription": "<string>",
  "language": "<string>"
}

Authorizations

X-Api-Key
string
header
required

Body

application/json
text
string

The text to be transcribed

type
enum<string> | null

The transcription type to generate (currently only ipa)

Available options:
ipa
language
object | null

Response

200 - application/json

successful

transcription
string
language
string