Create Video Translation Batch

Submit up to 100 video-translation payloads (identical in shape to POST /v3/video-translations) as a single batch. A payload targeting multiple output_languages expands to one batch item per language, and each item is created and processed independently so one bad source does not fail the rest. Returns 202 with a batch_id; poll GET /v3/video-translations/batches/ for progress. Pass an Idempotency-Key header to make retries safe — the same key returns the same batch.

POST /v3/video-translations/batches

Create Video Translation Batch

cURL

curl --request POST \
  --url https://api.heygen.com/v3/video-translations/batches \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "video_translations": [
    {
      "video": {
        "type": "<string>",
        "url": "<string>"
      },
      "output_languages": [
        "<string>"
      ],
      "title": "<string>",
      "audio": {
        "type": "<string>",
        "url": "<string>"
      },
      "input_language": "<string>",
      "translate_audio_only": false,
      "speaker_num": 123,
      "mode": "speed",
      "callback_url": "<string>",
      "callback_id": "<string>",
      "enable_caption": false,
      "keep_the_same_format": true,
      "enable_dynamic_duration": true,
      "disable_music_track": false,
      "enable_speech_enhancement": false,
      "enable_watermark": false,
      "start_time": 123,
      "end_time": 123,
      "brand_voice_id": "<string>",
      "brand_glossary_id": "<string>",
      "stock_voice_config": {
        "use_stock_voice": false,
        "preferred_stock_voice_ids": [
          "<string>"
        ]
      },
      "srt": {
        "type": "<string>",
        "url": "<string>"
      },
      "folder_id": "<string>"
    }
  ],
  "title": "<string>",
  "callback_url": "<string>"
}
'

import requests

url = "https://api.heygen.com/v3/video-translations/batches"

payload = {
    "video_translations": [
        {
            "video": {
                "type": "<string>",
                "url": "<string>"
            },
            "output_languages": ["<string>"],
            "title": "<string>",
            "audio": {
                "type": "<string>",
                "url": "<string>"
            },
            "input_language": "<string>",
            "translate_audio_only": False,
            "speaker_num": 123,
            "mode": "speed",
            "callback_url": "<string>",
            "callback_id": "<string>",
            "enable_caption": False,
            "keep_the_same_format": True,
            "enable_dynamic_duration": True,
            "disable_music_track": False,
            "enable_speech_enhancement": False,
            "enable_watermark": False,
            "start_time": 123,
            "end_time": 123,
            "brand_voice_id": "<string>",
            "brand_glossary_id": "<string>",
            "stock_voice_config": {
                "use_stock_voice": False,
                "preferred_stock_voice_ids": ["<string>"]
            },
            "srt": {
                "type": "<string>",
                "url": "<string>"
            },
            "folder_id": "<string>"
        }
    ],
    "title": "<string>",
    "callback_url": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    video_translations: [
      {
        video: {type: '<string>', url: '<string>'},
        output_languages: ['<string>'],
        title: '<string>',
        audio: {type: '<string>', url: '<string>'},
        input_language: '<string>',
        translate_audio_only: false,
        speaker_num: 123,
        mode: 'speed',
        callback_url: '<string>',
        callback_id: '<string>',
        enable_caption: false,
        keep_the_same_format: true,
        enable_dynamic_duration: true,
        disable_music_track: false,
        enable_speech_enhancement: false,
        enable_watermark: false,
        start_time: 123,
        end_time: 123,
        brand_voice_id: '<string>',
        brand_glossary_id: '<string>',
        stock_voice_config: {use_stock_voice: false, preferred_stock_voice_ids: ['<string>']},
        srt: {type: '<string>', url: '<string>'},
        folder_id: '<string>'
      }
    ],
    title: '<string>',
    callback_url: '<string>'
  })
};

fetch('https://api.heygen.com/v3/video-translations/batches', 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.heygen.com/v3/video-translations/batches",
  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([
    'video_translations' => [
        [
                'video' => [
                                'type' => '<string>',
                                'url' => '<string>'
                ],
                'output_languages' => [
                                '<string>'
                ],
                'title' => '<string>',
                'audio' => [
                                'type' => '<string>',
                                'url' => '<string>'
                ],
                'input_language' => '<string>',
                'translate_audio_only' => false,
                'speaker_num' => 123,
                'mode' => 'speed',
                'callback_url' => '<string>',
                'callback_id' => '<string>',
                'enable_caption' => false,
                'keep_the_same_format' => true,
                'enable_dynamic_duration' => true,
                'disable_music_track' => false,
                'enable_speech_enhancement' => false,
                'enable_watermark' => false,
                'start_time' => 123,
                'end_time' => 123,
                'brand_voice_id' => '<string>',
                'brand_glossary_id' => '<string>',
                'stock_voice_config' => [
                                'use_stock_voice' => false,
                                'preferred_stock_voice_ids' => [
                                                                '<string>'
                                ]
                ],
                'srt' => [
                                'type' => '<string>',
                                'url' => '<string>'
                ],
                'folder_id' => '<string>'
        ]
    ],
    'title' => '<string>',
    'callback_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-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.heygen.com/v3/video-translations/batches"

	payload := strings.NewReader("{\n  \"video_translations\": [\n    {\n      \"video\": {\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"output_languages\": [\n        \"<string>\"\n      ],\n      \"title\": \"<string>\",\n      \"audio\": {\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"input_language\": \"<string>\",\n      \"translate_audio_only\": false,\n      \"speaker_num\": 123,\n      \"mode\": \"speed\",\n      \"callback_url\": \"<string>\",\n      \"callback_id\": \"<string>\",\n      \"enable_caption\": false,\n      \"keep_the_same_format\": true,\n      \"enable_dynamic_duration\": true,\n      \"disable_music_track\": false,\n      \"enable_speech_enhancement\": false,\n      \"enable_watermark\": false,\n      \"start_time\": 123,\n      \"end_time\": 123,\n      \"brand_voice_id\": \"<string>\",\n      \"brand_glossary_id\": \"<string>\",\n      \"stock_voice_config\": {\n        \"use_stock_voice\": false,\n        \"preferred_stock_voice_ids\": [\n          \"<string>\"\n        ]\n      },\n      \"srt\": {\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"folder_id\": \"<string>\"\n    }\n  ],\n  \"title\": \"<string>\",\n  \"callback_url\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.heygen.com/v3/video-translations/batches")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"video_translations\": [\n    {\n      \"video\": {\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"output_languages\": [\n        \"<string>\"\n      ],\n      \"title\": \"<string>\",\n      \"audio\": {\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"input_language\": \"<string>\",\n      \"translate_audio_only\": false,\n      \"speaker_num\": 123,\n      \"mode\": \"speed\",\n      \"callback_url\": \"<string>\",\n      \"callback_id\": \"<string>\",\n      \"enable_caption\": false,\n      \"keep_the_same_format\": true,\n      \"enable_dynamic_duration\": true,\n      \"disable_music_track\": false,\n      \"enable_speech_enhancement\": false,\n      \"enable_watermark\": false,\n      \"start_time\": 123,\n      \"end_time\": 123,\n      \"brand_voice_id\": \"<string>\",\n      \"brand_glossary_id\": \"<string>\",\n      \"stock_voice_config\": {\n        \"use_stock_voice\": false,\n        \"preferred_stock_voice_ids\": [\n          \"<string>\"\n        ]\n      },\n      \"srt\": {\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"folder_id\": \"<string>\"\n    }\n  ],\n  \"title\": \"<string>\",\n  \"callback_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/video-translations/batches")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"video_translations\": [\n    {\n      \"video\": {\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"output_languages\": [\n        \"<string>\"\n      ],\n      \"title\": \"<string>\",\n      \"audio\": {\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"input_language\": \"<string>\",\n      \"translate_audio_only\": false,\n      \"speaker_num\": 123,\n      \"mode\": \"speed\",\n      \"callback_url\": \"<string>\",\n      \"callback_id\": \"<string>\",\n      \"enable_caption\": false,\n      \"keep_the_same_format\": true,\n      \"enable_dynamic_duration\": true,\n      \"disable_music_track\": false,\n      \"enable_speech_enhancement\": false,\n      \"enable_watermark\": false,\n      \"start_time\": 123,\n      \"end_time\": 123,\n      \"brand_voice_id\": \"<string>\",\n      \"brand_glossary_id\": \"<string>\",\n      \"stock_voice_config\": {\n        \"use_stock_voice\": false,\n        \"preferred_stock_voice_ids\": [\n          \"<string>\"\n        ]\n      },\n      \"srt\": {\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      \"folder_id\": \"<string>\"\n    }\n  ],\n  \"title\": \"<string>\",\n  \"callback_url\": \"<string>\"\n}"

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

202

{
  "data": {
    "batch_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "Invalid payload(s) at index 3.",
    "param": "video_translations",
    "doc_url": null
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid or expired API key. Verify your x-api-key header.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "request_in_progress",
    "message": "A request with this Idempotency-Key is already in progress. Retry shortly.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Retry after the duration specified in the Retry-After header.",
    "param": null,
    "doc_url": null
  }
}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Headers

Idempotency-Key · string

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Required string length: 1 - 255

Pattern: ^[A-Za-z0-9_\-:.]{1,255}$

Body

application/json

video_translations · CreateVideoTranslationRequest · object[] · required

Video-translation payloads, identical in shape to POST /v3/video-translations. A single entry targeting multiple output_languages expands to one batch item per language; the expanded item count is capped at 100.

Required array length: 1 - 100 elements

Show child attributes

title · string | null

Display name for the batch, shown in the HeyGen app.

callback_url · string | null

Webhook URL invoked once when every item in the batch reaches a terminal state.

Response

202

application/json

Accepted — submission acknowledged; poll for completion.

data · CreateVideoTranslationBatchResponse · object

Show child attributes