Create video slideshow

Turn a series of images into an mp4 slideshow with optional transitions. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until status is completed or failed.

post/tools/create_video_slideshow

Request body

image_urlsstring[] required

Two or more URLs in slide order

slide_durationnumber

Defaults to 3

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

widthinteger

Defaults to 1280

heightinteger

Defaults to 720

metadatastring

Arbitrary metadata string stored with the tool run

Response

Tool run accepted

uidstring

tool'create_video_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

No recorded changes to this endpoint across all 1 revision of this API.