latestOpenAPI 3.1.12026-08-22330162.7 KB

35448566f143

UGC

Create a UGC hook video

Builds a finished UGC-style hook video: a person reaction clip with your hook text on top, optionally followed by your product demo video.

Inputs:

reactionId: a clip from GET /ugc/reactions (built-in or one you generated).
hookText: the on-screen hook (5-200 characters).
demoVideoAssetId (optional): a product demo video uploaded with POST /uploads (purpose ugc-demo).

Returns a videoId. This one is ready immediately (status: completed); export it with POST /exports and download with GET /exports/download, or publish it.

Cost: flat fee (see creditsUsed). Requires an active paid subscription.

post/ugc/videos

Request body

hookTextstring required

The on-screen hook text (5-200 characters).

reactionIdstring uuid

A reaction clip from GET /ugc/reactions.

ugcVideoIdstring uuid

Dashboard alias for reactionId. Public callers use reactionId.

demoVideoAssetIdstring uuid

Optional product demo video, uploaded via POST /uploads (purpose ugc-demo). Plays after the reaction.

demoVideoUrlstring uri

Dashboard use only. Public callers pass demoVideoAssetId instead.

demoDurationSecondsnumber

Dashboard use only. Required when demoVideoUrl is set.

demoVideoWidthinteger

Dashboard use only.

demoVideoHeightinteger

Dashboard use only.

hookTextPosition'top' | 'center' | 'bottom'

Where the hook text sits.

aspectRatio'9:16' | '16:9' | '1:1'

Video dimensions.

backgroundMusicIdstring uuid

Dashboard use only. Background music track ID.

backgroundMusicVolumenumber

Dashboard use only. Background music volume (0-100).

captionStyleIdstring

Caption style ID from GET /caption-styles. Default: "tiktok".

titlestring

Optional video title.

Response

videoIdstring uuid required

The finished video. Export with POST /exports, download with GET /exports/download.

status'completed' required

creditsUsednumber required

durationSecondsnumber required