Skip to main content
GET
/
v3
/
ai-clipping
/
{job_id}
Get AI Clipping
curl --request GET \
  --url https://api.heygen.com/v3/ai-clipping/{job_id} \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "input_language": "<string>",
    "source_duration": 123,
    "output_settings": {
      "duration_types": [],
      "aspect_ratio": "portrait",
      "captions": true,
      "caption_style": "<string>",
      "prompt": "<string>"
    },
    "clips": [
      {
        "id": "<string>",
        "duration_seconds": 123,
        "title": "<string>",
        "virality_score": 50,
        "thumbnail_url": "<string>",
        "video_url": "<string>",
        "failure_message": "<string>"
      }
    ],
    "progress": 0,
    "callback_id": "<string>",
    "created_at": 123,
    "failure_message": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

job_id
string
required

Unique AI clip job identifier

Response

Successful response

data
AiClippingDetail · object

Full job resource. Returned by Get / List / webhook payloads.

Field naming mirrors VideoTranslationDetail (movio/api_service/app/controller/video_translate_v3_dto.py).