UGC Vids AI

Generate a UGC video ad

Start rendering a UGC video ad. Returns a video id immediately; the render runs async (typically 3-10 minutes). Poll check_video_status with the id until status is 'ready', then use video_url. Costs credits from the account, quoted back to you in the response — call estimate_cost first if you want the price before committing. If a render fails, the credits are refunded automatically. TWO MODES: - mode 'actors' (default): the prompt is the SPOKEN SCRIPT. An actor delivers it to camera. A library

Check a render

Check a video render. Returns status (processing | ready | failed) and, when ready, the playable video_url. Renders take a few minutes; if it is still processing, tell the user you will check again rather than polling in a tight loop. Finished videos also stay available via list_videos.

List recent videos

List this account's most recent renders, newest first, with status and playable video_url. Use this to find a video whose id was lost earlier in the conversation, or to show the user what they already have.

Browse actors

Browse the stock actor library (202 actors). Returns id, name, style and gender. Pass an id as avatar_id to generate_video to pin that face across a batch of ads.

Generate a batch of ad variants

Render several variants in ONE call — the actual media-buyer workflow: the same script across different actors, or several hooks with one actor. Give either `prompts` (one video each) or a single `prompt` plus `avatar_ids` (same script, each actor). Max 9 per call. Every variant shares the model/duration/resolution/aspect settings. Returns one id per variant plus the total credits charged; poll them together with check_video_status's `ids`. Credits for any variant that fails to start are refunde

Tear down a winning ad

Reverse-engineer a winning short-form ad into its structure (hook / body / proof / cta / delivery) AND get a ready-to-record script rebuilt for the customer's own product. Pass a public TikTok link, any ad page link, or simply paste the spoken script. This is the swipe-file workflow: find an ad that works, understand WHY, rebuild it for your product, then feed the returned script straight into generate_video. Costs no credits.

Read saved brand kits

Read the account's saved Brand Kits (name, tone, colours, audience, dos and don'ts as configured in the dashboard). Call this BEFORE writing ad copy so the script matches the brand instead of asking the user to re-describe it every conversation.

List saved products

List the account's saved Products (name, description, image, URL as configured in the dashboard). Use these as the subject of an ad instead of asking the user to paste product details again.

Price a render before spending

Work out exactly what a render will cost in credits BEFORE generating, optionally for a batch. Works without an API key (so you can compare models and plan a budget first); with a key it also returns the live balance and how many renders it covers. Failed renders are always refunded, so a quoted cost is the worst case.

List video models

List available video models with their supported durations, resolutions, credit cost per render, and whether each needs an input image.

Check credit balance

Get the account's current credit balance and plan.