Hear the voice say a word or one of its versions

POST/assistants/{id}/pronunciations/say

Returns the assistant's voice saying text exactly as sent, without applying any of its pronunciations: the word as written is how callers hear it before one is set.

Request

curl -X POST "https://www.getrevox.com/api/assistants/3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e34/pronunciations/say" \
  -H "Authorization: Bearer $REVOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Swile" }'

const res = await fetch("https://www.getrevox.com/api/assistants/3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e34/pronunciations/say", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.REVOX_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    text: "Swile",
  }),
});
const data = await res.json();
console.log(data);

import os

import requests

response = requests.post(
    "https://www.getrevox.com/api/assistants/3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e34/pronunciations/say",
    headers={"Authorization": f"Bearer {os.environ['REVOX_API_KEY']}"},
    json={
        "text": "Swile",
    },
    timeout=30,
)
response.raise_for_status()
print(response.json())

Try itSend this request live

Response

Success

{ "audio_base64": "audio base64" }

{ "error": "Not found" }

Path parameters

idstringrequired
ID of the assistant, as returned by GET /assistants.

Request body

application/json

textstringrequired
What the voice says: the word as written (how callers hear it with no pronunciation), or a version of it (replacement of a pronunciation, or a suggested version's text).
Example "Swile"1 to 500 characters

Response

200

audio_base64string
The assistant's voice saying text exactly as sent, base64-encoded WAV.

Errors

404Not found in your organization{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }

Error bodies carry an error (or message) string; a 400 adds bodyErrors.issues. See Errors.