SXW to ZIP API.

The API for compressing SXW to ZIP archives.

API Request

Authentication Parameters
Parameter Description Value
Secret

Optional

String

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

Secret
Token

Optional

String

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

Token
Input Parameters
Parameter Description Value
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]...

Files
Output Parameters
Parameter Description Value
StoreFile

Optional

Bool

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

Default: False

StoreFile
FileName

Optional

String

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

FileName
Execution Parameters
Parameter Description Value
Timeout

Optional

Integer

Conversion timeout in seconds.

Default: 300

Values: 10 .. 1200

Timeout
Asynchronous Parameters
Parameter Description Value
Async

Optional

Bool

Run conversion job asynchronously.

Default: False

Async
JobId

Optional

String

Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously.

JobId
WebHook

Optional

String

Set WebHook URL to call after asynchronous conversion is finished. Async parameter must be enabled.

WebHook
References Parameters
Parameter Description Value
CompressionLevel

Optional

Collection

Set compression level.

Default: NoCompression

Values: Optimal, Fastest, NoCompression

CompressionLevel

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 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