CloudconvertClient

Classes

ConvertFileInput dataclass

ConvertFileInput(tasks: Optional[Dict[str, Any]] = None)

Convert File

Attributes

tasks class-attribute instance-attribute

tasks: Optional[Dict[str, Any]] = None

tasks

OptimizeFileInput dataclass

OptimizeFileInput(tasks: Optional[Dict[str, Any]] = None)

Compress File

Attributes

tasks class-attribute instance-attribute

tasks: Optional[Dict[str, Any]] = None

tasks

CaptureWebsiteInput dataclass

CaptureWebsiteInput(tasks: Optional[Dict[str, Any]] = None)

Create Website Screenshot

Attributes

tasks class-attribute instance-attribute

tasks: Optional[Dict[str, Any]] = None

tasks

MergeFilesInput dataclass

MergeFilesInput(number_of_inputs: Optional[int] = None, additional_inputs: Optional[Dict[str, Any]] = None, tasks: Optional[Dict[str, Any]] = None)

Merge Files

Attributes

number_of_inputs class-attribute instance-attribute

number_of_inputs: Optional[int] = None

Number of input files to merge.

tasks class-attribute instance-attribute

tasks: Optional[Dict[str, Any]] = None

tasks

GetConvertOptionsResponse dataclass

GetConvertOptionsResponse(data: Optional[Dict[str, Any]] = None)

Response for Get Convert Options

GetOptimizeOptionsResponse dataclass

GetOptimizeOptionsResponse(data: Optional[Dict[str, Any]] = None)

Response for Get Optimize Options

GetCaptureWebsiteOptionsResponse dataclass

GetCaptureWebsiteOptionsResponse(data: Optional[Dict[str, Any]] = None)

Response for Get Capture Website Options

GetMergeInputsResponse dataclass

GetMergeInputsResponse(data: Optional[Dict[str, Any]] = None)

Response for Get Merge Inputs

GetMergeOptionsResponse dataclass

GetMergeOptionsResponse(data: Optional[Dict[str, Any]] = None)

Response for Get Merge Options

CloudconvertClient

CloudconvertClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for cloudconvert connector.

Initialize a CloudconvertClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

convert_file_async async

convert_file_async(input: ConvertFileInput) -> bytes

Convert File

Convert a file to another format

optimize_file_async async

optimize_file_async(input: OptimizeFileInput) -> bytes

Compress File

Compress a PDF, PNG or JPG file

capture_website_async async

capture_website_async(input: CaptureWebsiteInput) -> bytes

Create Website Screenshot

Create a website screenshot as PDF, PNG or JPG

merge_files_async async

merge_files_async(input: MergeFilesInput) -> bytes

Merge Files

Merge multiple files in one PDF

get_convert_options_async async

get_convert_options_async(input_format: Optional[str] = None, output_format: Optional[str] = None) -> dict[str, Any] | None

Get Convert Options

get_optimize_options_async async

get_optimize_options_async(input_format: Optional[str] = None) -> dict[str, Any] | None

Get Optimize Options

get_capture_website_options_async async

get_capture_website_options_async(output_format: Optional[str] = None) -> dict[str, Any] | None

Get Capture Website Options

get_merge_inputs_async async

get_merge_inputs_async(number_of_inputs: Optional[int] = None) -> dict[str, Any] | None

Get Merge Inputs

get_merge_options_async async

get_merge_options_async(output_format: Optional[str] = None) -> dict[str, Any] | None

Get Merge Options