---
title: "AI Clipper analysis of a long video. `settings` may be left out: the account's caption style and automatic framing are used."
method: POST
path: "/clipper/plans"
tags: ["AI Clipper"]
---

# AI Clipper analysis of a long video. \`settings\` may be left out: the account's caption style and automatic framing are used.

`POST /clipper/plans`

## Request

- Base URL: `https://wowreveal.com/api/v1`
- URL: `https://wowreveal.com/api/v1/clipper/plans`
- Auth: HTTP bearer

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `source` object, required
    - `url` string, nullable
    - `uploadId` union
      - string, uuid
      - ''
    - `name` string, nullable
  - `targetSeconds` number, required
  - `maxClips` integer, required
  - `language` string, required
  - `settings` object
    - `captionStyle` string
    - `layout` 'auto' | 'focus' | 'general' | 'split' | 'screen'
    - `headline` boolean
    - `progressBar` boolean
    - `trimPauses` boolean
    - `music` union
      - string
      - integer
    - `logoAssetId` integer, nullable
    - `captionPosition` 'low' | 'middle' | 'high'

## Response `201`

Success

- object
  - `plan` ClipPlan, required
    - `id` string, required
    - `status` 'queued' | 'analyzing' | 'ready' | 'failed' | 'expired', required
    - `progress` integer
    - `candidates` object[]
      - `id` string
      - `title` string
      - `score` number
      - `startSec` number
      - `endSec` number
      - `durationSec` number
      - `reason` string
      - `thumbnailUrl` string, nullable
    - `generatedProjectIds` string[]
    - `creditsCharged` integer
    - `errorCode` string, nullable
  - `balance` integer, required

## Other responses

- `400`: Invalid request (VALIDATION_ERROR and other 400 codes).
- `401`: Missing or revoked API key (INVALID_API_KEY).
- `403`: The plan has no API access, or the account is blocked.
- `429`: Rate limit (RATE_LIMITED) — see the Retry-After header.

---

[API](https://skmtc.dev/wowreveal/apis/wowreveal-rest-api.md) · [All operations](https://skmtc.dev/wowreveal/apis/wowreveal-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/wowreveal/apis/wowreveal-rest-api/revisions/cb44d779f713?raw)