Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional caller-generated value that prevents duplicate generation when retrying the same request.

Required string length: 1 - 255

Body

application/json
type
string
required
Allowed value: "ugc"
product_id
string<uuid>
required
audience_id
string<uuid> | null
required

Required. A saved audience of the product, from GET /products/{product_id}/audiences, or null for a broad video.

recipe_id
string
default:ugc-30s-voiceover
concept_id
string<uuid>

A concept from GET /video-concepts for this product.

voice_id
string<uuid>

A voice from GET /voices.

max_credits
integer

Refuse the request with 422 credit_limit_exceeded, before anything is charged, if it would cost more than this many credits.

Required range: x >= 1

Response

Video accepted.

id
string<uuid>
required
type
enum<string>
required
Available options:
ugc,
animation
product_id
string<uuid>
required
status
enum<string>
required
Available options:
queued,
in_progress,
completed,
failed,
canceled
title
string | null
required
recipe_id
string | null
required
audience_id
string<uuid> | null
required
source_creative_id
string<uuid> | null
required
video_url
string<uri> | null
required
thumbnail_url
string<uri> | null
required
duration_seconds
integer | null
required
aspect_ratio
string | null
required
created_at
string<date-time>
required
credits_charged
integer
required

Net credits charged. A failed render is refunded.

Last modified on September 30, 2026