Convert anything using SLIDESHOW


The API for converting any file using SLIDESHOW.

Here you can see all available conversion options which you can use within the "options" section of conversions (see the example JSON below the table).

Here you can see all available conversion options which you can use within the "options" section of conversions (see the example JSON on the right).

Option Name Description
allow_multiple_outputs
Type: boolean
Default: False
If the conversion produces more than one output file, by default all of them are compressed in just one file. Set this option to true if you want a download link for each file.
allow_multiple_outputs_threshold
Type: integer
Minimum: 2
Maximum: 400
download_password
Type: string
Pattern: ^[ -~]{0,1000}$
Example: secret_password
A password to protect the download. To download the file send the password in the x-oc-download-password header or set a cookie named x-oc-download-password. The value contains a comma separated list of passwords.
framerate
Type: number
Minimum: True
Maximum: 120
Specifies the video frames per second
height
Type: number
Minimum: True
Maximum: 65000
Sets the height of the slideshow in pixels
target_format
Type: string
Enum: avi mkv mov mp4
The video output format
transitions
Type: array
Additionalproperties: False
Transition: string Fade: Fadeblack: Fadewhite: Distance: Wipeleft: Wiperight: Wipeup: Wipedown: Slideleft: Slideright: Slideup: Slidedown: Smoothleft: Smoothright: Smoothup: Smoothdown: Circlecrop: Rectcrop: Circleclose: Circleopen: Horzclose: Horzopen: Vertclose: Vertopen: Diagbl: Diagbr: Diagtl: Diagtr: Hlslice: Hrslice: Vuslice: Vdslice: Dissolve: Pixelize: Radial: Hblur: Wipetl: Wipetr: Wipebl: Wipebr: Fadegrays: Squeezev: Squeezeh: Zoomin: Hlwind: Hrwind: Vuwind: Vdwind: Coverleft: Coverright: Coverup: Coverdown: Revealleft: Revealright: Revealup: Revealdown: The type of transition effect to apply between two images. The default transition is fade.
Duration: number 0.1 30 Specifies the duration of the transition effect in seconds
width
Type: number
Minimum: True
Maximum: 65000
Sets the width of the slideshow in pixels

Output Example

POST /v2/jobs HTTP/1.1
Host: https://api.api2convert.com
X-Oc-Api-Key: <your API key here>
Content-Type: application/json
{
    "input": [{
        "type": "remote",
        "source": "https://example-files.online-convert.com/raster%20image/png/example_small.png"
    }],
    "conversion": [{
        "category": "operation",
        "target": "slideshow",
        "options": {
            <conversion options here>
        }
    }]
}