New endpointsBreakingWebhooks
Media library, catalogs, avatars, voices, new formats, signed webhooks
Changes to check in an existing integration
- Deprecated:
POST /v1/project/create/ugc-adskeeps working, but UGC Studio now has one endpoint per format: Product in Hand, App Demo, Fashion, Before / After and Voiceover. The format comes from the path and its assets sit at the top of the body. Same price. - Breaking: an integration, scheduled post or analysed account id that belongs to another team now answers 404 (it was 403), the same as a missing id. See Channels, Publish and Account Analysis.
- Breaking: create requests that used to produce a failed or degraded video are now refused with 400 and nothing is charged: an unknown caption preset, text style, game, art style or motion style,
mediaType: "media"withoutmedia, or a model that does not match the media type. A malformed id answers 400 or 404, never 500. See Validation errors. - Breaking: rate limits per team: 30
POSTand 120 other requests per minute, and 3 URL downloads at a time. Over a limit you get 429 withRetry-AfterandX-RateLimit-*headers; nothing runs or is charged. See Rate limits. - Every webhook call is now signed and carries
Hooked-Signature,Hooked-EventandHooked-Delivery. The body is unchanged, so existing handlers keep working; verify the signature to reject forged calls and useHooked-Deliveryto drop duplicates. Team endpoints can subscribe to events in Settings → Webhooks. See Verify the signature. GET /v1/healthanswers only the API and database status. Host details (Node version, platform, memory, uptime, environment) and thedegradedstatus are gone.POST /v1/project/create/product-adswas removed. The trends, niche and social search endpoints are not available for now and answer 404.
New: idempotent creates
- Send an
Idempotency-Keyheader on anyPOSTthat creates or charges. A retry with the same key and body within 24 hours gets the first answer back (Idempotent-Replayed: true) without creating or charging again. See Idempotency.
New: slow creates answer at once
- Article to Video, PDF to Video, PDF to Brainrot and Cinematic answer in seconds with a
projectIdand statusprocessing. Invalid input, missing keys and too few credits are still refused up front; a later failure turns the projectfailed, refunds it and calls your webhook. - PDF to Video and PDF to Brainrot download and read
pdfUrlthemselves: teams on their own keys no longer need a Firecrawl key for them.
New endpoints
Projects and videos- List projects, Get project and Delete project: follow a project from creation to its video.
- Get captions and Edit project: read a finished project’s captions, change it, then Render again.
- Delete video.
- List, Get, Import from a URL, Upload + Complete upload and Delete.
- Generate image and Generate video into the library.
- A failed media says why in
error(Get Media). Generation and import take an optionalwebhookandmetadata, called once withmedia.completedormedia.failed. See Media webhooks.
- UGC Studio per format (above), Podcast / Dualcast, Reddit Story, Quiz Video and Scrolling Video.
- From a source: Article to Video, PDF to Video, PDF to Brainrot, Music to Video and Clone Video.
- Cinematic Studio.
- Avatars: Get, Create from a photo, Generate, Hook + Demo reaction and Delete.
- Voices: Clone, Text to speech, Speech to speech and Delete.
- Cinematic characters: List, Get, Create, Update and Delete.
- Remove background, Expand and Get image.