Reference · Ads
POST/ugc-ads/{adId}/video
Make the video of a UGC ad made step by step, once its preview is in
Make the video of a UGC ad made step by step (POST /api/v1/ugc-ads with pictureFirst), once its preview is in and the person likes it, as Make the video does on the UGC Ads page: each take whose preview is ready gets its clip, voice and captions, on the models and settings the ad was made with. GET /api/v1/jobs/{jobId} (kind "ugc") says when the previews are ready, with their links and what the video costs now. To redo a preview first, use POST /api/v1/ugc-ads/{adId}/picture. It comes back as a job (kind "ugc") to follow with GET /api/v1/jobs/{jobId}.
- Key needs
create· Make things and spend credits- Price it first
POST /ugc-ads/{adId}/video/quote· free- Answers
- A job to follow
Request
curl -X POST https://vessero.com/api/v1/ugc-ads/8f1c2d3e-4b5a-4789-8abc-def012345678/video \ -H "Authorization: Bearer $VESSERO_API_KEY" \ -H "Idempotency-Key: 47f8f6f5-ea00-4fb1-925f-76aac956a0ec" \ -H "Content-Type: application/json" \ -d '{ "confirmCredits": 192, "webhookUrl": "https://example.com/hooks/vessero" }'
Response202 Accepted
{ "object": "job", "id": "ugc.8f1c2d3e-4b5a-4789-8abc-def012345678", "kind": "ugc", "status": "working", "stage": "Queued", "files": [], "credits": 58, "url": "/api/v1/jobs/ugc.8f1c2d3e-4b5a-4789-8abc-def012345678" }
POST/ugc-ads/{adId}/video/quoteFree
The same body without confirmCredits. It answers the price and your balance, and runs nothing.
Path
- adIdstringrequiredThe UGC ad: its job’s id after
ugc., so8f1c…for the jobugc.8f1c….
Header
- Idempotency-KeystringYour id for this request: 8–64 letters, digits, - or _. A repeat within 10 minutes gets the first answer back and never runs twice. Use the same one for the quote and the run.
- Preferstring
wait=N(up to 60): hold the answer up to N seconds while the job is made, within 80 seconds for the whole call.
Body
- pictureIdsstring[] · up to 4Where a take drew several previews to pick from (pictureChoices), the one its video starts from: a pictureId from GET /api/v1/jobs/{jobId}, one for each such take. Default: the one each take has, the first made.
- confirmCreditsintegerrequiredThe price you agree to, in credits: the
creditsits quote gave. It runs at that price, or at a lower one when that figure was quoted for this Idempotency-Key; above the price now, nothing runs (409price_changed). Left out, nothing runs and the error carries the quote. - webhookUrlstring · httpsAn https address to POST the job to once it is done or has failed — or waits for a yes, as a UGC ad made step by step does once its previews are in — signed (see Webhooks).
Answers
- 202jobStarted: follow the job, or wait for its webhook.
- 200jobA job that ended at once: done, or failed (see error and charged).
- 400confirm_credits_requiredA run that spends needs confirmCredits: the quote is in details.
- 402insufficient_creditsThe account has too few credits for this.
- 409price_changedThe price is above the confirmCredits sent: nothing ran; the new quote is in details.
- 422content_refusedThe content check refused it.
- 429daily_cap_reachedThe key’s daily credit cap would be passed: see Retry-After.