SubmitCustomizedVoiceJob

Updated at:

Submits a voice cloning task of the Basic edition.

Operation description

  • Voice cloning billing is divided into two dimensions: customization and usage. For more information, see Voice cloning billing.

  • When submitting a voice cloning task, the VoiceId must be the same as the one used during audio detection. The cloud relies on this parameter to locate the staged audio for training.

  • During training, you can call the GetCustomizedVoiceJob operation to check whether the current task is completed or to obtain the training status.

  • This is an asynchronous operation. After you submit the task, a task ID is returned (the task is not yet completed at this point and enters a background queue for asynchronous execution). The final result is delivered through a callback notification. You can also proactively query the task status by calling GetCustomizedVoiceJob.

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:SubmitCustomizedVoiceJob

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

VoiceId

string

Yes

The voice ID.

xiaozhuan

DemoAudioMediaURL

string

No

The audio output address of the sample.

  • If you specify this parameter, a sample audio file is generated at the specified OSS address after training succeeds.

  • If you do not specify this parameter, no sample audio is generated.
    Important The address must be a valid public OSS address under your account.

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

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

******11-DB8D-4A9A-875B-275798******

Success

boolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.

  • false: The call failed.

true

Data

object

The response data.

JobId

string

The voice cloning task ID.

****d718e2ff4f018ccf419a7b71****

VoiceId

string

The voice ID.

xiaozhuan

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Success": true,
  "Data": {
    "JobId": "****d718e2ff4f018ccf419a7b71****",
    "VoiceId": "xiaozhuan"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.