> ## Documentation Index > Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Create AI Clipping > Submit a source video and return a job id immediately. The job runs asynchronously and produces one or more short clips per the requested output_settings. Poll GET /v3/ai-clipping/{id}. ## OpenAPI ````yaml /openapi/external-api.json post /v3/ai-clipping openapi: 3.1.0 info: title: HeyGen External API version: 1.0.0 description: >- HeyGen's external API for programmatic AI video creation. See https://docs.heygen.com for full documentation. contact: name: HeyGen Product Infra url: https://heygen.com servers: - url: https://api.heygen.com description: Production security: - ApiKeyAuth: [] - BearerAuth: [] tags: - name: Video Agent description: Create videos from text prompts using AI - name: Videos description: Create, list, retrieve, and delete videos - name: Voices description: Text-to-speech and voice management - name: Audio description: Search the background-music and sound-effects catalog - name: Video Translate description: Translate videos into other languages - name: User description: Account information and billing - name: Avatars description: List and manage avatars and looks - name: Avatar Realtime description: >- Low-latency streaming avatar sessions — create a stream, poll for its HLS URL, push text, consume per-word timestamps - name: Assets description: Upload files for use in video creation - name: Webhooks description: Manage webhook endpoints and events - name: Lipsync description: Dub or replace audio on existing videos - name: Brand description: >- Brand-related resources — brand kits (colors, fonts, logos) and brand glossaries (custom term translations) - name: HyperFrames description: Render HyperFrames composition zips into video — separate from /v3/videos - name: AI Clipping description: Turn long-form videos into ready-to-share short clips with captions paths: /v3/ai-clipping: post: tags: - AI Clipping summary: Create AI Clipping description: >- Submit a source video and return a job id immediately. The job runs asynchronously and produces one or more short clips per the requested output_settings. Poll GET /v3/ai-clipping/{id}. operationId: createAiClippingV3 parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAiClippingRequest' responses: '202': description: Accepted — submission acknowledged; poll for completion. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CreateAiClippingResponse' '400': description: Invalid request parameters content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' example: error: code: invalid_parameter message: Source video URL is unsupported or unreachable. param: video doc_url: null '401': description: Authentication failed content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' example: error: code: authentication_failed message: Invalid or expired API key. Verify your x-api-key header. param: null doc_url: null '409': $ref: '#/components/responses/IdempotencyInProgress' '429': description: Rate limit exceeded content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' example: error: code: rate_limit_exceeded message: >- Too many requests. Retry after the duration specified in the Retry-After header. param: null doc_url: null headers: Retry-After: description: Seconds to wait before retrying schema: type: integer security: - ApiKeyAuth: [] - BearerAuth: [] components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- 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. schema: type: string pattern: ^[A-Za-z0-9_\-:.]{1,255}$ maxLength: 255 minLength: 1 example: 550e8400-e29b-41d4-a716-446655440000 schemas: CreateAiClippingRequest: additionalProperties: false description: Request body for POST /v3/ai-clipping. properties: video: description: Source video. Either a URL or an asset_id from POST /v1/asset. discriminator: mapping: asset_id: $ref: '#/components/schemas/AssetId' url: $ref: '#/components/schemas/AssetUrl' propertyName: type oneOf: - $ref: '#/components/schemas/AssetUrl' - $ref: '#/components/schemas/AssetId' title: Video title: anyOf: - maxLength: 255 type: string - type: 'null' default: null description: Title for the job. Defaults to the source video's title if omitted. title: Title input_language: anyOf: - type: string - type: 'null' default: null description: >- ISO-639-1 source language code (e.g. 'en', 'es'). Omit for auto-detect. title: Input Language output_settings: $ref: '#/components/schemas/HighlightOutputSettings' description: >- Configuration for the produced clips (duration mix, aspect ratio, captions, etc.). required: - video title: CreateAiClippingRequest type: object CreateAiClippingResponse: description: >- Response for POST /v3/ai-clipping. Mirrors the v3 single-ID create shape. properties: ai_clipping_id: description: Unique job identifier. Use with all other endpoints. title: Ai Clipping Id type: string required: - ai_clipping_id title: CreateAiClippingResponse type: object StandardAPIError: type: object properties: code: type: string description: Machine-readable error code example: invalid_parameter message: type: string description: Human-readable error message example: Video not found param: type: - string - 'null' description: Which request field caused the error doc_url: type: - string - 'null' description: Link to error documentation required: - code - message AssetId: additionalProperties: false description: Asset input via HeyGen asset ID from the asset upload endpoint. properties: type: const: asset_id description: Input type discriminator title: Type type: string asset_id: description: HeyGen asset ID from the asset upload endpoint title: Asset Id type: string required: - type - asset_id title: AssetId type: object AssetUrl: additionalProperties: false description: Asset input via publicly accessible HTTPS URL. properties: type: const: url description: Input type discriminator title: Type type: string url: description: Publicly accessible HTTPS URL for the asset title: Url type: string required: - type - url title: AssetUrl type: object HighlightOutputSettings: additionalProperties: false description: >- Configuration for the clips the job will produce. Public projection of the internal ``HighlightOutputSettings`` (heygen/temporal/workflow/model/instant_highlight.py:27), minus internal-only fields (``caption_config`` — internal StyleConfig from the frontend, not part of the public contract). properties: duration_types: description: >- One or more target clip durations to produce. Each produces a separate clip. items: $ref: '#/components/schemas/OutputDuration' maxItems: 4 minItems: 1 title: Duration Types type: array aspect_ratio: $ref: '#/components/schemas/OutputAspectRatio' default: portrait description: >- Aspect ratio for all produced clips. Default 'portrait' (9:16, social-ready). captions: default: true description: Burn captions into the clips. Set false to disable. title: Captions type: boolean caption_style: anyOf: - type: string - type: 'null' default: null description: >- Named caption style preset (e.g. 'classic', 'bold'). Omit for the default style. title: Caption Style prompt: anyOf: - maxLength: 500 type: string - type: 'null' default: null description: >- Optional editorial guidance for the highlight model. Max 500 characters. title: Prompt title: HighlightOutputSettings type: object OutputDuration: description: Target clip duration. ``long`` returns the model's choice >180s. enum: - '30' - '60' - '180' - long title: OutputDuration type: string OutputAspectRatio: description: Output aspect ratio for produced clips. enum: - landscape - portrait - square title: OutputAspectRatio type: string responses: IdempotencyInProgress: description: >- A prior request with this Idempotency-Key is still in progress. Wait for the original request to complete, then retry. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/StandardAPIError' example: error: code: request_in_progress message: >- A request with this Idempotency-Key is already in progress. Retry shortly. param: null doc_url: null securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: HeyGen API key. Obtain from your HeyGen dashboard. BearerAuth: type: http scheme: bearer description: OAuth2 bearer token. ````