ConvertApi Logo

GIF to GIF API

The API for converting JPG, PNG, and GIF images to single and animated GIF files.

API Request:
Copy parameter's URL Secret Secret
Optional

String Authentication secret must be provided as a query parameter. If omitted, token must be provided.

Show all
Copy parameter's URL Token Token
Optional

String Authentication token must be provided as a query parameter. If omitted, secret must be provided.

Show all
Copy parameter's URL Files Files
Required

File Files to be converted. Value can be URL or file content. If used in query or multipart content parameter must be suffixed with index e.g. Files[0], Files[1], Files[2]...

Show all
Copy parameter's URL StoreFile Store file
Optional

Bool Store converted file on our secure server and provides download URL.

Default: False

Show all
Copy parameter's URL FileName File name
Optional

String Converted output file name without extension. The extension will be added automatically.

Show all
Copy parameter's URL Timeout Timeout
Optional

Integer Conversion timeout in seconds.

Default: 900

Range: 10 .. 1200

Show all
Copy parameter's URL Async Asynchronous
Optional

Bool Run conversion job asynchronously.

Default: False

Show all
Copy parameter's URL JobId Job ID
Optional

String Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously. Also automatically added to WebHook url.

Show all
Copy parameter's URL WebHook WebHook
Optional

String Set WebHook URL to call after conversion is finished. Also works for synchronous requests.

Show all
Copy parameter's URL ImageResolution Image resolution
Optional

Integer Set output image resolution in dpi.

Default: 200

Range: 10 .. 800

Show all
Copy parameter's URL ScaleImage Scale image
Optional

Bool Scale the output image. If ScaleImage is False output document will be stripped to ImageHeight / ImageWidth, if ScalePage is True output document will be scaled to ImageHeight / ImageWidth.

Default: False

Show all
Copy parameter's URL ScaleProportions Scale proportions
Optional

Bool Constrain proportions when scaling the output image.

Default: True

Show all
Copy parameter's URL ScaleIfLarger Scale if larger
Optional

Bool Scaling only if the input image is larger than the output.

Default: False

Show all
Copy parameter's URL ImageHeight Image height
Optional

Integer Image height in pixels.

Range: 10 .. 20000

Show all
Copy parameter's URL ImageWidth Image width
Optional

Integer Image width in pixels.

Range: 10 .. 20000

Show all
Copy parameter's URL ImageInterpolation Image interpolation
Optional

Bool Specifies whether the image parser should use image interpolation. Enabling image interpolation will result in higher quality for scaled images at the expense of speed.

Default: False

Show all
Copy parameter's URL PersistAnimation Read animation values
Optional

Bool Read animation values AnimationIterations and AnimationDelay from GIF file. Only works if GIF file is added to file list.

Default: True

Show all
Copy parameter's URL AnimationDelay Animation delay
Optional

Integer Animation delay in milliseconds before playing the next image in an animated sequence.

Default: 100

Range: 0 .. 20000

Show all
Copy parameter's URL AnimationIterations Animation iterations
Optional

Integer Set the number of iterations to loop an animation. Zero is infinity.

Default: 0

Range: 0 .. 1000

Show all

Show parameters

Snippets are autogenerated according to converter parameter choices above. Please select file in "File" or "Files" parameter before using code snippets.

Code snippet is using ConvertAPI JavaScript Client

Code snippet is using ConvertAPI Node.js Client

Code snippet is using ConvertAPI PHP Client

Code snippet is using ConvertAPI Java Client

Code snippet is using ConvertAPI C# Client

Code snippet is using ConvertAPI Ruby Client

Code snippet is using ConvertAPI Python Client

Code snippet is using ConvertAPI Go Client

Code snippet is using command line utility program

For conversions with the multiple file result please refer to the example