Create Video

Overview

Create a new video by sending a POST request to /v1/project/create. Hooked supports multiple video types — each with its own parameters.

Video processing typically takes 2-5 minutes. Use a webhook to get notified when your video is ready.

Endpoint

POST https://api.hooked.so/v1/project/create

Common Parameters

Parameter	Type	Required	Description
`type`	string	Yes	Video type (see below)
`name`	string	No	Video title
`script`	string	Varies	Narration text
`avatarId`	string	Varies	Avatar to use
`voiceId`	string	Varies	Voice for narration
`aspectRatio`	string	No	`ratio_9_16` (default) or `ratio_16_9`
`captions`	boolean	No	Enable auto captions
`music`	string	No	Background music ID
`webhook`	string	No	Completion notification URL

Video Types

Each type has a dedicated endpoint guide with full parameters:

Talking Avatar

UGC-style talking avatar videos

Script to Video

Convert scripts to videos with AI visuals

UGC Ads

User-generated content style ads, including website and app demos

Hook + Demo

Hook intro with product demo

Scenes

Multi-scene template videos

Prompt to Video

Generate from a text prompt

TikTok Slideshow

TikTok-style slideshow videos

Add Captions

Add captions to existing video

Extend Video

Extend an existing video

Remove Background

Remove video background

Website and app demo videos (an avatar presenting while your site or app is shown) are the app_demo format of UGC Studio. Use the UGC Ads endpoint for them.

Quick Example

curl -X POST "https://api.hooked.so/v1/project/create" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "class",
    "name": "My Tutorial",
    "script": "Hello! Welcome to this tutorial.",
    "avatarId": "avatar_sarah_01",
    "voiceId": "tzX5paJ07p5hyWFcU3uG",
    "webhook": "https://your-domain.com/webhook"
  }'

Response

{
  "success": true,
  "message": "Project created successfully",
  "data": {
    "projectId": "proj_abc123",
    "status": "processing",
    "estimatedTime": "3-5 minutes"
  }
}

Get Video Details

Check video status

List Videos

View all videos

Webhook

Receive completion notifications

Quickstart

End-to-end tutorial

Getting Started

Resources

Videos

Images

Templates

Social Accounts

Scheduling

Overview

Endpoint

Common Parameters

Video Types

Talking Avatar

Script to Video

UGC Ads

Hook + Demo

Scenes

Prompt to Video

TikTok Slideshow

Add Captions

Extend Video

Remove Background

Quick Example

Response

Get Video Details

List Videos

Webhook

Quickstart

​Overview

​Endpoint

​Common Parameters

​Video Types

Talking Avatar

Script to Video

UGC Ads

Hook + Demo

Scenes

Prompt to Video

TikTok Slideshow

Add Captions

Extend Video

Remove Background

​Quick Example

​Response

​Related

Get Video Details

List Videos

Webhook

Quickstart

Overview

Endpoint

Common Parameters

Video Types

Quick Example

Response

Related