BAbannerbear

Create an animation

Changed on

Render an animation from a template. Async — returns 202 with a queued animation; poll GET /animations/{uid} until status is completed or failed. Duration comes from the template's keyframes, so a template with no animation is rejected. Passing modifications.template.transparent: true renders on a transparent background and forces a MOV output, since MP4 carries no alpha channel.

post/animations

Request

  • Base URL
    https://api.bannerbear.com/v5
  • Auth
    HTTP bearer

Request body

templatestring required

Animation template UID

formatsstring[]

Output formats. Ignored when transparent is set — that always yields MOV.

metadatastring

Arbitrary metadata string round-tripped in the response

Response

Animation queued

uidstring
status'queued' | 'completed' | 'failed' | 'rendering'

queued → rendering → completed / failed

templatestring

Source animation template UID

filesobject

Output file URL keyed by format (mp4, or mov when transparent)

progressinteger

0-100 render progress, 100 once completed

metadatastring nullable
errorstring nullable

Error message (only present on failure)

selfstring uri
created_atstring date-time
completed_atstring date-time nullable

Changes

  • 745da36239a3Revision changes
    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-x-pin-bottom enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

    • info

      added the new center-y-pin-right enum value to the request property ///////

  • 37156820eb24Revision changes
    • info

      added the new optional request property ///////

    • info

      added the new custom enum value to the request property ///////