BAbannerbear

Animate a template with a preset

Changed on

Applies a named preset to layers, optionally staggered. Deterministic and free: no model call, no AI credits, and the same request always produces the same keyframes — three layers at stagger: 500 begin at 0, 500 and 1000ms exactly. Use this whenever the request already says what it wants. The template is versioned before it is overwritten.

post/animation_templates/{uid}/animate

Request

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

Path parameters

uidstring required

Request body

preset'FadeIn' | 'FadeOut' | 'ZoomIn' | 'ZoomOut' | 'GetBigger' | 'GetSmaller' | 'ScaleIn' | 'ScaleOut' | 'PopIn' | 'PopOut' required

FadeIn, FadeOut, ZoomIn, ZoomOut, GetBigger, GetSmaller, ScaleIn, ScaleOut work on any layer. PopIn and PopOut are measured in em and apply to text layers only.

objectsstring[]

Layer ids, in the order the stagger should run. Omit to animate every layer in stacking order.

durationinteger

How long each layer's tween runs, in milliseconds

staggerinteger

Milliseconds between each layer's START. At 500, layers begin at 0, 500, 1000 — not 500ms of gap after each finishes.

easingstring

Optional anime.js easing, e.g. easeOutCubic

mergeboolean

Keep keyframes on layers this call does not touch. False replaces the whole timeline.

Response

Template with its new keyframes

uidstring
namestring
descriptionstring nullable
tagsstring[]
widthinteger
heightinteger
frame_rate24 | 30 | 60
duration_secondsnumber

Derived from the template's keyframes — not settable. 0 until something is animated.

previewstring uri nullable

Preview image URL

ui_write_access'owner_only' | 'team'

Who can edit in the dashboard — owner_only (default) or team

api_write_access'team' | 'owner_only' | 'nobody'

Who can update or delete via the API — team (default), owner_only, or nobody (locked; unlock via dashboard)

created_atstring date-time

Changes

  • 745da36239a3Revision changes
    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-x-pin-bottom enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

    • warning

      added the new center-y-pin-right enum value to the /////// response property for the response status

  • 37156820eb24Revision changes
    • warning

      added the new custom enum value to the /////// response property for the response status

    • info

      added the optional property /////// to the response with the status