POST https://makelocalads.com/api/v1/videos
Permission: videos:generate
Open in LocalAds
The create-video dialog in the product’s Video Ads studio.
concept_id and
voice_id are optional; leave one out and the render chooses, the same as the
app’s defaults. Concepts and voices are free to generate and list; see
Concepts and voices.
Usage notes
audience_idis required: a saved audience of the product, ornullfor a deliberately broad video. Omitting it is an error.- The product’s plan must include Video Ads.
max_creditsrefuses the request with422before anything is charged if the video would cost more. A render that fails is refunded.- Send an
Idempotency-Keyso a retry after a network failure never starts and charges for a second video.
Quick start
Input fields
string
required
ugc for a UGC voiceover video. Use animation to
animate a photo instead.string
required
The product the video is for.
string
The recipe, from
GET /video-recipes. Today there is one, the 30 second
UGC voiceover: ugc-30s-voiceover. Defaults to it.string
required
A saved audience of the product, from
GET /products/{product_id}/audiences, or null for a deliberately broad
video.string
A concept from
GET /video-concepts for this product. Optional: the render
chooses.string
A voice from
GET /voices. Optional: the render chooses.integer
Refuse the request with
422 credit_limit_exceeded, before anything is
charged, if it would cost more than this many credits.Complete JSON schema
Complete JSON schema
Response
202 Accepted:
GET /videos/{video_id} with backoff until status is completed or
failed; see Polling. A completed video carries
video_url and thumbnail_url.
Errors
See Errors and retries for the error format.