> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hooked.so/llms.txt
> Use this file to discover all available pages before exploring further.
# Clone Video
> Remake a TikTok, Instagram or YouTube video with your own voice and new AI visuals
## Overview
Clone Video takes a short video that works (a TikTok, an Instagram Reel, a YouTube Short or video) and makes a new one in its image: Hooked analyses its story, structure and pacing, writes a new narration from it, reads it with your voice and generates a new visual for each scene. The look is taken from the source video, so there is no style preset to pick: you choose AI images or AI video clips, and optionally the model.
What it does not do: it does not copy the original's voice, music or footage, and it cannot clone a video that is private, deleted or behind a login.
* `sourceVideoUrl` is a TikTok, Instagram or YouTube link. Any other host answers `400`.
* `targetDurationSeconds` sets the length of the new video (default 30 seconds) and its price.
* `mustInclude` is something the new video has to mention, such as your product or a call to action.
The request returns a `projectId` right away. The video is analysed, generated and rendered in the background.
```
POST https://api.hooked.so/v1/project/create/clone-video
```
***
```bash cURL theme={null}
curl -X POST "https://api.hooked.so/v1/project/create/clone-video" \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"sourceVideoUrl": "https://www.tiktok.com/@hooked.so/video/7412345678901234567",
"voiceId": "1004",
"targetDurationSeconds": 30,
"mustInclude": "End with: try Hooked free",
"mediaType": "ai-images",
"aspectRatio": "ratio_9_16",
"caption": { "preset": "tiktok" },
"webhook": "https://example.com/hooked/webhook?token=YOUR_SECRET",
"metadata": { "campaign": "spring" }
}'
```
```javascript JavaScript theme={null}
const response = await fetch("https://api.hooked.so/v1/project/create/clone-video", {
method: "POST",
headers: {
"x-api-key": "your_api_key_here",
"Content-Type": "application/json",
},
body: JSON.stringify({
sourceVideoUrl: "https://www.tiktok.com/@hooked.so/video/7412345678901234567",
voiceId: "1004",
targetDurationSeconds: 30,
mustInclude: "End with: try Hooked free",
mediaType: "ai-images",
aspectRatio: "ratio_9_16",
caption: { preset: "tiktok" },
webhook: "https://example.com/hooked/webhook?token=YOUR_SECRET",
metadata: { campaign: "spring" },
}),
});
const { data } = await response.json();
console.log(data.projectId);
```
```python Python theme={null}
import requests
response = requests.post(
"https://api.hooked.so/v1/project/create/clone-video",
headers={"x-api-key": "your_api_key_here"},
json={
"sourceVideoUrl": "https://www.tiktok.com/@hooked.so/video/7412345678901234567",
"voiceId": "1004",
"targetDurationSeconds": 30,
"mustInclude": "End with: try Hooked free",
"mediaType": "ai-images",
"aspectRatio": "ratio_9_16",
"caption": {"preset": "tiktok"},
"webhook": "https://example.com/hooked/webhook?token=YOUR_SECRET",
"metadata": {"campaign": "spring"},
},
)
print(response.json()["data"]["projectId"])
```
### More request bodies
```json AI video clips theme={null}
{
"sourceVideoUrl": "https://www.youtube.com/shorts/aBcD1234EfG",
"voiceId": "1004",
"targetDurationSeconds": 45,
"mediaType": "ai-videos",
"presetSettings": { "quality": "pro" }
}
```
```json A chosen image model, horizontal theme={null}
{
"sourceVideoUrl": "https://www.instagram.com/reel/C9xYz123AbC/",
"voiceId": "1004",
"mediaType": "ai-images",
"presetSettings": { "aiModel": "nano_banana_pro" },
"aspectRatio": "ratio_16_9"
}
```
***
```json 200 theme={null}
{
"success": true,
"data": {
"projectId": "cm4x9k2p10001ab12cd34ef56",
"status": "processing"
},
"message": "Clone Video successfully created"
}
```
```json 400 theme={null}
{
"success": false,
"message": "sourceVideoUrl: Only TikTok, Instagram, and YouTube URLs are supported"
}
```
```json 401 theme={null}
{
"code": "not_authenticated",
"message": "Not authenticated",
"errorCode": "NOT_AUTHENTICATED",
"details": { "x-api-key": "Header not provided or API Key invalid" }
}
```
```json 402 missing keys theme={null}
{
"code": "missing_credentials",
"message": "Your team uses its own provider keys (BYOK) and these are missing or invalid: OpenRouter, ElevenLabs. Add them in Settings → AI keys.",
"errorCode": "MISSING_CREDENTIALS",
"missingProviders": ["openrouter", "elevenlabs"],
"details": {}
}
```
```json 402 credits theme={null}
{
"success": false,
"errorCode": "INSUFFICIENT_CREDITS",
"message": "Not enough credits for Clone Video. Needed: 90, Available: 45",
"creditsNeeded": 90,
"creditsAvailable": 45
}
```
```json 403 theme={null}
{
"code": "entitlement_required",
"error": "entitlement_required",
"message": "This endpoint requires the \"app\" product.",
"product": "app"
}
```
***
## What happens next
1. Keep the `projectId`.
2. Either poll [`GET /v1/project/{projectId}`](/api-reference/project/details) until `video.status` is `COMPLETED` (or the project `status` is `failed`), or pass a `webhook` and wait for the call.
3. Download the file from `video.url` (or `data.url` in the webhook).
If the source video cannot be read (private, deleted, region-locked), the project fails, the webhook is called with `"status": "FAILED"` and the credits are refunded. See [Webhooks](/guides/webhooks) for every payload.
***
## Credits and your own keys
**Teams on Hooked's keys (managed):** the project is priced from `targetDurationSeconds`, the media type and the quality or model, and the credits are taken up front. If the balance is short, the request answers `402 INSUFFICIENT_CREDITS` with `creditsNeeded` and `creditsAvailable` and nothing is created. If the project fails later, the credits are refunded automatically.
**Teams on their own keys (BYOK):** no credits are charged. The team needs these keys in **Settings → AI keys**:
* **OpenRouter**: always (analysis, script, images, video clips, captions).
* **ElevenLabs**: for the voiceover.
* **Gemini**: when `presetSettings.aiModel` is `gemini_omni_flash`.
A missing key answers `402 missing_credentials` with the list in `missingProviders`, before anything is created.
***
## Errors
| Status | Body | When |
| - | - | - |
| `400` | `{ "success": false, "message": ": " }` | Validation failed. Examples: `sourceVideoUrl: Required (a TikTok, Instagram or YouTube video URL)`, `sourceVideoUrl: Only TikTok, Instagram, and YouTube URLs are supported`, `voiceId: Voice "…" not found.`, `musicId: Music "…" not found.`, `mediaType: Invalid media type "…". Allowed values are: ai-images, ai-videos`, `presetSettings.aiModel: "…" does not generate ai-videos`, `caption.preset: Invalid caption preset "…"`, `cloneVideoSettings.targetDurationSeconds: …` (outside 1-600), `webhook: Must be a valid HTTPS URL`, `Invalid JSON body`. |
| `401` | `not_authenticated` | Missing or invalid `x-api-key`. |
| `402` | `missing_credentials` | BYOK team without the keys listed above. |
| `402` | `subscription_required` | Managed team without an active plan. |
| `402` | `INSUFFICIENT_CREDITS` | Managed team without enough credits. |
| `403` | `entitlement_required` | The team does not have the product this endpoint needs. |
| `500` | `{ "success": false, "message": "..." }` | Unexpected error; credits taken for this request are refunded. |
Send an [`Idempotency-Key`](/guides/idempotency) header to retry safely: if a request times out or answers 5xx, sending it again with the same key and body returns the first answer instead of creating (and charging) the project twice.
***
## Next Steps
Follow the project until the video is ready
More requests for this format
Pick a voice
Bring your own script instead
## OpenAPI
````yaml POST /v1/project/create/clone-video
openapi: 3.0.0
info:
title: Hooked API
version: 1.0.0
description: AI Video Generation API
servers:
- url: https://api.hooked.so
security:
- ApiKeyAuth: []
tags:
- name: Videos
description: Create projects, follow them and render videos
- name: Account Analysis
description: Analyze TikTok and YouTube accounts
- name: Channels
description: Connected social accounts you publish to
- name: Publish
description: Schedule videos to your connected accounts
- name: Images
description: 'Image editing: background removal and expansion'
- name: Media
description: 'Your media library: list, import from a URL, upload a file'
- name: Avatars
description: Your team's own avatars (Actors) and their Hook + Demo reactions
paths:
/v1/project/create/clone-video:
post:
tags:
- Videos
summary: Create Clone Video
description: >-
Makes a new video in the style of an existing TikTok, Instagram or
YouTube video: its structure, pacing and look are analysed and remade
with your voice, a new script and AI visuals. Returns a `projectId`
right away; the video is generated and rendered in the background. BYOK:
needs OpenRouter and ElevenLabs; `aiModel: "gemini_omni_flash"` also
needs Gemini.
A body that is not valid JSON answers 400 (`Invalid JSON body`). Create
endpoints are not idempotent: do not retry a POST on a timeout or 5xx
without first checking your projects, or you may create (and pay for)
the video twice.
operationId: createCloneVideo
parameters:
- $ref: '#/components/parameters/IdempotencyKey'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- sourceVideoUrl
- voiceId
properties:
sourceVideoUrl:
type: string
format: uri
maxLength: 2000
description: >-
The video to clone: a TikTok, Instagram or YouTube link. Any
other host answers 400 (`sourceVideoUrl: Only TikTok,
Instagram, and YouTube URLs are supported`).
voiceId:
type: string
minLength: 1
maxLength: 30
description: >-
The narrator: a library voice from /v1/voice/list or one of
your team's custom voices. An ID that is neither answers 400
(`voiceId: Voice "" not found.`).
targetDurationSeconds:
type: integer
minimum: 1
maximum: 600
default: 30
description: Length of the new video in seconds. It also sets the price.
mustInclude:
type: string
maxLength: 500
description: >-
Something the new video has to mention or show, e.g. your
product or a call to action (max 500 characters).
mediaType:
type: string
enum:
- ai-images
- ai-videos
default: ai-images
description: >-
`ai-images`: one AI image per scene. `ai-videos`: one AI
video clip per scene, chained frame to frame. Any other
value answers 400.
presetSettings:
type: object
description: >-
The model of the visuals. The style is taken from the source
video, so there is no `preset`.
properties:
quality:
type: string
enum:
- base
- pro
- ultra
default: pro
description: >-
`ai-videos`: picks the video model when `aiModel` is not
set. Not used by `ai-images` (use `aiModel`).
aiModel:
type: string
enum:
- nano_banana
- nano_banana_2
- nano_banana_pro
- seedream_4_5
- seedream_5_0
- gpt_image_2
- grok_imagine_image
- seedance_1_5_pro
- seedance_2_0
- seedance_2_0_mini
- seedance_2_0_fast
- kling_3_0
- veo_3_fast
- veo_3
- veo_3_1_lite
- wan_2_7_i2v
- grok_imagine_video
- gemini_omni_flash
description: >-
`ai-images` / `ai-videos`: the model that generates the
media, instead of the default. It must match
`mediaType`, otherwise the request answers 400
(`presetSettings.aiModel: "" does not generate
`).
- `ai-images`: `nano_banana`, `nano_banana_2`,
`nano_banana_pro`, `seedream_4_5`, `seedream_5_0`,
`gpt_image_2`, `grok_imagine_image`.
- `ai-videos`: `seedance_1_5_pro`, `seedance_2_0`,
`seedance_2_0_mini`, `seedance_2_0_fast`, `kling_3_0`,
`veo_3_fast`, `veo_3`, `veo_3_1_lite`, `wan_2_7_i2v`,
`grok_imagine_video`, `gemini_omni_flash`.
BYOK: `gemini_omni_flash` needs the Gemini key.
name:
type: string
maxLength: 100
description: >-
Project name (max 100 characters). Generated from the source
when omitted.
musicId:
type: string
maxLength: 30
description: >-
Background music: a track from /v1/music/list or your team's
own uploaded music. An ID that is neither answers 400
(`musicId: Music "" not found.`).
aspectRatio:
type: string
enum:
- ratio_9_16
- ratio_16_9
- ratio_1_1
default: ratio_9_16
description: Vertical, horizontal or square.
language:
type: string
description: Two-letter ISO 639-1 code of the narration, e.g. `en`, `es`.
caption:
type: object
description: >-
Burned-in captions of the narration. Not used with
`motion-graphics` (it typesets its own copy) or a speaking
cast.
properties:
preset:
type: string
enum:
- default
- beast
- umi
- tiktok
- wrap1
- wrap2
- ariel
- hooked
- classic
- active
- bubble
- glass
- comic
- glow
- pastel
- neon
- retroTV
- red
- marker
- modern
- blue
- vivid
default: wrap1
description: Caption style. Any other value answers 400.
alignment:
type: string
enum:
- top
- middle
- bottom
default: bottom
description: Caption position.
disabled:
type: boolean
default: false
description: '`true` renders the video without captions.'
addStickers:
type: boolean
default: false
description: >-
Add emoji/GIF stickers anchored to the captions. Not used
with `motion-graphics` or a speaking cast.
content:
type: object
description: Branding.
properties:
brandingLogo:
type: object
description: >-
Your logo over the whole video. Drawn only with
`enabled: true` and a `url`.
properties:
enabled:
type: boolean
default: false
url:
type: string
description: >-
Public URL of the logo image (PNG with transparency
works best).
position:
type: string
enum:
- top-left
- top-right
- bottom-left
- bottom-right
default: bottom-right
size:
type: number
minimum: 20
maximum: 200
default: 100
description: Logo size (20-200).
webhook:
type: string
maxLength: 500
format: uri
description: >-
HTTPS URL on a public host, called when the video is ready
or the project fails (max 500 characters). Requests are
signed: verify the Hooked-Signature header (HMAC-SHA256 of
".") with the signing secret from Settings →
Webhooks; Hooked-Event and Hooked-Delivery headers name the
event and the delivery. No redirects are followed; 10 s
timeout; 3 immediate attempts. See the Webhooks guide for
the payload.
metadata:
type: object
additionalProperties: true
description: >-
Any JSON object of your own (max 5 KB). Stored on the
project and sent back in the webhook payload. The key
`automationId` is reserved for dashboard automations and is
removed.
audio:
type: object
description: >-
Narrator voice settings (ElevenLabs). Any field you leave
out keeps its default. Not used by a speaking cast.
properties:
speed:
type: number
minimum: 0.7
maximum: 1.2
default: 1
description: Speaking speed.
stability:
type: number
minimum: 0
maximum: 1
default: 0.5
description: Higher is steadier, lower is more expressive.
similarityBoost:
type: number
minimum: 0
maximum: 1
default: 0.75
description: How closely the voice sticks to the original.
example:
sourceVideoUrl: https://www.tiktok.com/@hooked.so/video/7412345678901234567
voiceId: '1'
targetDurationSeconds: 30
mustInclude: 'End with: try Hooked free'
mediaType: ai-images
aspectRatio: ratio_9_16
webhook: https://yoursite.com/webhook?token=YOUR_SECRET
responses:
'200':
description: >-
Project created. Follow it with GET /v1/project/{projectId} or wait
for the webhook.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectCreateResponse'
example:
success: true
data:
projectId: clx9p2k4m0001abcd1234efgh
status: processing
message: Clone Video successfully created
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'402':
$ref: '#/components/responses/PaymentRequired'
'403':
$ref: '#/components/responses/EntitlementRequired'
'409':
$ref: '#/components/responses/IdempotencyInProgress'
'422':
$ref: '#/components/responses/IdempotencyMismatch'
'429':
$ref: '#/components/responses/RateLimited429'
'500':
$ref: '#/components/responses/InternalError'
security:
- ApiKeyAuth: []
components:
parameters:
IdempotencyKey:
name: Idempotency-Key
in: header
required: false
description: >-
Makes the request safe to retry. 1-255 printable ASCII characters, one
per operation (your job id, or a UUID you store), reused on every retry.
Within 24 hours the same key with the same body answers with the first
response and the header `Idempotent-Replayed: true`, without running or
charging again. Keys are scoped to your team and the endpoint. 5xx
answers and refusals before anything ran (401, 402, 403, 409, 429) are
not kept. See [Idempotency](/guides/idempotency).
schema:
type: string
minLength: 1
maxLength: 255
pattern: ^[\x20-\x7E]+$
example: order-1042-video
schemas:
ProjectCreateResponse:
type: object
properties:
success:
type: boolean
enum:
- true
data:
type: object
properties:
projectId:
type: string
description: Follow it with GET /v1/project/{projectId}
status:
type: string
enum:
- draft
- processing
- completed
- failed
description: >-
The project status right after creation, usually `draft` or
`processing`. Follow it with GET /v1/project/{projectId}.
required:
- projectId
- status
message:
type: string
required:
- success
- data
- message
ValidationError400:
type: object
description: >-
The request is invalid. `message` is `: ` when a field is
to blame.
properties:
success:
type: boolean
enum:
- false
message:
type: string
required:
- success
- message
example:
success: false
message: 'webhook: Must be a valid HTTPS URL'
Error401:
type: object
description: Missing or invalid `x-api-key`.
properties:
code:
type: string
enum:
- not_authenticated
message:
type: string
example: Not authenticated
errorCode:
type: string
enum:
- NOT_AUTHENTICATED
details:
type: object
additionalProperties:
type: string
example:
code: not_authenticated
message: Not authenticated
errorCode: NOT_AUTHENTICATED
details:
x-api-key: Header not provided or API Key invalid
MissingCredentials402:
type: object
description: >-
BYOK team without the provider keys this request uses. Nothing was
created or charged. Add the keys in Settings → AI keys.
properties:
success:
type: boolean
enum:
- false
description: Present when raised by the spend check
code:
type: string
enum:
- missing_credentials
errorCode:
type: string
enum:
- MISSING_CREDENTIALS
missingProviders:
type: array
items:
type: string
enum:
- openrouter
- elevenlabs
- gemini
- bria
- firecrawl
message:
type: string
details:
type: object
required:
- code
- errorCode
- missingProviders
- message
example:
code: missing_credentials
message: >-
Your team uses its own provider keys (BYOK) and these are missing or
invalid: OpenRouter, ElevenLabs. Add them in Settings → AI keys.
errorCode: MISSING_CREDENTIALS
missingProviders:
- openrouter
- elevenlabs
details: {}
SubscriptionRequired402:
type: object
description: Managed team (generates with Hooked's keys) without a live subscription.
properties:
success:
type: boolean
enum:
- false
code:
type: string
enum:
- subscription_required
errorCode:
type: string
enum:
- SUBSCRIPTION_REQUIRED
message:
type: string
required:
- success
- code
- errorCode
- message
example:
success: false
code: subscription_required
errorCode: SUBSCRIPTION_REQUIRED
message: >-
Your team generates with Hooked's keys, which are paid by your plan.
Subscribe to keep generating.
InsufficientCredits402:
type: object
description: >-
Not enough credits for this request. `creditsNeeded` /
`creditsAvailable` are included when the estimate is known.
properties:
success:
type: boolean
enum:
- false
errorCode:
type: string
enum:
- INSUFFICIENT_CREDITS
message:
type: string
creditsNeeded:
type: number
creditsAvailable:
type: number
required:
- success
- errorCode
- message
example:
success: false
errorCode: INSUFFICIENT_CREDITS
message: Not enough credits to perform this action
creditsNeeded: 40
creditsAvailable: 12
EntitlementRequired403:
type: object
description: >-
Valid key, but the team does not have the product this endpoint belongs
to.
properties:
code:
type: string
enum:
- entitlement_required
error:
type: string
enum:
- entitlement_required
message:
type: string
product:
type: string
example: app
required:
- code
- error
- message
- product
example:
code: entitlement_required
error: entitlement_required
message: This endpoint requires the "app" product.
product: app
Error500:
type: object
properties:
success:
type: boolean
enum:
- false
message:
type: string
error:
type: string
description: Present on some endpoints
example:
success: false
message: Internal server error
responses:
ValidationError:
description: Validation error (also `Invalid JSON body`)
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError400'
Unauthorized:
description: Missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error401'
PaymentRequired:
description: >-
Payment required: a BYOK team is missing provider keys (nothing was
created or charged), a managed team has no live subscription, or there
are not enough credits.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/MissingCredentials402'
- $ref: '#/components/schemas/SubscriptionRequired402'
- $ref: '#/components/schemas/InsufficientCredits402'
examples:
missingCredentials:
value:
code: missing_credentials
message: >-
Your team uses its own provider keys (BYOK) and these are
missing or invalid: OpenRouter, ElevenLabs. Add them in
Settings → AI keys.
errorCode: MISSING_CREDENTIALS
missingProviders:
- openrouter
- elevenlabs
details: {}
subscriptionRequired:
value:
success: false
code: subscription_required
errorCode: SUBSCRIPTION_REQUIRED
message: >-
Your team generates with Hooked's keys, which are paid by your
plan. Subscribe to keep generating.
insufficientCredits:
value:
success: false
errorCode: INSUFFICIENT_CREDITS
message: Not enough credits to perform this action
creditsNeeded: 40
creditsAvailable: 12
EntitlementRequired:
description: The team does not have the product this endpoint needs
content:
application/json:
schema:
$ref: '#/components/schemas/EntitlementRequired403'
IdempotencyInProgress:
description: >-
A request with the same `Idempotency-Key` is still running. Retry in a
few seconds.
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
enum:
- false
code:
type: string
message:
type: string
details:
type: object
additionalProperties: true
required:
- success
- code
- message
example:
success: false
code: idempotency_conflict
message: A request with this Idempotency-Key is still in progress
details: {}
IdempotencyMismatch:
description: >-
The `Idempotency-Key` was already used with a different body. Use a new
key for a new request.
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
enum:
- false
code:
type: string
message:
type: string
details:
type: object
additionalProperties: true
required:
- success
- code
- message
example:
success: false
code: idempotency_mismatch
message: Idempotency-Key was used with a different request
details: {}
RateLimited429:
description: >-
Your team is over a rate limit: 30 POST requests per minute, 120 other
requests per minute, or 3 downloads of your URLs running at once.
Nothing ran and nothing was charged: wait `Retry-After` seconds and send
the request again. See [Rate
limits](/guides/error-handling#rate-limits-429).
headers:
Retry-After:
description: Seconds to wait before sending again.
schema:
type: integer
X-RateLimit-Limit:
description: The limit of the bucket you hit (not sent for the download cap).
schema:
type: integer
X-RateLimit-Remaining:
description: 'Requests left in this window: 0 (not sent for the download cap).'
schema:
type: integer
X-RateLimit-Reset:
description: >-
When the window ends, in Unix seconds (not sent for the download
cap).
schema:
type: integer
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
enum:
- false
errorCode:
type: string
enum:
- RATE_LIMITED
message:
type: string
retryAfterSeconds:
type: integer
required:
- success
- errorCode
- message
- retryAfterSeconds
example:
success: false
errorCode: RATE_LIMITED
message: >-
Rate limit exceeded: 30 POST requests per minute per team. Retry
after 12 s.
retryAfterSeconds: 12
InternalError:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error500'
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.