Create Custom Agent Video

curl --request POST \
  --url https://api.heygen.com/v3/custom-agents/{agent_id}/videos \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "topic": "<string>",
  "wallpaper": "<string>",
  "avatar_id": "<string>",
  "avatar_still_url": "<string>",
  "voice_id": "<string>",
  "watch_model": "<string>",
  "script": "<string>",
  "screen_recording_url": "<string>",
  "presenter_background_url": "<string>",
  "presenter_background_video_url": "<string>"
}
'

import requests

url = "https://api.heygen.com/v3/custom-agents/{agent_id}/videos"

payload = {
    "topic": "<string>",
    "wallpaper": "<string>",
    "avatar_id": "<string>",
    "avatar_still_url": "<string>",
    "voice_id": "<string>",
    "watch_model": "<string>",
    "script": "<string>",
    "screen_recording_url": "<string>",
    "presenter_background_url": "<string>",
    "presenter_background_video_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({
    topic: '<string>',
    wallpaper: '<string>',
    avatar_id: '<string>',
    avatar_still_url: '<string>',
    voice_id: '<string>',
    watch_model: '<string>',
    script: '<string>',
    screen_recording_url: '<string>',
    presenter_background_url: '<string>',
    presenter_background_video_url: '<string>'
  })
};

fetch('https://api.heygen.com/v3/custom-agents/{agent_id}/videos', 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/custom-agents/{agent_id}/videos",
  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([
    'topic' => '<string>',
    'wallpaper' => '<string>',
    'avatar_id' => '<string>',
    'avatar_still_url' => '<string>',
    'voice_id' => '<string>',
    'watch_model' => '<string>',
    'script' => '<string>',
    'screen_recording_url' => '<string>',
    'presenter_background_url' => '<string>',
    'presenter_background_video_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/custom-agents/{agent_id}/videos"

	payload := strings.NewReader("{\n  \"topic\": \"<string>\",\n  \"wallpaper\": \"<string>\",\n  \"avatar_id\": \"<string>\",\n  \"avatar_still_url\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"watch_model\": \"<string>\",\n  \"script\": \"<string>\",\n  \"screen_recording_url\": \"<string>\",\n  \"presenter_background_url\": \"<string>\",\n  \"presenter_background_video_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/custom-agents/{agent_id}/videos")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"topic\": \"<string>\",\n  \"wallpaper\": \"<string>\",\n  \"avatar_id\": \"<string>\",\n  \"avatar_still_url\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"watch_model\": \"<string>\",\n  \"script\": \"<string>\",\n  \"screen_recording_url\": \"<string>\",\n  \"presenter_background_url\": \"<string>\",\n  \"presenter_background_video_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/custom-agents/{agent_id}/videos")

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  \"topic\": \"<string>\",\n  \"wallpaper\": \"<string>\",\n  \"avatar_id\": \"<string>\",\n  \"avatar_still_url\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"watch_model\": \"<string>\",\n  \"script\": \"<string>\",\n  \"screen_recording_url\": \"<string>\",\n  \"presenter_background_url\": \"<string>\",\n  \"presenter_background_video_url\": \"<string>\"\n}"

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

{
  "data": {
    "video_id": "<string>",
    "status": "RUNNING"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "Video not found",
    "param": "<string>",
    "doc_url": "<string>",
    "errors": [
      {
        "code": "unknown_node_type",
        "message": "Unknown node type",
        "node_id": "<string>",
        "port": "<string>",
        "path": "<string>"
      }
    ]
  }
}

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

{
  "error": {
    "code": "invalid_parameter",
    "message": "Video not found",
    "param": "<string>",
    "doc_url": "<string>",
    "errors": [
      {
        "code": "unknown_node_type",
        "message": "Unknown node type",
        "node_id": "<string>",
        "port": "<string>",
        "path": "<string>"
      }
    ]
  }
}

{
  "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
  }
}