Skip to main content
POST
This endpoint creates a cloned voice from an uploaded voice sample using the specified TTS provider. The cloning process varies by provider but typically completes within seconds to minutes.

Path Parameters

  • assistant_id (integer, required): The unique identifier of the assistant to associate the cloned voice with.

Request Body

The request body is a JSON object containing cloning configuration.
  • voice_sample_id (integer, required): ID of the uploaded voice sample to clone from
  • provider (string, required): TTS provider to use for voice cloning
    • Common values: elevenlabs, resemble, cartesia. The providers endpoint returns the current supported set.
  • name (string, required): Display name for the cloned voice
  • description (string, optional): Description of the cloned voice
  • language (string, optional): Language code (e.g., en, es, fr)
  • enhance_quality (boolean, optional): Whether to apply quality enhancement. Default: true
  • tags (array of strings, optional): Tags for organizing cloned voices
  • metadata (object, optional): Additional provider-specific metadata

Example Request

Request

Response

A successful request returns the cloned voice object with initial status.
Response

Response Fields

  • id (integer): Unique identifier for the cloned voice
  • name (string): Display name of the cloned voice
  • provider (string): TTS provider used for cloning
  • provider_voice_id (string): Provider-specific voice identifier
  • status (string): Current cloning status
  • created_at (string): ISO 8601 timestamp of creation

Cloning Status

  • processing: Voice cloning is in progress
  • ready: Voice is successfully cloned and ready for use
  • failed: Voice cloning failed, check error details

Provider-Specific Behavior

ElevenLabs

  • Processing Time: Usually 5-30 seconds
  • Instant Preview: Voice ready for immediate testing
  • Voice ID: Returns ElevenLabs voice ID for direct API usage
  • Quality: High-quality instant cloning from short samples

Resemble AI

  • Processing Time: 2-10 minutes for training
  • Professional Quality: Advanced training algorithms
  • Voice UUID: Returns Resemble voice UUID
  • Customization: Supports advanced voice customization options

Example Requests

ElevenLabs Voice Cloning
Resemble AI Voice Cloning

Error Responses

400 Bad Request - Invalid parameters:
404 Not Found - Voice sample not found:
500 Internal Server Error - Provider cloning failed:

Best Practices

  1. Provider Selection: Choose ElevenLabs for quick prototyping, Resemble for production quality
  2. Naming Convention: Use descriptive names that indicate voice characteristics
  3. Quality Settings: Enable quality enhancement for better results
  4. Monitoring: Check cloning status regularly for large-scale operations
  5. Error Handling: Implement retry logic for transient provider failures

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

assistant_id
integer
required

Body

application/json

Schema for creating a cloned voice.

voice_sample_id
integer
required

ID of the uploaded voice sample

provider
string
required

TTS provider to use for voice cloning

name
string
required

Name for the cloned voice

description
string | null

Description of the cloned voice

language
string | null

Language code (e.g., 'en', 'es')

enhance_quality
boolean
default:true

Whether to enhance voice quality

tags
string[] | null

Tags for organizing voices

metadata
Metadata · object | null

Additional metadata

Response

Successful Response