Create Proofread Session

curl --request POST \
  --url https://api.heygen.com/v3/video-translations/proofreads \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "video": {
    "type": "<string>",
    "url": "<string>"
  },
  "output_languages": [
    "<string>"
  ],
  "title": "<string>",
  "brand_voice_id": "<string>",
  "brand_glossary_id": "<string>",
  "speaker_num": 123,
  "folder_id": "<string>",
  "enable_video_stretching": false,
  "disable_music_track": false,
  "enable_speech_enhancement": false,
  "srt": {
    "type": "<string>",
    "url": "<string>"
  },
  "mode": "speed",
  "keep_the_same_format": false
}
'

import requests

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

payload = {
    "video": {
        "type": "<string>",
        "url": "<string>"
    },
    "output_languages": ["<string>"],
    "title": "<string>",
    "brand_voice_id": "<string>",
    "brand_glossary_id": "<string>",
    "speaker_num": 123,
    "folder_id": "<string>",
    "enable_video_stretching": False,
    "disable_music_track": False,
    "enable_speech_enhancement": False,
    "srt": {
        "type": "<string>",
        "url": "<string>"
    },
    "mode": "speed",
    "keep_the_same_format": False
}
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: {type: '<string>', url: '<string>'},
    output_languages: ['<string>'],
    title: '<string>',
    brand_voice_id: '<string>',
    brand_glossary_id: '<string>',
    speaker_num: 123,
    folder_id: '<string>',
    enable_video_stretching: false,
    disable_music_track: false,
    enable_speech_enhancement: false,
    srt: {type: '<string>', url: '<string>'},
    mode: 'speed',
    keep_the_same_format: false
  })
};

fetch('https://api.heygen.com/v3/video-translations/proofreads', 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/proofreads",
  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' => [
        'type' => '<string>',
        'url' => '<string>'
    ],
    'output_languages' => [
        '<string>'
    ],
    'title' => '<string>',
    'brand_voice_id' => '<string>',
    'brand_glossary_id' => '<string>',
    'speaker_num' => 123,
    'folder_id' => '<string>',
    'enable_video_stretching' => false,
    'disable_music_track' => false,
    'enable_speech_enhancement' => false,
    'srt' => [
        'type' => '<string>',
        'url' => '<string>'
    ],
    'mode' => 'speed',
    'keep_the_same_format' => false
  ]),
  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/proofreads"

	payload := strings.NewReader("{\n  \"video\": {\n    \"type\": \"<string>\",\n    \"url\": \"<string>\"\n  },\n  \"output_languages\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\",\n  \"brand_voice_id\": \"<string>\",\n  \"brand_glossary_id\": \"<string>\",\n  \"speaker_num\": 123,\n  \"folder_id\": \"<string>\",\n  \"enable_video_stretching\": false,\n  \"disable_music_track\": false,\n  \"enable_speech_enhancement\": false,\n  \"srt\": {\n    \"type\": \"<string>\",\n    \"url\": \"<string>\"\n  },\n  \"mode\": \"speed\",\n  \"keep_the_same_format\": false\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/proofreads")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"video\": {\n    \"type\": \"<string>\",\n    \"url\": \"<string>\"\n  },\n  \"output_languages\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\",\n  \"brand_voice_id\": \"<string>\",\n  \"brand_glossary_id\": \"<string>\",\n  \"speaker_num\": 123,\n  \"folder_id\": \"<string>\",\n  \"enable_video_stretching\": false,\n  \"disable_music_track\": false,\n  \"enable_speech_enhancement\": false,\n  \"srt\": {\n    \"type\": \"<string>\",\n    \"url\": \"<string>\"\n  },\n  \"mode\": \"speed\",\n  \"keep_the_same_format\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": {\n    \"type\": \"<string>\",\n    \"url\": \"<string>\"\n  },\n  \"output_languages\": [\n    \"<string>\"\n  ],\n  \"title\": \"<string>\",\n  \"brand_voice_id\": \"<string>\",\n  \"brand_glossary_id\": \"<string>\",\n  \"speaker_num\": 123,\n  \"folder_id\": \"<string>\",\n  \"enable_video_stretching\": false,\n  \"disable_music_track\": false,\n  \"enable_speech_enhancement\": false,\n  \"srt\": {\n    \"type\": \"<string>\",\n    \"url\": \"<string>\"\n  },\n  \"mode\": \"speed\",\n  \"keep_the_same_format\": false\n}"

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

{
  "data": {
    "proofread_ids": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "'video_url' is required.",
    "param": "video_url",
    "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
  }
}