DocsAPI referenceOperations

Make a slideshow

A video from the still images, each held for its duration with an optional slow zoom or pan (motion); one image is an image to video. transition crosses each image into the next. It has no sound unless audio.input names one of extra_inputs. Creates the same Job as POST /v1/jobs, with operation set.

POST /v1/slideshow

Needs an API key: Authorization: Bearer $VIDEXO_API_KEY.

Parameters

Parameters
Name	In	Type	Description
`idempotency-key`	header	string, up to 255 characters	Makes retries safe for 24 hours. Up to 255 printable ASCII characters. One key space per account across every endpoint that creates a job.

Body SlideshowRequest

Body fields
Name	Type	Description
`images` required	array of string or object or object	The pictures in order: sources, or `{ "source", "duration", "motion", "text", "transition" }`.
`duration`	number, 0.1 to 300	Seconds each image stays on screen unless it says otherwise (default 3).
`motion`	one of `zoom-in`, `zoom-out`, `pan-left`, `pan-right`, `pan-up`, `pan-down`	A slow zoom or pan across the picture, which then always fills the frame (Ken Burns).
`transition`	Transition	The transition into each image but the first, unless it sets its own.
`extra_inputs`	map of string to string or object
`webhook_url`	string, URL, up to 2,048 characters or null	An https URL that gets the job when it ends (M4).
`metadata`	map of string to string, up to 500 characters	Your own string pairs, returned with the job and its webhook: at most 20 keys of up to 40 characters, values up to 500.
`filename`	string, up to 105 characters	The stored file name, `<name>.<format>` by default; one extension, matching `format`.
`format`	one of `mp4`, `mov`, `webm`, `mkv`, `ts`, `mp3`, `m4a`, `aac`, `wav`, `flac`, `ogg`, `opus`, `jpg`, `png`, `gif`, `json`	The container or image format; from `filename`, or the type's default.
`trim`	object	The part of the input to use: `start`, and `end` or `duration`.
`crop`	object	A rectangle of the input frame, in input pixels.
`rotate`	number	Degrees clockwise.
`flip`	one of `horizontal`, `vertical`	Mirror the picture.
`resize`	object	A new size: `width`, `height`, `aspect`, and how the picture fits (`fit`).
`color`	object	Brightness, contrast, saturation, gamma and hue.
`sharpen`	object	An unsharp mask.
`blur`	object	A box blur of the whole frame, or of up to 4 regions.
`overlays`	array of object	Images or videos drawn over the picture, in order.
`text`	array of TextLayer	Up to 8 text layers, drawn after overlays in order.
`subtitles`	Subtitles	Captions from an SRT or WebVTT input, burned into the picture at their cue times.
`speed`	number, 0.25 to 4	How fast it plays, 0.25 to 4; the sound keeps its pitch.
`fps`	number, 1 to 120	A constant frame rate.
`fade`	object	Fade in at the start and out at the end; `out` needs `trim.duration` or `trim.end`.
`video`	object	The video encoder: codec, quality or CRF, preset, maximum bitrate, pixel format.
`audio`	boolean or object	`false` for no sound, or the audio encoder and filters.
`visualize`	object	A waveform or spectrum video drawn from the input's sound.
`strip_metadata`	boolean	Drop the input's global and stream metadata (GPS, device tags).
`preset`	one of `web-720p`, `web-1080p`, `social-vertical`, `square`	A video preset (`GET /v1/presets`); its options are the defaults and the output's own fields win.

Request

bash

curl "$VIDEXO_API_URL/v1/slideshow" \
  -H "Authorization: Bearer $VIDEXO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "images": [
    "https://example.com/photo-1.jpg",
    {
      "source": "https://example.com/photo-2.jpg",
      "motion": "pan-right"
    }
  ],
  "duration": 4,
  "motion": "zoom-in",
  "resize": {
    "width": 1280,
    "height": 720
  }
}'

JavaScript

const response = await fetch(`${process.env.VIDEXO_API_URL}/v1/slideshow`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VIDEXO_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "images": [
      "https://example.com/photo-1.jpg",
      {
        "source": "https://example.com/photo-2.jpg",
        "motion": "pan-right"
      }
    ],
    "duration": 4,
    "motion": "zoom-in",
    "resize": {
      "width": 1280,
      "height": 720
    }
  }),
});
const job = await response.json();

Response

202 JSON

{
  "id": "job_3k9x0c2mfq8w1n7r5t4b6v2z",
  "state": "queued",
  "kind": "operations",
  "operation": "slideshow",
  "spec": {
    "inputs": {
      "image_1": {
        "url": "https://example.com/photo-1.jpg"
      },
      "image_2": {
        "url": "https://example.com/photo-2.jpg"
      }
    },
    "outputs": [
      {
        "name": "video",
        "type": "video",
        "concat": [
          {
            "image": "image_1",
            "duration": 4,
            "motion": "zoom-in"
          },
          {
            "image": "image_2",
            "duration": 4,
            "motion": "pan-right"
          }
        ],
        "filename": "video.mp4",
        "format": "mp4",
        "resize": {
          "width": 1280,
          "height": 720
        },
        "video": {
          "codec": "h264",
          "crf": 23,
          "encoder_preset": "veryfast",
          "pixel_format": "yuv420p",
          "faststart": true
        },
        "audio": false
      }
    ]
  },
  "command": "-i {{in_image_1}} -i {{in_image_2}} -filter_complex \"[0:v]fps=30:start_time=0:round=up,trim=end_frame=1,scale=2560:1440:force_original_aspect_ratio=increase,crop=2560:1440,zoompan=z=1+0.2*on/119:x=(iw-iw/zoom)/2:y=(ih-ih/zoom)/2:d=120:s=1280x720:fps=30,setsar=1[o0c0v];[1:v]fps=30:start_time=0:round=up,trim=end_frame=1,scale=2560:1440:force_original_aspect_ratio=increase,crop=2560:1440,zoompan=z=1.2:x=(iw-iw/zoom)*on/119:y=(ih-ih/zoom)/2:d=120:s=1280x720:fps=30,setsar=1[o0c1v];[o0c0v][o0c1v]concat=n=2:v=1:a=0[o0cv]\" -map [o0cv] -c:v libx264 -preset veryfast -crf 23 -pix_fmt yuv420p -an -movflags +faststart {{out_video}}",
  "input_files": {
    "in_image_1": "https://example.com/photo-1.jpg",
    "in_image_2": "https://example.com/photo-2.jpg"
  },
  "output_files": {
    "out_video": "video.mp4"
  },
  "ffmpeg_command": "ffmpeg -i https://example.com/photo-1.jpg -i https://example.com/photo-2.jpg -filter_complex '[0:v]fps=30:start_time=0:round=up,trim=end_frame=1,scale=2560:1440:force_original_aspect_ratio=increase,crop=2560:1440,zoompan=z=1+0.2*on/119:x=(iw-iw/zoom)/2:y=(ih-ih/zoom)/2:d=120:s=1280x720:fps=30,setsar=1[o0c0v];[1:v]fps=30:start_time=0:round=up,trim=end_frame=1,scale=2560:1440:force_original_aspect_ratio=increase,crop=2560:1440,zoompan=z=1.2:x=(iw-iw/zoom)*on/119:y=(ih-ih/zoom)/2:d=120:s=1280x720:fps=30,setsar=1[o0c1v];[o0c0v][o0c1v]concat=n=2:v=1:a=0[o0cv]' -map '[o0cv]' -c:v libx264 -preset veryfast -crf 23 -pix_fmt yuv420p -an -movflags +faststart video.mp4",
  "steps": [
    {
      "tool": "ffmpeg",
      "inputs": [
        "image_1",
        "image_2"
      ],
      "outputs": [
        "video"
      ],
      "command": "ffmpeg -i https://example.com/photo-1.jpg -i https://example.com/photo-2.jpg -filter_complex '[0:v]fps=30:start_time=0:round=up,trim=end_frame=1,scale=2560:1440:force_original_aspect_ratio=increase,crop=2560:1440,zoompan=z=1+0.2*on/119:x=(iw-iw/zoom)/2:y=(ih-ih/zoom)/2:d=120:s=1280x720:fps=30,setsar=1[o0c0v];[1:v]fps=30:start_time=0:round=up,trim=end_frame=1,scale=2560:1440:force_original_aspect_ratio=increase,crop=2560:1440,zoompan=z=1.2:x=(iw-iw/zoom)*on/119:y=(ih-ih/zoom)/2:d=120:s=1280x720:fps=30,setsar=1[o0c1v];[o0c0v][o0c1v]concat=n=2:v=1:a=0[o0cv]' -map '[o0cv]' -c:v libx264 -preset veryfast -crf 23 -pix_fmt yuv420p -an -movflags +faststart video.mp4"
    }
  ],
  "webhook_url": null,
  "metadata": {},
  "progress": null,
  "error": null,
  "outputs": [],
  "usage": null,
  "created_at": "2026-11-04T12:00:00.000Z",
  "started_at": null,
  "finished_at": null
}

Responses

Responses
Status	Body	When
200	Job	The job this Idempotency-Key made earlier (same endpoint and body).
202	Job	The job, queued.
400	Problem	invalid_request (with `errors`) or command_invalid (with `problems`)
401	Problem	authentication_failed (missing_api_key, invalid_api_key, api_key_revoked, api_key_expired)
402	Problem	usage_cap_reached or out_of_credits
403	Problem	permission_denied (account_disabled, token_scope)
404	Problem	not_found (upload)
409	Problem	conflict (idempotency_key_reused)
413	Problem	limit_exceeded (request_body_size): the body is larger than 512 KB
415	Problem	invalid_request (not_json): the body is not sent as application/json
429	Problem	rate_limited, with Retry-After in seconds
500	Problem	internal_error
503	Problem	service_unavailable (temporary): the account's free credits are still being granted, or a part of the service did not answer