SubmitCosyVoiceCustomizedVoiceJob

Updated at:

Submits a CosyVoice voice cloning training job.

Operation description

  • During training, you can call the GetCustomizedVoiceJob - Query a voice cloning job operation to check the job completion and training status.

  • This operation is an asynchronous operation. After you submit the job, a job ID is returned. The job is not completed immediately and is queued for asynchronous execution in the background. You can call Query a voice cloning job to query the job status and obtain the final result.

  • Note that each account supports a maximum of 30 cloned voices per region. Quota increases are not supported at this time.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:SubmitCosyVoiceCustomizedVoiceJob

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

VoiceName

string

No

The name of the voice. The name cannot exceed 32 characters in length.

voice name

Gender

string

No

The gender. Valid values:

  • female: Female.

  • male: Male.

female

Audios

string

No

The media asset ID of the audio material for training. Currently, only one audio material is supported for training.

****571c704445f9a0ee011406c2****

DemoAudioMediaURL

string

No

The sample audio output URL.

  • If you specify this parameter, a sample audio file is generated at the specified OSS URL after the training job succeeds.
    Important The URL must be a valid public OSS URL under your account.


https://your-bucket.oss-cn-shanghai.aliyuncs.com/demo.MP3

Model

string

No

The voice cloning model. Valid values:

  • cosyvoice-v3-plus

  • cosyvoice-v3-flash

  • cosyvoice-v3.5-plus

  • cosyvoice-v3.5-flash

cosyvoice-v3-plus

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

C0C02296-113C-5838-8FE9-8F3A32998DDC

Success

boolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.

  • false: The request fails.

true

Data

object

The returned result.

JobId

string

The ID of the voice cloning job.

bfb786c639894f4d80648792021****

VoiceId

string

The ID of the voice.

Voice-l*****

Examples

Success response

JSON format

{
  "RequestId": "C0C02296-113C-5838-8FE9-8F3A32998DDC",
  "Success": true,
  "Data": {
    "JobId": "bfb786c639894f4d80648792021****",
    "VoiceId": "Voice-l*****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.