Transcribe rule text - Docs and guides

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>"
  }
}
'

{
  "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

Show child attributes

Response

200 - application/json

successful

transcription

string

language

string

Match rule textReturns pronunciation rules that match the given text.

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>"
  }
}
'

{
  "transcription": "<string>",
  "language": "<string>"
}