Skip to main content
PATCH
Rename a voice clone or change its settings
Settings apply to the next segment generation or dub at once; each language’s sample is regenerated when the clone is next used in that language, never on a read (samples_status: regenerating, that language’s sample: null until then). Source files cannot be replaced. When to use: to tune a clone. Side effects: Speakers using the clone become outdated. Cost: Free; at most 10 settings changes per clone per hour (429 rate_limited, policy voice-settings-hour). Idempotency: Idempotency-Key accepted (SDKs send one); retries within 24 h replay the first response. Required scopes: voices:write Errors: voice_clone_not_ready (409)

Authorizations

Authorization
string
header
required

API key from Settings -> API keys, sent as Authorization: Bearer <key> (SDK environment variable RASK_API_KEY). Bound to one workspace and one acting user. Operations list the scopes they need (OpenAPI 3.1 scopes on a bearer scheme).

Scopes

voices:write

Headers

Idempotency-Key
string

Optional. A unique key per logical request (SDKs send a bare UUIDv4; an RFC 9651 quoted string is accepted and unquoted); reuse it unchanged on retries to replay the first response.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]+$

Path Parameters

voice_clone_id
string
required

Voice clone id.

Maximum string length: 64

Body

application/json

Body of updateVoiceClone. Source files cannot be replaced: create a new clone.

name
string

Clone name.

Required string length: 1 - 100
settings
object

Voice clone settings.

Response

OK: VoiceClone.

A reusable workspace voice clone.

object
enum<string>
required

Always voice_clone.

Available options:
voice_clone
id
string
required

Voice clone id.

name
string
required

Name.

status
enum<string>
required

Voice clone status.

  • processing: being created
  • ready: usable
  • failed: see failure
Available options:
processing,
ready,
failed
failure
object | null
required

Why it failed.

source
object
required

Source of a voice clone: a union on type.

settings
object
required

Voice clone settings.

languages
object[] | null
required

Only in getVoiceClone; null in lists.

samples_status
enum<string>
required

Sample status.

  • ready: samples match the settings
  • regenerating: being regenerated
  • stale: regeneration failed; settings still apply
Available options:
ready,
regenerating,
stale
created_at
string<date-time>
required

Creation time.