ONLYOFFICE Docs icon

ONLYOFFICE Docs

Consume ONLYOFFICE Document Server API (Conversion, Document Builder)

Actions21

Conversion → Convert Document

AI-generated

Summary

Convert a document from a URL or an incoming binary field to a selected output format using the ONLYOFFICE Document Server. Return the converted file as binary data or return its URL.

Inputs

  • File Source (required) — Choose URL (default) for the Document Server to download, or Binary Input to use a file from the current item.
  • File URL (required) — Source file URL; shown when File Source is URL.
  • Input Binary Field (required) — Name of the incoming binary field containing the source file; shown for Binary Input. Defaults to data.
  • Input Format (required) — Format of the source file. The available list is drawn from formats with conversion targets; defaults to docx.
  • Output Format (required) — Format to convert to, selected from targets available for the chosen input format; defaults to pdf.
  • Output Mode (required) — File Data (default) downloads the result into the output item; URL Only returns the Document Server URL without downloading.
  • Output File Name — Filename without extension for File Data output; defaults to converted. The extension is taken from the selected output format.
  • Put Output File in Field — Binary field name for the converted file in File Data mode; defaults to data.

Output shape

One output item per input item, containing JSON metadata and, in File Data mode, a binary file.

JSON includes success, inputFormat, outputFormat, and operation. File Data also includes fileName and convertedUrl, with the file under the configured binary field. URL Only returns convertedUrl without binary data. Conversion errors stop execution unless Continue On Fail is enabled, in which case an error message is returned for that item.

Links

Discussion