Save a Voice Design preview as a private voice
curl --request POST \
--url https://gengen.farm/api/gengen/v1/audio/voice-designs/{generationId}/save \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"voice_name": "<string>"
}
'import requests
url = "https://gengen.farm/api/gengen/v1/audio/voice-designs/{generationId}/save"
payload = { "voice_name": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({voice_name: '<string>'})
};
fetch('https://gengen.farm/api/gengen/v1/audio/voice-designs/{generationId}/save', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"name": "<string>",
"kind": "clone",
"status": "creating",
"models": [
"<string>"
],
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"statusUrl": "<string>",
"id": "<string>",
"voiceId": "<string>",
"message": "<string>"
}{
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"statusUrl": "<string>",
"name": "<string>",
"kind": "clone",
"status": "creating",
"models": [
"<string>"
],
"id": "<string>",
"voiceId": "<string>",
"message": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Create voices
Save a Voice Design candidate
POST
/
audio
/
voice-designs
/
{generationId}
/
save
Save a Voice Design preview as a private voice
curl --request POST \
--url https://gengen.farm/api/gengen/v1/audio/voice-designs/{generationId}/save \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"voice_name": "<string>"
}
'import requests
url = "https://gengen.farm/api/gengen/v1/audio/voice-designs/{generationId}/save"
payload = { "voice_name": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({voice_name: '<string>'})
};
fetch('https://gengen.farm/api/gengen/v1/audio/voice-designs/{generationId}/save', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"name": "<string>",
"kind": "clone",
"status": "creating",
"models": [
"<string>"
],
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"statusUrl": "<string>",
"id": "<string>",
"voiceId": "<string>",
"message": "<string>"
}{
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"statusUrl": "<string>",
"name": "<string>",
"kind": "clone",
"status": "creating",
"models": [
"<string>"
],
"id": "<string>",
"voiceId": "<string>",
"message": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Choose a preview from
Save before the task’s
outputs.audios of a successful Voice Design task. Use the API key that created the task. Put the full task ID (including audio:) in the path, and send the preview’s candidateId and your chosen voice_name in the body.
curl "https://gengen.farm/v1/audio/voice-designs/$GENERATION_ID/save" \
-H "Authorization: Bearer $GENGEN_API_KEY" \
-H 'Content-Type: application/json' \
-d '{"candidateId":"candidate-2","voice_name":"Narrator"}'
mediaExpiresAt. The voice keeps the original design prompt as its description and remains available after the previews expire. Saving uses one private voice slot with no separate save fee.
On 201 with status: "active", use the returned voiceId for speech or dialogue with any active key in the workspace. On 202, poll the returned statusUrl. Repeating a save without an Idempotency-Key can occupy another slot; see retrying a request.Authorizations
Headers
Scoped to the workspace and creation operation. Without this header each submission is independent and can occupy another slot. To retry safely, reuse the same key and input. Changing the input under the same key returns 409.
Required string length:
1 - 128Pattern:
^[!-~]{1,128}$Path Parameters
Body
application/json
Response
Saved voice or idempotent replay. Use for generation when active.