Skip to main content
POST
/
openapi
/
v1
/
task
/
clone-voice
/
create-async
Create voice clone (async)
curl --request POST \
  --url https://api.vmeg.ai/openapi/v1/task/clone-voice/create-async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "voiceName": "<string>",
  "provider": "V1",
  "refAudio": "<string>",
  "sampleLanguage": "zh-CN",
  "sampleText": "<string>",
  "extraData": {}
}
'
{
  "code": 200,
  "message": "",
  "data": {
    "taskId": "<string>",
    "createdAt": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.vmeg.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Send your API Key in the Authorization header (Bearer <api_key>). See Authentication.

Headers

​
X-Idempotency-Key
string
required

Required on mutating POST requests that create tasks or change persisted data (max 64 characters). See Idempotency.

Maximum string length: 64

Body

application/json
​
voiceName
string

Display name for the cloned voice in your asset library

​
provider
enum<string>

Clone engine version (V1–V5). See Supported clone methods.

Available options:
V1,
V2,
V3,
V4,
V5
Example:

"V1"

​
refAudio
string

HTTPS reference audio URL

​
sampleLanguage
string

Sample language locale (BCP-47). See Supported languages.

Example:

"zh-CN"

​
sampleText
string

Optional transcript of refAudio to improve clone quality

​
extraData
object

Optional client metadata on async submit; echoed in the completion webhook (extraData in callback body). Not used on sync create endpoints.

Callbacks

POST
https://{yourWebhookUrl}taskCompleted

Body

application/json

Webhook callback request body for Voice clone when event is openapi-clone-voice. data.voiceId (and related fields when successful). See Webhook request body and Create voice clone (async) → Callbacks.

​
data
object
required

Product-specific results when event is openapi-clone-voice. data.voiceId (and related fields when successful).

​
code
integer

Business outcome for this delivery

Example:

200

​
version
string

API version of the task (e.g. v1, v2). Matches the version in the request path (/openapi/v1/...).

Example:

"v1"

​
event
enum<string>

Which product completed. Route your handler by this value: openapi-tts (TTS), openapi-translate (text translation), openapi-clone-voice (voice clone), openapi-media-translation (media translation). Listed in Webhook request body.

Available options:
openapi-tts,
openapi-translate,
openapi-clone-voice,
openapi-media-translation
Example:

"openapi-tts"

​
pipelineKey
string

Stable ID for this async completion. Deduplicate webhook handling by this value — see Webhook request body.

Example:

"a1b2c3d4e5f6789012345678901234ab"

​
message
string

Detail when code is not success

​
extraData
object

Echo of extraData from your async submit request

Response

200

Return 2xx promptly to stop retries

Response

200 - application/json

Acceptance only (taskId). Final results are in the Webhook callback request body.

​
code
integer
required

Business code; 200 means success

Example:

200

​
message
string

Human-readable detail when code is not success

Example:

""

​
data
object

Immediate response for async task submission (no task results)