API Reference

Operations

List all possible operations, formats, engines and possible options.

List operations

List all possible operations, formats, engines and possible options.

GEThttps://api.cloudconvert.com/v2/operations

Query Parameters

filter[operation]

string

The result will be filtered to include only possible operations with a matching operation name (e.g. convert or optimize).

filter[input_format]

string

The result will be filtered to include only possible conversions with a matching input format.

filter[output_format]

string

The result will be filtered to include only possible conversions with a matching output format.

filter[engine]

string

Filter result to only include conversions with a matching engine name.

filter[engine_version]

string

Filter result to only include conversions with a matching engine version.

alternatives

boolean

For some formats multiple alternative engines are available. If set to true, the result includes these alternative conversion types. Defaults to false.

include

array

Include options and/or engine_versions in the result. Use options.details to get the options including details for building user interfaces, such as labels, value ranges and descriptions of the possible values. We recommend to set options,options.details in this case.

Response

The list of possible conversion types:

operation

string

Name of the operation, such as convert, optimize or capture-website.

input_format

string

Format of the input file.

output_format

string

Format of the conversion result.

engine

string

Name of the engine.

credits

integer

The base amount of conversion credits this operation consumes.

options

array

Possible options for this conversion type. Available, if the include argument contains options.

engine_versions

array

Compatible engine versions for this conversion type. Available, if the include argument contains engine_versions.

deprecated

boolean

This format is deprecated.

experimental

boolean

This format is experimental.