HEheygen
AI Clipping

Create AI Clipping

Changed on

Submit a source video and return a job id immediately. The job runs asynchronously and produces one or more short clips. Highlights are picked from the spoken dialogue, so music-only or silent videos fail. Clips are 20 seconds or longer; output_settings.duration_types picks the length bands (30, 60, 180, long). Check progress with GET /v3/ai-clipping/{job_id}, or subscribe to the ai_clipping.success / ai_clipping.fail webhooks.

post/v3/ai-clipping

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/ai-clipping
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

Idempotency-Keystring

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.

Request body

titlestring nullable

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

input_languagestring nullable

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

callback_urlstring nullable

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_idstring nullable

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

Response

Accepted — submission acknowledged; poll for completion.

Changes

  • 7dfa5e59b4f5Revision changes
    • info

      added asset_id url discriminator mapping keys to the request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status