capabilities.work

Generate a Vyond video and export it

A 5-step recipe with Vyond. We can help you get access.

Recipe · 5 steps

Generate a Vyond video and export it

with Vyond

End-to-end video production against the Vyond REST API.

  1. Read the enumerated vocabulary a generation request must draw from.
  2. Create the content generation. SPENDS CREDITS — no idempotency key is accepted, so do not retry this step on a timeout.
  3. Poll until status resolves. Back off exponentially — 429 is declared with no published limit and no Retry-After header.
  4. Export the generated video. SPENDS CREDITS — returns 402 Payment Required when the account is exhausted, and no endpoint reads the credit balance. completionCriteria is required for SCORM categories.
  5. Retrieve the download URL. It expires at expireAt — fetch the bytes immediately rather than persisting the URL.
What you'll need to have ready
  • feature: Feature whose parameter vocabulary to read (see GetParametersReqQuery).
  • generationType
  • vyondGoParams: Required when generationType is vyondGo.
  • aiAvatarParams: Required when generationType is aiAvatar.
  • exportCategory
  • exportResolution
For your developer

Arazzo workflow vyond:generate-and-export-video, 5 operations: ParameterController.getParameters → ContentGenerationV2Controller.createGeneration → ContentGenerationV2Controller.getGeneration → VideoController.exportVideo → VideoController.getVideoExportDownload. Specs on APIs.io.