Translate text segments (async)

curl --request POST \
  --url https://api.vmeg.ai/openapi/v1/task/translate/create-async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "language": {
    "source": "zh-CN",
    "target": "en-US"
  },
  "segments": [
    {
      "text": "<string>",
      "gender": "male",
      "speaker": "Speaker A",
      "locale": "zh-CN",
      "context": [
        "<string>"
      ],
      "start": 123,
      "end": 123
    }
  ],
  "options": {
    "sourceContext": {
      "mode": "independent",
      "contextWindow": 5
    },
    "sceneCustomized": {
      "scene": "video",
      "allowStutter": true
    },
    "glossary": {},
    "prompt": "<string>",
    "skipMissingTranslationCheck": false
  },
  "extraData": {}
}
'

import requests

url = "https://api.vmeg.ai/openapi/v1/task/translate/create-async"

payload = {
    "language": {
        "source": "zh-CN",
        "target": "en-US"
    },
    "segments": [
        {
            "text": "<string>",
            "gender": "male",
            "speaker": "Speaker A",
            "locale": "zh-CN",
            "context": ["<string>"],
            "start": 123,
            "end": 123
        }
    ],
    "options": {
        "sourceContext": {
            "mode": "independent",
            "contextWindow": 5
        },
        "sceneCustomized": {
            "scene": "video",
            "allowStutter": True
        },
        "glossary": {},
        "prompt": "<string>",
        "skipMissingTranslationCheck": False
    },
    "extraData": {}
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    language: {source: 'zh-CN', target: 'en-US'},
    segments: [
      {
        text: '<string>',
        gender: 'male',
        speaker: 'Speaker A',
        locale: 'zh-CN',
        context: ['<string>'],
        start: 123,
        end: 123
      }
    ],
    options: {
      sourceContext: {mode: 'independent', contextWindow: 5},
      sceneCustomized: {scene: 'video', allowStutter: true},
      glossary: {},
      prompt: '<string>',
      skipMissingTranslationCheck: false
    },
    extraData: {}
  })
};

fetch('https://api.vmeg.ai/openapi/v1/task/translate/create-async', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vmeg.ai/openapi/v1/task/translate/create-async",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'language' => [
        'source' => 'zh-CN',
        'target' => 'en-US'
    ],
    'segments' => [
        [
                'text' => '<string>',
                'gender' => 'male',
                'speaker' => 'Speaker A',
                'locale' => 'zh-CN',
                'context' => [
                                '<string>'
                ],
                'start' => 123,
                'end' => 123
        ]
    ],
    'options' => [
        'sourceContext' => [
                'mode' => 'independent',
                'contextWindow' => 5
        ],
        'sceneCustomized' => [
                'scene' => 'video',
                'allowStutter' => true
        ],
        'glossary' => [
                
        ],
        'prompt' => '<string>',
        'skipMissingTranslationCheck' => false
    ],
    'extraData' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency-Key: <x-idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vmeg.ai/openapi/v1/task/translate/create-async"

	payload := strings.NewReader("{\n  \"language\": {\n    \"source\": \"zh-CN\",\n    \"target\": \"en-US\"\n  },\n  \"segments\": [\n    {\n      \"text\": \"<string>\",\n      \"gender\": \"male\",\n      \"speaker\": \"Speaker A\",\n      \"locale\": \"zh-CN\",\n      \"context\": [\n        \"<string>\"\n      ],\n      \"start\": 123,\n      \"end\": 123\n    }\n  ],\n  \"options\": {\n    \"sourceContext\": {\n      \"mode\": \"independent\",\n      \"contextWindow\": 5\n    },\n    \"sceneCustomized\": {\n      \"scene\": \"video\",\n      \"allowStutter\": true\n    },\n    \"glossary\": {},\n    \"prompt\": \"<string>\",\n    \"skipMissingTranslationCheck\": false\n  },\n  \"extraData\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vmeg.ai/openapi/v1/task/translate/create-async")
  .header("X-Idempotency-Key", "<x-idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"language\": {\n    \"source\": \"zh-CN\",\n    \"target\": \"en-US\"\n  },\n  \"segments\": [\n    {\n      \"text\": \"<string>\",\n      \"gender\": \"male\",\n      \"speaker\": \"Speaker A\",\n      \"locale\": \"zh-CN\",\n      \"context\": [\n        \"<string>\"\n      ],\n      \"start\": 123,\n      \"end\": 123\n    }\n  ],\n  \"options\": {\n    \"sourceContext\": {\n      \"mode\": \"independent\",\n      \"contextWindow\": 5\n    },\n    \"sceneCustomized\": {\n      \"scene\": \"video\",\n      \"allowStutter\": true\n    },\n    \"glossary\": {},\n    \"prompt\": \"<string>\",\n    \"skipMissingTranslationCheck\": false\n  },\n  \"extraData\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vmeg.ai/openapi/v1/task/translate/create-async")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"language\": {\n    \"source\": \"zh-CN\",\n    \"target\": \"en-US\"\n  },\n  \"segments\": [\n    {\n      \"text\": \"<string>\",\n      \"gender\": \"male\",\n      \"speaker\": \"Speaker A\",\n      \"locale\": \"zh-CN\",\n      \"context\": [\n        \"<string>\"\n      ],\n      \"start\": 123,\n      \"end\": 123\n    }\n  ],\n  \"options\": {\n    \"sourceContext\": {\n      \"mode\": \"independent\",\n      \"contextWindow\": 5\n    },\n    \"sceneCustomized\": {\n      \"scene\": \"video\",\n      \"allowStutter\": true\n    },\n    \"glossary\": {},\n    \"prompt\": \"<string>\",\n    \"skipMissingTranslationCheck\": false\n  },\n  \"extraData\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "message": "",
  "data": {
    "taskId": "<string>",
    "createdAt": "<string>"
  }
}

POST

openapi

task

translate

create-async

Translate text segments (async)

curl --request POST \
  --url https://api.vmeg.ai/openapi/v1/task/translate/create-async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "language": {
    "source": "zh-CN",
    "target": "en-US"
  },
  "segments": [
    {
      "text": "<string>",
      "gender": "male",
      "speaker": "Speaker A",
      "locale": "zh-CN",
      "context": [
        "<string>"
      ],
      "start": 123,
      "end": 123
    }
  ],
  "options": {
    "sourceContext": {
      "mode": "independent",
      "contextWindow": 5
    },
    "sceneCustomized": {
      "scene": "video",
      "allowStutter": true
    },
    "glossary": {},
    "prompt": "<string>",
    "skipMissingTranslationCheck": false
  },
  "extraData": {}
}
'

import requests

url = "https://api.vmeg.ai/openapi/v1/task/translate/create-async"

payload = {
    "language": {
        "source": "zh-CN",
        "target": "en-US"
    },
    "segments": [
        {
            "text": "<string>",
            "gender": "male",
            "speaker": "Speaker A",
            "locale": "zh-CN",
            "context": ["<string>"],
            "start": 123,
            "end": 123
        }
    ],
    "options": {
        "sourceContext": {
            "mode": "independent",
            "contextWindow": 5
        },
        "sceneCustomized": {
            "scene": "video",
            "allowStutter": True
        },
        "glossary": {},
        "prompt": "<string>",
        "skipMissingTranslationCheck": False
    },
    "extraData": {}
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    language: {source: 'zh-CN', target: 'en-US'},
    segments: [
      {
        text: '<string>',
        gender: 'male',
        speaker: 'Speaker A',
        locale: 'zh-CN',
        context: ['<string>'],
        start: 123,
        end: 123
      }
    ],
    options: {
      sourceContext: {mode: 'independent', contextWindow: 5},
      sceneCustomized: {scene: 'video', allowStutter: true},
      glossary: {},
      prompt: '<string>',
      skipMissingTranslationCheck: false
    },
    extraData: {}
  })
};

fetch('https://api.vmeg.ai/openapi/v1/task/translate/create-async', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vmeg.ai/openapi/v1/task/translate/create-async",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'language' => [
        'source' => 'zh-CN',
        'target' => 'en-US'
    ],
    'segments' => [
        [
                'text' => '<string>',
                'gender' => 'male',
                'speaker' => 'Speaker A',
                'locale' => 'zh-CN',
                'context' => [
                                '<string>'
                ],
                'start' => 123,
                'end' => 123
        ]
    ],
    'options' => [
        'sourceContext' => [
                'mode' => 'independent',
                'contextWindow' => 5
        ],
        'sceneCustomized' => [
                'scene' => 'video',
                'allowStutter' => true
        ],
        'glossary' => [
                
        ],
        'prompt' => '<string>',
        'skipMissingTranslationCheck' => false
    ],
    'extraData' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency-Key: <x-idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vmeg.ai/openapi/v1/task/translate/create-async"

	payload := strings.NewReader("{\n  \"language\": {\n    \"source\": \"zh-CN\",\n    \"target\": \"en-US\"\n  },\n  \"segments\": [\n    {\n      \"text\": \"<string>\",\n      \"gender\": \"male\",\n      \"speaker\": \"Speaker A\",\n      \"locale\": \"zh-CN\",\n      \"context\": [\n        \"<string>\"\n      ],\n      \"start\": 123,\n      \"end\": 123\n    }\n  ],\n  \"options\": {\n    \"sourceContext\": {\n      \"mode\": \"independent\",\n      \"contextWindow\": 5\n    },\n    \"sceneCustomized\": {\n      \"scene\": \"video\",\n      \"allowStutter\": true\n    },\n    \"glossary\": {},\n    \"prompt\": \"<string>\",\n    \"skipMissingTranslationCheck\": false\n  },\n  \"extraData\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vmeg.ai/openapi/v1/task/translate/create-async")
  .header("X-Idempotency-Key", "<x-idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"language\": {\n    \"source\": \"zh-CN\",\n    \"target\": \"en-US\"\n  },\n  \"segments\": [\n    {\n      \"text\": \"<string>\",\n      \"gender\": \"male\",\n      \"speaker\": \"Speaker A\",\n      \"locale\": \"zh-CN\",\n      \"context\": [\n        \"<string>\"\n      ],\n      \"start\": 123,\n      \"end\": 123\n    }\n  ],\n  \"options\": {\n    \"sourceContext\": {\n      \"mode\": \"independent\",\n      \"contextWindow\": 5\n    },\n    \"sceneCustomized\": {\n      \"scene\": \"video\",\n      \"allowStutter\": true\n    },\n    \"glossary\": {},\n    \"prompt\": \"<string>\",\n    \"skipMissingTranslationCheck\": false\n  },\n  \"extraData\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vmeg.ai/openapi/v1/task/translate/create-async")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"language\": {\n    \"source\": \"zh-CN\",\n    \"target\": \"en-US\"\n  },\n  \"segments\": [\n    {\n      \"text\": \"<string>\",\n      \"gender\": \"male\",\n      \"speaker\": \"Speaker A\",\n      \"locale\": \"zh-CN\",\n      \"context\": [\n        \"<string>\"\n      ],\n      \"start\": 123,\n      \"end\": 123\n    }\n  ],\n  \"options\": {\n    \"sourceContext\": {\n      \"mode\": \"independent\",\n      \"contextWindow\": 5\n    },\n    \"sceneCustomized\": {\n      \"scene\": \"video\",\n      \"allowStutter\": true\n    },\n    \"glossary\": {},\n    \"prompt\": \"<string>\",\n    \"skipMissingTranslationCheck\": false\n  },\n  \"extraData\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "message": "",
  "data": {
    "taskId": "<string>",
    "createdAt": "<string>"
  }
}

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

language

object

required

Source and target locales for translation

Show child attributes

segments

object[]

required

Text segments to translate (max 50)

Maximum array length: 50

Show child attributes

options

object

Optional translation settings (context, scene, glossary, prompt)

Show child attributes

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 Text translation when event is openapi-translate. data.items holds translated segments aligned with your request. See Webhook request body and Create text translation (async) → Callbacks.

data

object

required

Product-specific results when event is openapi-translate. data.items holds translated segments aligned with your request.

Show child attributes

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, createdAt). 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)

Show child attributes

Translate text (sync)Clone voice from sample audio (sync)

Overview

Endpoints

Translate text segments (async)

Authorizations

Headers

Body

Callbacks

Body

Response

Response