Gradium
App · 20 actions
Generate and transcribe speech, design voices, and manage pronunciation dictionaries.
Actions
| Action | What it does |
|---|---|
| Clone a voice from an audio sample | Clone a voice from an audio sample. |
| Convert text to speech | Convert text to speech. |
| Create a pronunciation dictionary | Create a pronunciation dictionary. |
| Create a voice from a candidate | Create a voice from a candidate. |
| Delete a custom voice | Delete a custom voice. |
| Delete a pronunciation dictionary | Delete a pronunciation dictionary. |
| Delete a voice candidate | Delete a voice candidate. |
| Enhance a voice | Enhance a voice. |
| Generate voice candidates | Generate voice candidates. |
| Get a pronunciation dictionary | Get a pronunciation dictionary. |
| Get a voice | Get a voice. |
| Get credit balance | Get credit balance. |
| List available accents | List available accents. |
| List pronunciation dictionaries | List pronunciation dictionaries. |
| List voice candidates | List voice candidates. |
| List voices | List voices. |
| Localize a voice | Localize a voice. |
| Transcribe an audio file | Transcribe an audio file. |
| Update a custom voice | Update a custom voice. |
| Update a pronunciation dictionary | Update a pronunciation dictionary. |
Clone a voice from an audio sample
Clone a voice from an audio sample.
Inputs
- Audio file
audio_filetextRequired - Audio file.
- Name
nametextRequired - Name.
- Input format
input_formattext - Audio format. If omitted, inferred from the audio_file extension.
- Description
descriptiontext - Description.
- Language
languagetextRequired - Language spoken in the audio sample.One of:
en,fr,es,pt,de. - Start s
start_snumber - Start s.
- Enhance
enhancetrue/false - Enhance the new voice clone. Set to false to opt out of enhancement.
- Timeout s
timeout_snumber - Timeout s.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"error": "example",
"uid": "example",
"was_updated": true
}
}Convert text to speech
Convert text to speech.
Inputs
- Text
texttextRequired - Text.
- Voice
voice_idtextRequired - Voice id.
- Output format
output_formattextRequired - Output format.One of:
wav,opus,pcm,ulaw_8000(Ulaw 8000),mulaw_8000(Mulaw 8000),alaw_8000(Alaw 8000),pcm_8000(Pcm 8000),pcm_16000(Pcm 16000),pcm_22050(Pcm 22050),pcm_24000(Pcm 24000),pcm_44100(Pcm 44100),pcm_48000(Pcm 48000).
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"content_base64": "example",
"content_type": "example"
}
}Create a pronunciation dictionary
Create a pronunciation dictionary.
Inputs
- Name
nametextRequired - Name.
- Description
descriptiontext - Description.
- Language
languagetextRequired - Language.One of:
en,fr,es,pt,de. - Rules
ruleslist - Rules.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"created_at": "example",
"description": "example",
"language": "example",
"name": "example",
"org_uid": "example",
"rules": [
{
"case_sensitive": true,
"id": 1,
"original": "example",
"rewrite": "example"
}
],
"uid": "example"
}
}Create a voice from a candidate
Create a voice from a candidate.
Inputs
- Voxium embedding ID
voxium_embedding_idtextRequired - Id of the candidate to keep, as returned by `POST /voice-generator/generate`.
- Name
nametextRequired - A name for the voice.
- Description
descriptiontext - An optional description of the voice.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"description": "example",
"language": "example",
"name": "example",
"uid": "example"
}
}Delete a custom voice
Delete a custom voice.
Inputs
- Voice uid
voice_uidtextRequired - Voice uid.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {}
}Delete a pronunciation dictionary
Delete a pronunciation dictionary.
Inputs
- Dictionary
dictionary_idtextRequired - Dictionary id.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {}
}Delete a voice candidate
Delete a voice candidate.
Inputs
- Embedding ID
embedding_idtextRequired - Embedding id.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {}
}Enhance a voice
Enhance a voice.
Inputs
- Src voice
src_voicetextRequired - The voice to enhance: a voice id (your clone, a converted candidate or a flagship voice) or a `vox_emb_` candidate id. It keeps its language and is not modified.
- N samples
n_samplesnumber - Number of candidates to produce. All candidates in one request are variations of the same speaker.From 1 to 5.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"embeddings": [
{
"embedding_id": "example",
"expires_at": "example",
"ready": true
}
]
}
}Generate voice candidates
Generate voice candidates.
Inputs
- Prompt
prompttextRequired - The voice description, up to 500 characters. Must contain actual text, not only spaces.
- Language
languagetextRequired - Language the voice will speak. Shapes the accent and the delivery.One of:
en,fr,es,pt,de. - N samples
n_samplesnumber - Number of candidate voices to sample from the description. All candidates in one request are variations on the same character.From 1 to 5.
- JSON config
json_configobject - Advanced sampling options.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"embeddings": [
{
"embedding_id": "example",
"expires_at": "example",
"ready": true
}
]
}
}Get a pronunciation dictionary
Get a pronunciation dictionary.
Inputs
- Dictionary
dictionary_idtextRequired - Dictionary id.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"created_at": "example",
"description": "example",
"language": "example",
"name": "example",
"org_uid": "example",
"rules": [
{
"case_sensitive": true,
"id": 1,
"original": "example",
"rewrite": "example"
}
],
"uid": "example"
}
}Get a voice
Get a voice.
Inputs
- Voice uid
voice_uidtextRequired - Voice uid.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"description": "example",
"filename": "example",
"is_catalog": true,
"is_pro_clone": true,
"language": "example",
"name": "example",
"rank": 1,
"start_s": 1,
"tags": [
{
"category": "example",
"value": "example"
}
],
"uid": "example"
}
}Get credit balance
Get credit balance.
Inputs
None.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"allocated_credits": 1,
"billing_period": "example",
"next_rollover_date": "example",
"plan_name": "example",
"remaining_credits": 1
}
}List available accents
List available accents.
Inputs
None.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"languages": {}
}
}List pronunciation dictionaries
List pronunciation dictionaries.
Inputs
- Limit
limitnumber - Limit.From 0 to 1000.
- Offset
offsetnumber - Offset.At least 0.
- Language
languagetext - Language.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"dictionaries": [
{
"created_at": "example",
"description": "example",
"language": "example",
"name": "example",
"org_uid": "example",
"rules": [
{}
],
"uid": "example"
}
],
"total": 1
}
}List voice candidates
List voice candidates.
Inputs
- Embedding ID
embedding_idtext - Look up a single candidate by id. Omit to list all candidates.
- Skip
skipnumber - Skip.At least 0.
- Limit
limitnumber - Limit.From 1 to 1000.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"embeddings": [
{
"created_at": "example",
"edit_language_config": {
"accent": "example",
"gender": "male",
"src_language": "example",
"src_voice": "example",
"target_language": "example"
},
"embedding_id": "example",
"enhance_config": {
"src_language": "example",
"src_voice": "example"
},
"expires_at": "example",
"generate_config": {
"language": "example",
"prompt": "example"
},
"kind": "generate",
"language": "example",
"prompt": "example",
"ready": true
}
]
}
}List voices
List voices.
Inputs
- Skip
skipnumber - Skip.At least 0.
- Limit
limitnumber - Limit.At least 0.
- Include catalog
include_catalogtrue/false - Also return Gradium catalog voices. Your organization's own voices come first, then catalog voices by `rank`, lowest first, unranked last.
- Locale
localetext - Only voices of this locale, e.g. `en-nz` or `fr-fr`.
- Gender
gendertext - Only voices of this gender: `male`, `female` or `neutral`.
- Use case
use_casetext - Only voices tagged with this use case, e.g. `Customer Service`, `Conversational`, `Narration` or `Ads & Social Media`. URL-encode it (`Ads%20%26%20Social%20Media`).
Outputs
datalist- The response from Gradium.
Example output
{
"data": [
{
"description": "example",
"filename": "example",
"is_catalog": true,
"is_pro_clone": true,
"language": "example",
"name": "example",
"rank": 1,
"start_s": 1,
"tags": [
{
"category": "example",
"value": "example"
}
],
"uid": "example"
}
]
}Localize a voice
Localize a voice.
Inputs
- Src voice
src_voicetextRequired - The voice to localize: a voice id (your clone, a converted candidate or a flagship voice) or a `vox_emb_` candidate id. The source is not modified.
- Target language
target_languagetextRequired - Language the candidates will speak. May equal the source language: that is an accent change.One of:
en,fr,es,pt,de. - Accent
accenttext - One of the accents `GET /voice-generator/available-accents` lists for `target_language`, matched case-insensitively. Omitted: the first accent listed for that language.
- Gender
gendertext - Opens the edit caption. Omitted: the source voice's gender tag, or the gender of the source candidate's own localization, or no gender. Clones and converted voices carry no tag, so send it for them.One of:
male,female. - N samples
n_samplesnumber - Number of candidates to produce. All candidates in one request are variations of the same localized speaker.From 1 to 5.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"embeddings": [
{
"embedding_id": "example",
"expires_at": "example",
"ready": true
}
]
}
}Transcribe an audio file
Transcribe an audio file.
Inputs
- Audio
audiotextRequired - Audio.
- Language
languagetext - Language.One of:
en,fr,es,pt,de.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"events": [
{}
],
"transcript": "example"
}
}Update a custom voice
Update a custom voice.
Inputs
- Voice uid
voice_uidtextRequired - Voice uid.
- Name
nametext - Name.
- Description
descriptiontext - Description.
- Language
languagetext - Language.
- Start s
start_snumber - Start s.
- Tags
tagslist - Tags.
- Rank
ranknumber - Rank.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"description": "example",
"filename": "example",
"has_audio": true,
"is_pending": true,
"is_pro_clone": true,
"language": "example",
"name": "example",
"org_uid": "example",
"start_s": 1,
"stop_s": 1,
"uid": "example"
}
}Update a pronunciation dictionary
Update a pronunciation dictionary.
Inputs
- Dictionary
dictionary_idtextRequired - Dictionary id.
- Name
nametext - Name.
- Description
descriptiontext - Description.
- Language
languagetext - Language.One of:
en,fr,es,pt,de. - Rules
ruleslist - Rules.
Outputs
dataobject- The response from Gradium.
Example output
{
"data": {
"created_at": "example",
"description": "example",
"language": "example",
"name": "example",
"org_uid": "example",
"rules": [
{
"case_sensitive": true,
"id": 1,
"original": "example",
"rewrite": "example"
}
],
"uid": "example"
}
}