Convert Document

Converts an uploaded document file, provided text, or a document available at a web URL into another supported file format. Converting a PDF file to another format is not supported. The converted file is returned as binary content in the response body. Provide exactly one of content, text, or url.

Endpoints

post https://www.zohoapis.com/writer/api/v1/documents/convert

Copy full URL

OAuth Scope

ZohoWriter.documentEditor.ALLCopied!

curl --request POST \
  --url https://www.zohoapis.com/writer/api/v1/documents/convert \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: multipart/form-data' \
  -F 'content=@file_path' \
  -F 'text=string' \
  -F 'url=http://example.com' \
  -F 'format=docx' \
  -F 'password=string' \
  -F 'filename=string'



    list_of_text=List();
    file=invokeurl
    [
      url : "public fileURL link"
      type : GET
    ];
    list_of_text.add({"paramName":"content","content":file,"stringPart":"false"});
    list_of_text.add({"paramName":"text","content":"value","stringPart":"true"});
    list_of_text.add({"paramName":"url","content":"value","stringPart":"true"});
    list_of_text.add({"paramName":"format","content":"docx","stringPart":"true"});
    list_of_text.add({"paramName":"password","content":"value","stringPart":"true"});
    list_of_text.add({"paramName":"filename","content":"value","stringPart":"true"});

    response = invokeUrl
    [
        url: "https://www.zohoapis.com/writer/api/v1/documents/convert"
        type: POST
        files: list_of_text
        connection: connection_name
    ]

    info response;

Request Body

multipart/form-data

contentbinary(Optional)

The document file to be converted. Supported formats: docx (up to 50 MB), rtf, odt, txt, html, epub (up to 10 MB).

textstring(Optional)

The text content to be converted into a document.

Maximum Length :1000000Copied!

urluri(Optional)

The web URL of the document to be converted. Supported formats: docx (up to 50 MB), rtf, odt, txt, html, epub (up to 10 MB).

Maximum Length :5000Copied!

formatstring(Required)

The output format to convert the document into.

Allowed Values :

Show Values ▾

passwordstring(Optional)

A unique password for the document to be converted. Applicable when content or url is provided.

Maximum Length :255Copied!

filenamestring(Optional)

A name for the converted document.

Maximum Length :255Copied!

// Note: payload contains multiple type attributes

// type: file
content = <file>

// type: string
text = string

// type: string(uri)
url = http://example.com

// type: string
format = docx

// type: string
password = string

// type: string
filename = string

▼ Show full

200 The converted document is downloaded.

▼ Show full