Skip to main content
POST
/
v3
/
ai-clipping
Create AI Clipping
curl --request POST \
  --url https://api.heygen.com/v3/ai-clipping \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "video": {
    "type": "<string>",
    "url": "<string>"
  },
  "title": "<string>",
  "input_language": "<string>",
  "output_settings": {
    "duration_types": [],
    "aspect_ratio": "portrait",
    "captions": true,
    "caption_style": "<string>",
    "prompt": "<string>"
  },
  "callback_url": "<string>",
  "callback_id": "<string>"
}
'
import requests

url = "https://api.heygen.com/v3/ai-clipping"

payload = {
    "video": {
        "type": "<string>",
        "url": "<string>"
    },
    "title": "<string>",
    "input_language": "<string>",
    "output_settings": {
        "duration_types": [],
        "aspect_ratio": "portrait",
        "captions": True,
        "caption_style": "<string>",
        "prompt": "<string>"
    },
    "callback_url": "<string>",
    "callback_id": "<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: {type: '<string>', url: '<string>'},
    title: '<string>',
    input_language: '<string>',
    output_settings: {
      duration_types: [],
      aspect_ratio: 'portrait',
      captions: true,
      caption_style: '<string>',
      prompt: '<string>'
    },
    callback_url: '<string>',
    callback_id: '<string>'
  })
};

fetch('https://api.heygen.com/v3/ai-clipping', 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/ai-clipping",
  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>'
    ],
    'title' => '<string>',
    'input_language' => '<string>',
    'output_settings' => [
        'duration_types' => [
                
        ],
        'aspect_ratio' => 'portrait',
        'captions' => true,
        'caption_style' => '<string>',
        'prompt' => '<string>'
    ],
    'callback_url' => '<string>',
    'callback_id' => '<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/ai-clipping"

	payload := strings.NewReader("{\n  \"video\": {\n    \"type\": \"<string>\",\n    \"url\": \"<string>\"\n  },\n  \"title\": \"<string>\",\n  \"input_language\": \"<string>\",\n  \"output_settings\": {\n    \"duration_types\": [],\n    \"aspect_ratio\": \"portrait\",\n    \"captions\": true,\n    \"caption_style\": \"<string>\",\n    \"prompt\": \"<string>\"\n  },\n  \"callback_url\": \"<string>\",\n  \"callback_id\": \"<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/ai-clipping")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"video\": {\n    \"type\": \"<string>\",\n    \"url\": \"<string>\"\n  },\n  \"title\": \"<string>\",\n  \"input_language\": \"<string>\",\n  \"output_settings\": {\n    \"duration_types\": [],\n    \"aspect_ratio\": \"portrait\",\n    \"captions\": true,\n    \"caption_style\": \"<string>\",\n    \"prompt\": \"<string>\"\n  },\n  \"callback_url\": \"<string>\",\n  \"callback_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/ai-clipping")

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  \"title\": \"<string>\",\n  \"input_language\": \"<string>\",\n  \"output_settings\": {\n    \"duration_types\": [],\n    \"aspect_ratio\": \"portrait\",\n    \"captions\": true,\n    \"caption_style\": \"<string>\",\n    \"prompt\": \"<string>\"\n  },\n  \"callback_url\": \"<string>\",\n  \"callback_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "ai_clipping_id": "<string>"
  }
}
{
  "error": {
    "code": "invalid_parameter",
    "message": "Source video URL is unsupported or unreachable.",
    "param": "video",
    "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

​
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

Request body for POST /v3/ai-clipping.

​
video
AssetUrl · object
required

Asset input via publicly accessible HTTPS URL.

​
title
string | null

Title for the job. Defaults to the source video's title if omitted.

Maximum string length: 255
​
input_language
string | null

ISO-639-1 source language code (e.g. 'en', 'es'). Omit for auto-detect.

​
output_settings
HighlightOutputSettings · object

Configuration for the produced clips (duration mix, aspect ratio, captions, etc.).

​
callback_url
string | null

HTTPS URL to receive per-job webhook callbacks. Mirrors /v3/video-translations callback_url. Per-job callback_url deliveries are NOT HMAC-signed: authenticate them by verifying TLS and matching the echoed callback_id, and do not trust an unverified body. To receive a signed payload, register a webhook endpoint with a secret (the signature header is sent only to registered endpoints).

​
callback_id
string | null

Opaque client identifier echoed verbatim in webhook payloads. Mirrors /v3/video-translations callback_id.

Maximum string length: 128

Response

Accepted — submission acknowledged; poll for completion.

​
data
CreateAiClippingResponse · object

Response for POST /v3/ai-clipping. Mirrors the v3 single-ID create shape.