BAbannerbear

Video thumbnails

Changed on

Grab still frames from a video at regular intervals. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until status is completed or failed.

post/tools/video_thumbnails

Request

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

Request body

video_urlstring uri required

Video URL

countinteger

How many frames to grab, up to 10

intervalnumber

Seconds between frames — fractions are fine, 0.5 for two a second

startnumber

Where the first frame is taken

metadatastring

Arbitrary metadata string stored with the tool run

Response

Tool run accepted

uidstring
tool'video_thumbnails'
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