BAbannerbear

Create narrated slideshow

Changed on

Turn images and a voiceover into a moving video. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until status is completed or failed.

post/tools/create_narrated_slideshow

Request

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

Request body

image_urlsstring[] required

1 to 20 URLs in slide order

audio_urlstring uri required

The voiceover. The video is as long as this audio

widthinteger required

Output width (px)

heightinteger required

Output height (px)

motion'none' | 'ken_burns'

ken_burns adds a slow zoom on each image. Defaults to none

transition'none' | 'fade' | 'dissolve' | 'wipeleft' | 'slideleft'

How each slide flows into the next. Defaults to none

transition_durationnumber

Only used when transition is set. Defaults to 1

bottom_barinteger

Height of a black bar at the bottom. The images fill the area above it. Defaults to 0

metadatastring

Arbitrary metadata string stored with the tool run

Response

Tool run accepted

uidstring
tool'create_narrated_slideshow'
status'pending' | 'running' | 'completed' | 'failed'

pending → running → completed / failed

progressinteger

0-100 job progress, 100 once completed

inputsobject

Inputs the job was created with

metadatastring nullable

Arbitrary metadata string round-tripped from the create request

selfstring uri
created_atstring date-time
completed_atstring date-time nullable
error_messagestring nullable

Human-readable failure reason (only present on failed jobs)

Changes