Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
version: v1
title: convertapi Convert Image API
description: Convert API lets you effortlessly convert file formats and types.
servers:
- url: http://localhost
tags:
- name: ConvertImage
paths:
/convert/image/{format1}/to/{format2}:
post:
tags:
- ConvertImage
summary: Image format conversion
description: Convert between over 100 file formats, including key formats such as Photoshop (PSD), PNG, JPG, GIF, NEF, and BMP.
operationId: ConvertImage_ImageFormatConvert
parameters:
- name: format1
in: path
description: Input file format as a 3+ letter file extension. You can also provide UNKNOWN for unknown file formats. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
required: true
schema:
type: string
- name: format2
in: path
description: Output (convert to this format) file format as a 3+ letter file extension. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/octet-stream:
schema:
format: byte
title: OutputContent
description: Output file content from the operation
type: string
security:
- Apikey: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
inputFile:
type: string
description: Input file to perform the operation on.
format: binary
required:
- inputFile
/convert/image-multipage/{format1}/to/{format2}:
post:
tags:
- ConvertImage
summary: Multi-page image format conversion
description: Convert between over 100 file formats, including support for Multiple-Page formats (e.g. PDFs, TIFFs, etc. with multiple pages).
operationId: ConvertImage_MultipageImageFormatConvert
parameters:
- name: format1
in: path
description: Input file format as a 3+ letter file extension. You can also provide UNKNOWN for unknown file formats. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
required: true
schema:
type: string
- name: format2
in: path
description: Output (convert to this format) file format as a 3+ letter file extension. Supported formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV
required: true
schema:
type: string
- name: dpi
in: header
description: Optional; configures the pixel density in Dots per Inch (DPI) (default is 300). This parameter can only be used with Cloudmersive Managed Instance and Private Cloud.
required: false
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MultipageImageFormatConversionResult'
text/json:
schema:
$ref: '#/components/schemas/MultipageImageFormatConversionResult'
application/xml:
schema:
$ref: '#/components/schemas/MultipageImageFormatConversionResult'
text/xml:
schema:
$ref: '#/components/schemas/MultipageImageFormatConversionResult'
security:
- Apikey: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
inputFile:
type: string
description: Input file to perform the operation on.
format: binary
required:
- inputFile
/convert/image/set-dpi/{dpi}:
post:
tags:
- ConvertImage
summary: Change image DPI
description: Resize an image to have a different DPI
operationId: ConvertImage_ImageSetDPI
parameters:
- name: dpi
in: path
description: New DPI in pixels-per-inch, for example 300 DPI or 600 DPI
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/octet-stream:
schema:
format: byte
title: OutputContent
description: Output file content from the operation
type: string
security:
- Apikey: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
inputFile:
type: string
description: Input file to perform the operation on.
format: binary
required:
- inputFile
/convert/image/get-info:
post:
tags:
- ConvertImage
summary: Get information about an image
description: Get details from an image such as size, format and MIME type, compression, EXIF data such as location, DPI, unique colors, transparency information, and more
operationId: ConvertImage_GetImageInfo
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetImageInfoResult'
text/json:
schema:
$ref: '#/components/schemas/GetImageInfoResult'
application/xml:
schema:
$ref: '#/components/schemas/GetImageInfoResult'
text/xml:
schema:
$ref: '#/components/schemas/GetImageInfoResult'
security:
- Apikey: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
inputFile:
type: string
description: Input file to perform the operation on.
format: binary
required:
- inputFile
components:
schemas:
MultipageImageFormatConversionResult:
description: Result of converting a multi-page image into individual pages with a different format
type: object
properties:
Successful:
description: True if successful, false otherwise
type: boolean
PageCount:
format: int32
description: The number of pages in the converted output
type: integer
Pages:
description: Converted page results
type: array
items:
$ref: '#/components/schemas/PageConversionResult'
PageConversionResult:
description: Converted page as an image
type: object
properties:
Filename:
description: File name of the image in the converted file format
type: string
FileBytes:
format: byte
description: File bytes (contents) of the image in converted file format
type: string
GetImageInfoResult:
description: Result of running a get-info operation on an image
type: object
properties:
Successful:
type: boolean
ColorSpace:
description: Color space of the image
type: string
ColorType:
description: Color type of the image
type: string
Width:
format: int32
description: Width in pixels of the image
type: integer
Height:
format: int32
description: Height in pixels of the image
type: integer
CompressionLevel:
format: int32
description: Compression level value from 0 (lowest quality) to 100 (highest quality)
type: integer
ImageHashSignature:
description: SHA256 hash signature of the image
type: string
HasTransparency:
description: True if the image contains transparency, otherwise false
type: boolean
MimeType:
description: MIME type of the image format
type: string
ImageFormat:
description: Image format
type: string
DPIUnit:
description: Units of the DPI measurement; can be either in Inches or Centimeters
type: string
DPI:
format: double
description: DPI (pixels per unit, e.g. pixels per inch) of the image
type: number
ColorCount:
format: int32
description: Unique colors in the image
type: integer
BitDepth:
format: int32
description: Bit depth of the image
type: integer
Comment:
description: Comment string in the image
type: string
ExifProfileName:
description: Name of the EXIF profile used
type: string
ExifValues:
description: EXIF tags and values embedded in the image
type: array
items:
$ref: '#/components/schemas/ExifValue'
ExifValue:
description: EXIF tag and value
type: object
properties:
Tag:
description: Tag name for the EXIF value
type: string
DataType:
description: Date type of the EXIF value
type: string
DataValue:
description: Value, formatted as a string of the EXIF value
type: string
securitySchemes:
Apikey:
type: apiKey
description: API Key Authentication
name: Apikey
in: header
x-provenance:
method: harvested
publisher: Cloudmersive
source: https://api.cloudmersive.com/convert/docs/v1/swagger
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)