---
title: "Get AI Clipping"
method: GET
path: "/v3/ai-clipping/{job_id}"
tags: ["AI Clipping"]
---

# Get AI Clipping

`GET /v3/ai-clipping/{job_id}`

## Request

- Base URL: `https://api.heygen.com`
- URL: `https://api.heygen.com/v3/ai-clipping/{job_id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Returns the full job resource including produced clips, statuses, and presigned download URLs.

## Path parameters

- `job_id` string, required

## Response `200`

Successful response

- object
  - `data` AiClippingDetail: Full job resource returned by Get, List, and webhook payloads.
    - `id` string, required: Unique job identifier.
    - `title` string, nullable: Display title.
    - `status` 'pending' | 'running' | 'completed' | 'failed' | 'cancelled', required: Public job lifecycle.
    - `input_language` string, nullable: Detected or supplied source language code.
    - `source_duration` number, nullable: Duration of the source video in seconds.
    - `output_settings` HighlightOutputSettings: Configuration for the clips the job will produce.
      - `duration_types` OutputDuration[]: One or more target clip length bands. Each produced clip is matched to one of the selected bands.
      - `aspect_ratio` 'landscape' | 'portrait' | 'square': Output aspect ratio for produced clips.
      - `captions` boolean: Burn captions into the clips. Set false to disable.
      - `caption_style` 'subtle_gray' | 'shadow_mint' | 'subtle_cyan' | 'stamp_red' | 'retro_gold' | 'block_dark' | 'racing' | 'modern_dark' | 'modern_boxed' | 'chunky' | 'clean' | 'shadow_lime' | 'tag_yellow' | 'pop_purple' | 'spotlight' | 'outline_classic' | 'exotic' | 'golden' | 'simple' | 'pop_single' | 'energy' | 'bold' | 'elegant' | 'neon_pink': Available caption style presets.
      - `prompt` string, nullable: Optional editorial guidance for the highlight model. Max 500 characters.
    - `clips` Clip[]: Produced clips. Empty until the job's first clip is rendered.
      - `id` string, required: Unique clip identifier.
      - `status` 'pending' | 'completed' | 'failed', required: Per-clip lifecycle. A job can produce N clips, each completing separately.
      - `duration_seconds` number, nullable: Final clip duration in seconds. Null until status=completed.
      - `aspect_ratio` 'landscape' | 'portrait' | 'square': Output aspect ratio for produced clips.
      - `title` string, nullable: Model-generated clip title.
      - `virality_score` integer, nullable: Model-predicted virality score (0-100). Null until status=completed.
      - `thumbnail_url` string, nullable: Presigned thumbnail URL. Null until status=completed.
      - `video_url` string, nullable: Presigned MP4 download URL. Null until status=completed.
      - `failure_message` string, nullable: Per-clip failure description. Currently always null.
    - `progress` integer: Approximate progress (0-100). 100 when all clips completed. GET /v3/ai-clipping/{id} returns live in-flight progress; the list endpoint reports a coarse value (0 until completed, then 100). Poll the single-get endpoint for granular progress.
    - `callback_id` string, nullable: Client-provided callback ID.
    - `created_at` integer, nullable: Unix timestamp (seconds) of job creation.
    - `failure_message` string, nullable: Error description. Only present when status=failed.

## Other responses

- `400`: Invalid request parameters
- `401`: Authentication failed
- `404`: Resource not found
- `429`: Rate limit exceeded

## Changes

- **2026-11-03** `7dfa5e59b4f5`: 8 info
  - added the optional property `error/errors` to the response with the `400` status
  - added the optional property `error/errors` to the response with the `401` status
  - added the optional property `error/errors` to the response with the `404` status
  - added the optional property `error/errors` to the response with the `429` status
  - …4 more

[Operation history](https://skmtc.dev/heygen/apis/heygen-external-api/changes/v3/ai-clipping/:job_id/get.md)

---

[API](https://skmtc.dev/heygen/apis/heygen-external-api.md) - [All operations](https://skmtc.dev/heygen/apis/heygen-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/heygen/apis/heygen-external-api/revisions/7dfa5e59b4f5?raw)