API Quick Start

Auto generate banner variations, short video clips and more

Jump to: ImagesCollectionsPDFsAnimated GifsVideosVideos / AdvancedMovies

Images

Send a JSON payload of text, external file urls and other attributes to generate an image.

Javascript

var data = {
  "template" : YOUR_TEMPLATE_ID,
  "modifications" : [
    {
     "name": "photo",
     "image_url": "https://images.unsplash.com/photo-1541267226650-673e4bc869c7?ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&ixlib=rb-1.2.1&auto=format&fit=crop&w=1778&q=80"
    },
    {
     "name": "country",
     "text": "Singapore"
    },
    {
     "name": "offer",
     "text": "*from* $129 *per night*"
    }
  ]
}
fetch('https://api.bannerbear.com/v2/images', {
  method: 'POST',
  body: JSON.stringify(data),
  headers: {
    'Content-Type' : 'application/json',
    'Authorization' : `Bearer ${API_KEY}`
  }
})

View full documentation for Images ↗

Collections

Send a JSON payload of text, external file urls and other attributes to generate a set of images using different templates.

Javascript

var data = {
  "template_set" : YOUR_TEMPLATE_SET_ID,
  "modifications" : [
    {
      "name": "photo",
      "image_url": "https://images.unsplash.com/photo-1493976040374-85c8e12f0c0e?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1350&q=80"
    },
    {
      "name": "country",
      "text": "Kyoto"
    },
    {
      "name": "offer",
      "text": "*from* $95 *per night*"
    }
  ]
}
fetch('https://api.bannerbear.com/v2/collections', {
  method: 'POST',
  body: JSON.stringify(data),
  headers: {
    'Content-Type' : 'application/json',
    'Authorization' : `Bearer ${API_KEY}`
  }
})

View full documentation for Collections ↗

PDFs

Send a JSON payload of text, external file urls and other attributes to generate high quality vector PDFs.

Javascript

var data = {
  "template_set" : YOUR_TEMPLATE_SET_ID,
  "render_pdf" : true,
  "modifications" : [
    {
      "name": "photo",
      "image_url": "https://images.unsplash.com/photo-1493976040374-85c8e12f0c0e?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1350&q=80"
    },
    {
      "name": "country",
      "text": "Kyoto"
    },
    {
      "name": "offer",
      "text": "*from* $95 *per night*"
    }
  ]
}
fetch('https://api.bannerbear.com/v2/images', {
  method: 'POST',
  body: JSON.stringify(data),
  headers: {
    'Content-Type' : 'application/json',
    'Authorization' : `Bearer ${API_KEY}`
  }
})

View full documentation for PDFs ↗

Open PDF in New Window ↗

Animated Gifs

Send a JSON payload of text, external file urls and other attributes to generate simple slideshow-like animated gifs.

Javascript

var data = {
  "template": "Rqg32K5Q4gPZ8V07Y6",
  "fps": 0.5,
  "frames": [
    [
      {
        "name": "photo",
        "image_url": "https://images.unsplash.com/photo-1493976040374-85c8e12f0c0e?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1350&q=80"
      },
      {
        "name": "country",
        "text": "Kyoto"
      },
      {
        "name": "offer",
        "text": "*from* $95 *per night*"
      }
    ],
    [
      {
        "name": "photo",
        "image_url": "https://images.unsplash.com/photo-1587974136444-493b758688b8?ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&ixlib=rb-1.2.1&auto=format&fit=crop&w=1350&q=80"
      },
      {
        "name": "country",
        "text": "Kyoto"
      },
      {
        "name": "offer",
        "text": "*from* $95 *per night*"
      }
    ],
    [
      {
        "name": "photo",
        "image_url": "https://images.unsplash.com/photo-1574236170901-59c2f5c99c75?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1491&q=80"
      },
      {
        "name": "country",
        "text": "Kyoto"
      },
      {
        "name": "offer",
        "text": "*from* $95 *per night*"
      }
    ]
  ]
}
fetch('https://api.bannerbear.com/v2/animated_gifs', {
  method: 'POST',
  body: JSON.stringify(data),
  headers: {
    'Content-Type' : 'application/json',
    'Authorization' : `Bearer ${API_KEY}`
  }
})

View full documentation for Animated Gifs ↗

Videos

Send a JSON payload of text, external file urls and other attributes to generate videos with a static overlay.

Javascript

var data = {
  "video_template" : YOUR_VIDEO_TEMPLATE_ID,
  "input_media_url": "https://vod-progressive.akamaized.net/exp=1625501327~acl=%2Fvimeo-prod-skyfire-std-us%2F01%2F3127%2F18%2F465639513%2F2065868187.mp4~hmac=3f051f852d6142e7085a0df4c160ba736b0d933b5a5f668506837e1773e466ca/vimeo-prod-skyfire-std-us/01/3127/18/465639513/2065868187.mp4?download=1&filename=pexels-timo-volz-5544073.mp4",
  "modifications": [
    {
      "name": "country",
      "text": "Tokyo"
    },
    {
      "name": "offer",
      "text": "*from* $105 *per night*"
    }
  ]
}
fetch('https://api.bannerbear.com/v2/videos', {
  method: 'POST',
  body: JSON.stringify(data),
  headers: {
    'Content-Type' : 'application/json',
    'Authorization' : `Bearer ${API_KEY}`
  }
})

View full documentation for Videos ↗

Videos / Advanced

Send a JSON payload of text, external file urls and other attributes to generate videos with multiple overlays that display consecutively.

Javascript

var data = {
  "video_template" : YOUR_VIDEO_TEMPLATE_ID,
  "input_media_url": "https://vod-progressive.akamaized.net/exp=1625501327~acl=%2Fvimeo-prod-skyfire-std-us%2F01%2F3127%2F18%2F465639513%2F2065868187.mp4~hmac=3f051f852d6142e7085a0df4c160ba736b0d933b5a5f668506837e1773e466ca/vimeo-prod-skyfire-std-us/01/3127/18/465639513/2065868187.mp4?download=1&filename=pexels-timo-volz-5544073.mp4",
  "frames": [
    [
      {
        "name": "country",
        "text": "Tokyo"
      },
      {
        "name": "offer",
        "text": "*from* $105 *per night*"
      }
    ],
    [
      {
        "name": "country",
        "text": "Book Now"
      },
      {
        "name": "offer",
        "text": "*from* $105 *per night*"
      }
    ]
  ],
  "trim_to_length_in_seconds": 4
}
fetch('https://api.bannerbear.com/v2/videos', {
  method: 'POST',
  body: JSON.stringify(data),
  headers: {
    'Content-Type' : 'application/json',
    'Authorization' : `Bearer ${API_KEY}`
  }
})

View full documentation for Videos ↗

Movies

Send a JSON payload of external files to join multiple videos or static images into a single movie file.

Javascript

var data = {
  "soundtrack_url": "https://www.looperman.com/media/loops/1297038/looperman-l-1297038-0251297-smooth-japan-guitar-travis-scott-x-the-weeknd.mp3",
  "transition": "fade",
  "inputs": [
    {
      "asset_url": "https://i.imgur.com/hj6QcsL.png",
      "trim_to_length_in_seconds": 3
    },
    {
      "asset_url": "https://videos.bannerbear.com/completed/movie-xWR097K3z0pwl6nAdv.mp4"
    },
    {
      "asset_url": "https://i.imgur.com/hj6QcsL.png",
      "trim_to_length_in_seconds": 3
    }
  ]
}
fetch('https://api.bannerbear.com/v2/movies', {
  method: 'POST',
  body: JSON.stringify(data),
  headers: {
    'Content-Type' : 'application/json',
    'Authorization' : `Bearer ${API_KEY}`
  }
})