Skip to main content

​
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

ParameterTypeRequiredDescription
typestringYesVideo type (see below)
namestringNoVideo title
scriptstringVariesNarration text
avatarIdstringVariesAvatar to use
voiceIdstringVariesVoice for narration
aspectRatiostringNoratio_9_16 (default) or ratio_16_9
captionsbooleanNoEnable auto captions
musicstringNoBackground music ID
webhookstringNoCompletion 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

Hook + Demo

Hook intro with product demo

Product Ads

Product showcase ads

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

​
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