Sign in
latestOpenAPI 3.1.12026-08-22330162.7 KB

35448566f143

UGC

Generate a UGC reaction clip

Generates a short clip of your character reacting to camera, using image-to-video AI. The character is one of your character elements (create one with POST /elements).

Flow: create the reaction, then poll GET /ugc/reactions/{id} until status is completed. The finished clip also appears in GET /ugc/reactions and can be used as reactionId in POST /ugc/videos.

Cost: by quality (see the response creditsUsed). Credits are refunded automatically if generation fails.

Requires an active paid subscription.

post/ugc/reactions

Request body

avatarImageUrlstring uri

Dashboard use only. Public callers pass elementId instead; an avatarImageUrl from the public API must be an AITuber-hosted asset URL.

elementIdstring uuid

The character element to react. Get IDs from GET /elements (type character) or create one with POST /elements.

avatarIdstring uuid

Legacy avatar ID. Prefer elementId.

reactionPromptstring

Direct control over the reaction, e.g. "shocked, eyes wide, leaning back". Provide this OR hookText.

hookTextstring

The hook the character is reacting to. The AI turns it into a fitting expression. Provide this OR reactionPrompt.

quality'good' | 'premium'

Generation quality. premium costs more and looks better.

Response

OK

reactionVideoIdstring uuid required

Poll GET /ugc/reactions/{id} until completed.

status'pending' required
creditsUsednumber required
namestring required

AI-generated name for the reaction.

tagsstring[] required

AI-generated keywords for the reaction.