CloudconvertClient

Classes

ConvertFileInput dataclass

ConvertFileInput(tasks: Dict[str, Any])

Convert File

Attributes

tasks instance-attribute

tasks: Dict[str, Any]

tasks

OptimizeFileInput dataclass

OptimizeFileInput(tasks: Dict[str, Any])

Compress File

Attributes

tasks instance-attribute

tasks: Dict[str, Any]

tasks

CaptureWebsiteInput dataclass

CaptureWebsiteInput(tasks: Dict[str, Any])

Create Website Screenshot

Attributes

tasks instance-attribute

tasks: Dict[str, Any]

tasks

MergeFilesInput dataclass

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

Merge Files

Attributes

number_of_inputs instance-attribute

number_of_inputs: int

Number of input files to merge.

tasks instance-attribute

tasks: Dict[str, Any]

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, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

convert_file async

convert_file(input: ConvertFileInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Convert File

Convert a file to another format

Swagger operation ID: ConvertFile.

Parameters:

Name	Type	Description	Default
input	ConvertFileInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

optimize_file async

optimize_file(input: OptimizeFileInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Compress File

Compress a PDF, PNG or JPG file

Swagger operation ID: OptimizeFile.

Parameters:

Name	Type	Description	Default
input	OptimizeFileInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

capture_website async

capture_website(input: CaptureWebsiteInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Create Website Screenshot

Create a website screenshot as PDF, PNG or JPG

Swagger operation ID: CaptureWebsite.

Parameters:

Name	Type	Description	Default
input	CaptureWebsiteInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

merge_files async

merge_files(input: MergeFilesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes

Merge Files

Merge multiple files in one PDF

Swagger operation ID: MergeFiles.

Parameters:

Name	Type	Description	Default
input	MergeFilesInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
bytes	bytes	The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_convert_options async

get_convert_options(*, input_format: Optional[str] = None, output_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Convert Options

Swagger operation ID: GetConvertOptions.

Parameters:

Name	Type	Description	Default
input_format	Optional[str]	input_format.	None
output_format	Optional[str]	output_format.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_optimize_options async

get_optimize_options(*, input_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Optimize Options

Swagger operation ID: GetOptimizeOptions.

Parameters:

Name	Type	Description	Default
input_format	Optional[str]	input_format.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_capture_website_options async

get_capture_website_options(*, output_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Capture Website Options

Swagger operation ID: GetCaptureWebsiteOptions.

Parameters:

Name	Type	Description	Default
output_format	Optional[str]	output_format.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_merge_inputs async

get_merge_inputs(*, number_of_inputs: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Merge Inputs

Swagger operation ID: GetMergeInputs.

Parameters:

Name	Type	Description	Default
number_of_inputs	Optional[int]	number_of_inputs.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_merge_options async

get_merge_options(*, output_format: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Merge Options

Swagger operation ID: GetMergeOptions.

Parameters:

Name	Type	Description	Default
output_format	Optional[str]	output_format.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.