Skip to main content
POST
/
voices
/
design
Design Voices
curl --request POST \
  --url https://api.revring.ai/v1/voices/design \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "instruction": "<string>",
  "n": 2
}
'
{
  "data": {
    "candidates": [
      {
        "index": 123,
        "audioBase64": "<string>",
        "durationMs": 123,
        "sampleRate": 123
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

Body

application/json
instruction
string
required

A description of the voice you want (1 to 2000 characters), e.g. 'A warm, confident female voice with a natural American accent.'

n
integer
default:2

How many candidate voices to generate

Required range: 1 <= x <= 4

Response

Generated voice candidates

data
object