Skip to main content

Edit Voice Settings

POST 

https://api.knoxstudio.ai/v1/voices/:voice_id/settings/edit

stability corresponds to Stability; similarity_boost to Clarity + Similarity. Not billed.

Request​

Path Parameters​

NameTypeRequiredDescription
voice_idStringYesVoice ID.

Request Headers​

NameTypeRequiredDescription
AuthorizationStringYesBearer <token> Knox API key. xi-api-key is also accepted.
Content-TypeStringYesapplication/json

Request Body​

NameTypeRequiredDescription
stabilityNumberNoVoice stability.
similarity_boostNumberNoHow closely to match the original voice.
styleNumberNoStyle exaggeration.
speedNumberNoSpeech speed. 1.0 is default.
use_speaker_boostBooleanNoSpeaker boost.

cURL Example​

curl -X POST https://api.knoxstudio.ai/v1/voices/voice_id/settings/edit \
-H "Authorization: Bearer $KNOXCHAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"stability":0.5,"similarity_boost":0.75,"speed":1.0}'

Response​

Success Response (200)​

{ "status": "ok" } on success.

Error Responses​

Validation uses HTTP 422:

{
"detail": [
{
"loc": ["body", "field"],
"msg": "…",
"type": "value_error"
}
]
}

Other errors use { "detail": "message" }.

StatusWhen
400WebSocket path called without Upgrade: websocket.
401Missing or invalid API key.
402Insufficient credits.
403Token is not allowed to use this model.
404Resource not found.
422Validation error.
429Rate limit exceeded.
500Internal server error.