6. Convert to PDF Formats Leave feedback

Convert to PDF Formats

You can convert the supported document formats to PDF Formats and get output as storage URL.

Resource

The following GroupDocs.Conversion Cloud REST API resource has been used in the convert to PDF format example.

cURL example

Request

curl -X POST "https://api.groupdocs.cloud/v2.0/conversion" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]" -H  "Content-Type: application/json" -d "{  \"Storage\": \"MyStorage\",  \"FilePath\": \"conversions/password-protected.docx\",  \"Format\": \"pptx\",  \"LoadOptions\": {\"DocxLoadOptions\": {\"Password\": \"password\"  }},  \"ConvertOptions\": {\"PdfConvertOptions\": {\"BookmarksOutlineLevel\": \"1\",                        \"CenterWindow\" :\"true\",  \"CompressImages\": \"false\",   \"DisplayDocTitle\":  \"true\", \"Dpi\":\"1024\",  \"ExpandedOutlineLevels\": \"1\",   \"FitWindow\": \"false\",\"FromPage\" \"1\",   \"Grayscale\": \"false\",  \"HeadingsOutlineLevels\": \"1\",   \"ImageQuality\": \"100\",                        \"Linearize\": \"false\",   \"MarginTop\": \"5\",   \"MarginLeft\": \"5\", \"Password\": \"password\",  \"UnembedFonts\": \"true\",  \"RemoveUnusedStreams\": \"true\",  \"RemoveUnusedObjects\": \"true\", \"RemovePdfaCompliance\": \"false\", \"Height\": \"1024\"}  },  \"OutputPath\": \"converted/topdf\"}"

Response

  {
    "name": "sample.pptx",
    "size": 68540,
    "url": "MyStorage:converted/topdf/password-protected.pdf"
  }

SDK examples

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

using System;
using System.Collections.Generic;
using GroupDocs.Conversion.Cloud.Sdk.Api;
using GroupDocs.Conversion.Cloud.Sdk.Client;
using GroupDocs.Conversion.Cloud.Sdk.Model;
using GroupDocs.Conversion.Cloud.Sdk.Model.Requests;

namespace GroupDocs.Conversion.Cloud.Examples.CSharp
{
    // Convert to PDF with load and save options
    class Convert_To_Pdf
    {
        public static void Run()
        {
            var configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);

            var apiInstance = new ConvertApi(configuration);

            try
            {
                // convert settings
                var settings = new ConvertSettings
                {
                    StorageName = Common.MyStorage,
                    FilePath = "conversions/password-protected.docx",
                    Format = "pdf",
                    LoadOptions = new DocxLoadOptions() { Password = "password" },
                    ConvertOptions = new PdfConvertOptions()
                    {
                        BookmarksOutlineLevel = 1,
                        CenterWindow = true,
                        CompressImages = false,
                        DisplayDocTitle = true,
                        Dpi = 1024,
                        ExpandedOutlineLevels = 1,
                        FitWindow = false,
                        FromPage = 1,
                        Grayscale = false,
                        HeadingsOutlineLevels = 1,
                        ImageQuality = 100,
                        Linearize = false,
                        MarginTop = 5,
                        MarginLeft = 5,
                        Password = "password",
                        UnembedFonts = true,
                        RemoveUnusedStreams = true,
                        RemoveUnusedObjects = true,
                        RemovePdfaCompliance = false,
                        Height = 1024
                    },
                    OutputPath = "converted/topdf"
                };

                // convert to specified format
                List<StoredConvertedResult> response = apiInstance.ConvertDocument(new ConvertDocumentRequest(settings));
                Console.WriteLine("Document conveted successfully: " + response[0].Url);
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling ConvertApi: " + e.Message);
            }
        }
    }
}

PHP

<?php

include(dirname(__DIR__) . '\CommonUtils.php');

    $convertApi = CommonUtils::GetConvertApiInstance();

    try 
    {
        $settings = new GroupDocs\Conversion\Model\ConvertSettings();

        $settings->setStorageName(CommonUtils::$MyStorage);
        $settings->setFilePath("conversions\\password-protected.docx");
        $settings->setFormat("pdf");

        $loadOptions = new GroupDocs\Conversion\Model\DocxLoadOptions();
        $loadOptions->setPassword("password");
        $loadOptions->setHideWordTrackedChanges(true);
        $loadOptions->setDefaultFont("Arial");

        $settings->setLoadOptions($loadOptions);

        $convertOptions = new GroupDocs\Conversion\Model\PdfConvertOptions();
        $convertOptions->setFromPage(1);
        $convertOptions->setPagesCount(2);
        $convertOptions->setZoom(100);
        $convertOptions->setDpi(300.0);
        $convertOptions->setBookmarksOutlineLevel(1);
        $convertOptions->setCenterWindow(true);
        $convertOptions->setCompressImages(false);
        $convertOptions->setDisplayDocTitle(true);
        $convertOptions->setExpandedOutlineLevels(1);
        $convertOptions->setFitWindow(false);
        $convertOptions->setFromPage(1);
        $convertOptions->setGrayscale(false);
        $convertOptions->setHeadingsOutlineLevels(1);
        $convertOptions->setImageQuality(100);
        $convertOptions->setLinearize(false);
        $convertOptions->setMarginTop(5);
        $convertOptions->setMarginLeft(5);
        $convertOptions->setPassword("password");
        $convertOptions->setUnembedFonts(true);
        $convertOptions->setRemoveUnusedStreams(true);
        $convertOptions->setRemoveUnusedObjects(true);
        $convertOptions->setRemovePdfaCompliance(false);
        $settings->setConvertOptions($convertOptions);

        $settings->setOutputPath("converted\\topdf");
        
        $request = new GroupDocs\Conversion\Model\Requests\ConvertDocumentRequest($settings);

        $response = $convertApi->convertDocument($request);
        echo "Document converted successfully: ", $response[0]->getUrl();
    } 
    catch (Exception $e) 
    {
        echo  "Something went wrong: ",  $e->getMessage(), "<br />";
        PHP_EOL;
    }
?>

Java

package examples.Working_With_Conversions;

import com.groupdocs.cloud.conversion.api.*;
import com.groupdocs.cloud.conversion.client.ApiException;
import com.groupdocs.cloud.conversion.model.*;
import com.groupdocs.cloud.conversion.model.requests.*;
import examples.Utils;
import java.util.List;

public class Conversion_Java_Convert_To_Pdf {

    public static void main(String[] args) {

        ConvertApi apiInstance = new ConvertApi(Utils.AppSID, Utils.AppKey);
        try {

            ConvertSettings settings = new ConvertSettings();

            settings.setStorageName(Utils.MYStorage);
            settings.setFilePath("conversions\\password-protected.docx");
            settings.setFormat("pdf");

            DocxLoadOptions loadOptions = new DocxLoadOptions();
            loadOptions.setPassword("password");
            loadOptions.setHideWordTrackedChanges(true);
            loadOptions.setDefaultFont("Arial");

            settings.setLoadOptions(loadOptions);

            PdfConvertOptions convertOptions = new PdfConvertOptions();
            convertOptions.setFromPage(1);
            convertOptions.setPagesCount(2);
            convertOptions.setZoom(100);
            convertOptions.setDpi(300.0);
            convertOptions.setBookmarksOutlineLevel(1);
            convertOptions.setCenterWindow(true);
            convertOptions.setCompressImages(false);
            convertOptions.setDisplayDocTitle(true);
            convertOptions.setExpandedOutlineLevels(1);
            convertOptions.setFitWindow(false);
            convertOptions.setFromPage(1);
            convertOptions.setGrayscale(false);
            convertOptions.setHeadingsOutlineLevels(1);
            convertOptions.setImageQuality(100);
            convertOptions.setLinearize(false);
            convertOptions.setMarginTop(5);
            convertOptions.setMarginLeft(5);
            convertOptions.setPassword("password");
            convertOptions.setUnembedFonts(true);
            convertOptions.setRemoveUnusedStreams(true);
            convertOptions.setRemoveUnusedObjects(true);
            convertOptions.setRemovePdfaCompliance(false);
            convertOptions.setHeight(1024);
            settings.setConvertOptions(convertOptions);

            settings.setOutputPath("converted\\topdf");

            // convert to specified format
            apiInstance.convertDocument(new ConvertDocumentRequest(settings));
            System.out.println("Document conveted successfully.");

            Utils.getFolderFilesPath("converted\\topdf");
        } catch (ApiException e) {
            System.err.println("Exception while calling ConvertApi:");
            e.printStackTrace();
        }
    }
}

Ruby

# Load the gem
require 'groupdocs_conversion_cloud'
require 'common_utilities/Utils.rb'

class Working_With_Conversions
  def self.Conversion_Ruby_Convert_To_Pdf()

    # Getting instance of the API
    api = Common_Utilities.Get_ConvertApi_Instance()

    $settings = GroupDocsConversionCloud::ConvertSettings.new()
    $settings.storage_name = $myStorage;
    $settings.file_path = "conversions/password-protected.docx"
    $settings.format = "pdf"

    $loadOptions = GroupDocsConversionCloud::DocxLoadOptions.new()
    $loadOptions.password = "password"

    $settings.load_options = $loadOptions;

    $convertOptions = GroupDocsConversionCloud::PdfConvertOptions.new()
    $convertOptions.bookmarks_outline_level = 1;
    $convertOptions.center_window = true
    $convertOptions.compress_images = false;
    $convertOptions.display_doc_title = true
    $convertOptions.dpi = 1024
    $convertOptions.expanded_outline_levels = 1
    $convertOptions.fit_window = false
    $convertOptions.from_page = 1
    $convertOptions.pages_count = 1
    $convertOptions.grayscale = true
    $convertOptions.headings_outline_levels = 1
    $convertOptions.image_quality = 100
    $convertOptions.linearize = false
    $convertOptions.margin_top = 5
    $convertOptions.margin_left = 5
    $convertOptions.password = "password"
    $convertOptions.unembed_fonts = true
    $convertOptions.remove_unused_streams = true
    $convertOptions.remove_unused_objects = true
    $convertOptions.remove_pdfa_compliance = false
    $convertOptions.height = 1024

    $settings.convert_options = $convertOptions
    $settings.output_path = "converted/topdf"

    $request = GroupDocsConversionCloud::ConvertDocumentRequest.new($settings)

    $response = api.convert_document($request)
    puts("Document converted successfully: " + ($response).to_s)
  end
end

Node.js

"use strict";
class Conversion_Node_Convert_To_Pdf {
    static Run() {

        var settings = new groupdocs_conversion_cloud_1.ConvertSettings();
        settings.storageName = myStorage;
        settings.filePath = "conversions/password-protected.docx";
        settings.format = "pdf";

        var loadOptions = new groupdocs_conversion_cloud_1.DocxLoadOptions();
        loadOptions.password = "password";

        settings.loadOptions = loadOptions;

        var convertOptions = new groupdocs_conversion_cloud_1.PdfConvertOptions();
        convertOptions.bookmarksOutlineLevel = 1;
        convertOptions.centerWindow = true;
        convertOptions.compressImages = false;
        convertOptions.displayDocTitle = true;
        convertOptions.dpi = 1024;
        convertOptions.expandedOutlineLevels = 1;
        convertOptions.fitWindow = false;
        convertOptions.fromPage = 1;
        convertOptions.pagesCount = 1;
        convertOptions.grayscale = true;
        convertOptions.headingsOutlineLevels = 1;
        convertOptions.imageQuality = 100;
        convertOptions.linearize = false;
        convertOptions.marginTop = 5;
        convertOptions.marginLeft = 5;
        convertOptions.password = "password";
        convertOptions.unembedFonts = true;
        convertOptions.removeUnusedStreams = true;
        convertOptions.removeUnusedObjects = true;
        convertOptions.removePdfaCompliance = false;
        convertOptions.height = 1024;

        settings.convertOptions = convertOptions;
        settings.outputPath = "converted/topdf";

        var request = new groupdocs_conversion_cloud_1.ConvertDocumentRequest(settings);
        convertApi.convertDocument(request)
            .then(function (response) {
                console.log("Document converted successfully: " + response[0].url);
            })
            .catch(function (error) {
                console.log("Error: " + error.message);
            });
    }
}
module.exports = Conversion_Node_Convert_To_Pdf;

Python

# Import modules
import groupdocs_conversion_cloud
from Common_Utilities.Utils import Common_Utilities


class Conversion_Python_Convert_To_Pdf:
    
    @classmethod
    def Run(self):
        # Create instance of the API
        api = Common_Utilities.Get_ConvertApi_Instance()
        
        try:
            settings = groupdocs_conversion_cloud.ConvertSettings()
            settings.storage_name = Common_Utilities.myStorage;
            settings.file_path = "conversions\\password-protected.docx"
            settings.format = "jpeg"
            
            loadOptions = groupdocs_conversion_cloud.DocxLoadOptions()
            loadOptions.password = "password"
            
            settings.load_options = loadOptions;
            
            convertOptions = groupdocs_conversion_cloud.PdfConvertOptions()
            convertOptions.bookmarks_outline_level = 1;
            convertOptions.center_window = True
            convertOptions.compress_images = False;
            convertOptions.display_doc_title = True
            convertOptions.dpi = 1024
            convertOptions.expanded_outline_levels = 1
            convertOptions.fit_window = False
            convertOptions.from_page = 1
            convertOptions.pages_count = 1
            convertOptions.grayscale = True
            convertOptions.headings_outline_levels = 1
            convertOptions.image_quality = 100
            convertOptions.linearize = False
            convertOptions.margin_top = 5
            convertOptions.margin_left = 5
            convertOptions.password = "password"
            convertOptions.unembed_fonts = True
            convertOptions.remove_unused_streams = True
            convertOptions.remove_unused_objects = True
            convertOptions.remove_pdfa_compliance = False
            convertOptions.height = 1024
            
            settings.convert_options = convertOptions
            settings.output_path = "converted\\topdf"
            
            request = groupdocs_conversion_cloud.ConvertDocumentRequest(settings)
            response = api.convert_document(request)

            print("Document converted successfully: " + str(response))
        except groupdocs_conversion_cloud.ApiException as e:
            print("Exception while calling API: {0}".format(e.message))

// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go-samples
package convert

import (
 "fmt"
 "os"

 "github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go-samples/config"
 "github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go/models"
)

func ConvertToPdf() {

 settings := models.ConvertSettings{
  Format:     "pdf",
  FilePath:   "WordProcessing/four-pages.docx",
  OutputPath: "converted",
 }

 result, _, err := config.Client.ConvertApi.ConvertDocument(config.Ctx, settings)

 if err != nil {
  fmt.Printf("ConvertToPdf error: %v\n", err)
  return
 }
}

Convert to PDF Formats with Stream Output

You can convert the supported document formats to PDF Formats and get output as stream.

Resource

The following GroupDocs.Conversion Cloud REST API resource has been used in the convert to PDF format example.

cURL example

Request

curl -X POST "https://api.groupdocs.cloud/v2.0/conversion" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]" -H  "Content-Type: application/json" -d "{  \"Storage\": \"MyStorage\",  \"FilePath\": \"conversions/password-protected.docx\",  \"Format\": \"pptx\",  \"LoadOptions\": {\"DocxLoadOptions\": {\"Password\": \"password\"  }},  \"ConvertOptions\": {\"PdfConvertOptions\": {\"BookmarksOutlineLevel\": \"1\",                        \"CenterWindow\" :\"true\",  \"CompressImages\": \"false\",   \"DisplayDocTitle\":  \"true\", \"Dpi\":\"1024\",  \"ExpandedOutlineLevels\": \"1\",   \"FitWindow\": \"false\",\"FromPage\" \"1\",   \"Grayscale\": \"false\",  \"HeadingsOutlineLevels\": \"1\",   \"ImageQuality\": \"100\",                        \"Linearize\": \"false\",   \"MarginTop\": \"5\",   \"MarginLeft\": \"5\", \"Password\": \"password\",  \"UnembedFonts\": \"true\",  \"RemoveUnusedStreams\": \"true\",  \"RemoveUnusedObjects\": \"true\", \"RemovePdfaCompliance\": \"false\", \"Height\": \"1024\"}  },  \"OutputPath\": \""}"

Response

File contents

SDK examples

using System;
using System.Collections.Generic;
using System.IO;
using GroupDocs.Conversion.Cloud.Sdk.Api;
using GroupDocs.Conversion.Cloud.Sdk.Client;
using GroupDocs.Conversion.Cloud.Sdk.Model;
using GroupDocs.Conversion.Cloud.Sdk.Model.Requests;

namespace GroupDocs.Conversion.Cloud.Examples.CSharp
{
    // Convert to PDF with load and save options with output as iostream
    class Convert_To_Pdf_Stream
    {
        public static void Run()
        {
            var configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);

            var apiInstance = new ConvertApi(configuration);

            try
            {
                // convert settings
                var settings = new ConvertSettings
                {
                    StorageName = Common.MyStorage,
                    FilePath = "conversions/password-protected.docx",
                    Format = "pdf",
                    LoadOptions = new DocxLoadOptions() { Password = "password" },
                    ConvertOptions = new PdfConvertOptions()
                    {
                        BookmarksOutlineLevel = 1,
                        CenterWindow = true,
                        CompressImages = false,
                        DisplayDocTitle = true,
                        Dpi = 1024,
                        ExpandedOutlineLevels = 1,
                        FitWindow = false,
                        FromPage = 1,
                        Grayscale = false,
                        HeadingsOutlineLevels = 1,
                        ImageQuality = 100,
                        Linearize = false,
                        MarginTop = 5,
                        MarginLeft = 5,
                        Password = "password",
                        UnembedFonts = true,
                        RemoveUnusedStreams = true,
                        RemoveUnusedObjects = true,
                        RemovePdfaCompliance = false,
                        Height = 1024
                    },
                    OutputPath = null // set OutputPath as null will result the output as document IOStream
                };

                // convert to specified format
                Stream response = apiInstance.ConvertDocumentDownload(new ConvertDocumentRequest(settings));
                Console.WriteLine("Document conveted successfully: " + response.Length.ToString());
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception when calling ConvertApi: " + e.Message);
            }
        }
    }
}

PHP

<?php

include(dirname(__DIR__) . '\CommonUtils.php');

    $convertApi = CommonUtils::GetConvertApiInstance();

    try 
    {
        $settings = new GroupDocs\Conversion\Model\ConvertSettings();

        $settings->setStorageName(CommonUtils::$MyStorage);
        $settings->setFilePath("conversions\\password-protected.docx");
        $settings->setFormat("pdf");

        $loadOptions = new GroupDocs\Conversion\Model\DocxLoadOptions();
        $loadOptions->setPassword("password");
        $loadOptions->setHideWordTrackedChanges(true);
        $loadOptions->setDefaultFont("Arial");

        $settings->setLoadOptions($loadOptions);

        $convertOptions = new GroupDocs\Conversion\Model\PdfConvertOptions();
        $convertOptions->setFromPage(1);
        $convertOptions->setPagesCount(2);
        $convertOptions->setZoom(100);
        $convertOptions->setDpi(300.0);
        $convertOptions->setBookmarksOutlineLevel(1);
        $convertOptions->setCenterWindow(true);
        $convertOptions->setCompressImages(false);
        $convertOptions->setDisplayDocTitle(true);
        $convertOptions->setExpandedOutlineLevels(1);
        $convertOptions->setFitWindow(false);
        $convertOptions->setFromPage(1);
        $convertOptions->setGrayscale(false);
        $convertOptions->setHeadingsOutlineLevels(1);
        $convertOptions->setImageQuality(100);
        $convertOptions->setLinearize(false);
        $convertOptions->setMarginTop(5);
        $convertOptions->setMarginLeft(5);
        $convertOptions->setPassword("password");
        $convertOptions->setUnembedFonts(true);
        $convertOptions->setRemoveUnusedStreams(true);
        $convertOptions->setRemoveUnusedObjects(true);
        $convertOptions->setRemovePdfaCompliance(false);
        $settings->setConvertOptions($convertOptions);

        // set OutputPath as empty will result the output as document Stream'
        $settings->setOutputPath("");
        
        $request = new GroupDocs\Conversion\Model\Requests\ConvertDocumentRequest($settings);

        $response = $convertApi->convertDocumentDownload($request);
        echo "Document converted successfully: Document Size: ", $response->getSize();
    } 
    catch (Exception $e) 
    {
        echo  "Something went wrong: ",  $e->getMessage(), "<br />";
        PHP_EOL;
    }
?>

Java

package examples.Working_With_Conversions;

import com.groupdocs.cloud.conversion.api.*;
import com.groupdocs.cloud.conversion.client.ApiException;
import com.groupdocs.cloud.conversion.model.*;
import com.groupdocs.cloud.conversion.model.requests.*;
import examples.Utils;
import java.util.stream.*;

public class Conversion_Java_Convert_To_Pdf_Stream {

    public static void main(String[] args) {

        ConvertApi apiInstance = new ConvertApi(Utils.AppSID, Utils.AppKey);
        try {

            ConvertSettings settings = new ConvertSettings();

            settings.setStorageName(Utils.MYStorage);
            settings.setFilePath("conversions\\password-protected.docx");
            settings.setFormat("pdf");

            DocxLoadOptions loadOptions = new DocxLoadOptions();
            loadOptions.setPassword("password");
            loadOptions.setHideWordTrackedChanges(true);
            loadOptions.setDefaultFont("Arial");

            settings.setLoadOptions(loadOptions);

            PdfConvertOptions convertOptions = new PdfConvertOptions();
            convertOptions.setFromPage(1);
            convertOptions.setPagesCount(2);
            convertOptions.setZoom(100);
            convertOptions.setDpi(300.0);
            convertOptions.setBookmarksOutlineLevel(1);
            convertOptions.setCenterWindow(true);
            convertOptions.setCompressImages(false);
            convertOptions.setDisplayDocTitle(true);
            convertOptions.setExpandedOutlineLevels(1);
            convertOptions.setFitWindow(false);
            convertOptions.setFromPage(1);
            convertOptions.setGrayscale(false);
            convertOptions.setHeadingsOutlineLevels(1);
            convertOptions.setImageQuality(100);
            convertOptions.setLinearize(false);
            convertOptions.setMarginTop(5);
            convertOptions.setMarginLeft(5);
            convertOptions.setPassword("password");
            convertOptions.setUnembedFonts(true);
            convertOptions.setRemoveUnusedStreams(true);
            convertOptions.setRemoveUnusedObjects(true);
            convertOptions.setRemovePdfaCompliance(false);
            convertOptions.setHeight(1024);
            settings.setConvertOptions(convertOptions);

            // set OutputPath as empty will result the output as document IOStream
            settings.setOutputPath("");

            // convert to specified format
            Stream response = apiInstance.convertDocument(new ConvertDocumentRequest(convertSettings));
            System.out.println("Document converted successfully: " + response);
        } catch (ApiException e) {
            System.err.println("Exception while calling ConvertApi:");
            e.printStackTrace();
        }
    }
}

Ruby

# Load the gem
require 'groupdocs_conversion_cloud'
require 'common_utilities/Utils.rb'

class Working_With_Conversions
  def self.Conversion_Ruby_Convert_To_Pdf_Stream()

    # Getting instance of the API
    api = Common_Utilities.Get_ConvertApi_Instance()

    $settings = GroupDocsConversionCloud::ConvertSettings.new()
    $settings.storage_name = $myStorage;
    $settings.file_path = "conversions/password-protected.docx"
    $settings.format = "pdf"

    $loadOptions = GroupDocsConversionCloud::DocxLoadOptions.new()
    $loadOptions.password = "password"

    $settings.load_options = $loadOptions;

    $convertOptions = GroupDocsConversionCloud::PdfConvertOptions.new()
    $convertOptions.bookmarks_outline_level = 1;
    $convertOptions.center_window = true
    $convertOptions.compress_images = false;
    $convertOptions.display_doc_title = true
    $convertOptions.dpi = 1024
    $convertOptions.expanded_outline_levels = 1
    $convertOptions.fit_window = false
    $convertOptions.from_page = 1
    $convertOptions.pages_count = 1
    $convertOptions.grayscale = true
    $convertOptions.headings_outline_levels = 1
    $convertOptions.image_quality = 100
    $convertOptions.linearize = false
    $convertOptions.margin_top = 5
    $convertOptions.margin_left = 5
    $convertOptions.password = "password"
    $convertOptions.unembed_fonts = true
    $convertOptions.remove_unused_streams = true
    $convertOptions.remove_unused_objects = true
    $convertOptions.remove_pdfa_compliance = false
    $convertOptions.height = 1024

    $settings.convert_options = $convertOptions
    # leave OutputPath will result the output as document IOStream

    $request = GroupDocsConversionCloud::ConvertDocumentRequest.new($settings)

    $response = api.convert_document($request)
    puts("Document converted successfully: " + ($response.length).to_s)
  end
end

Node.js

"use strict";
class Conversion_Node_Convert_To_Pdf_Stream {
    static Run() {

        var settings = new groupdocs_conversion_cloud_1.ConvertSettings();
        settings.storageName = myStorage;
        settings.filePath = "conversions/password-protected.docx";
        settings.format = "pdf";

        var loadOptions = new groupdocs_conversion_cloud_1.DocxLoadOptions();
        loadOptions.password = "password";

        settings.loadOptions = loadOptions;

        var convertOptions = new groupdocs_conversion_cloud_1.PdfConvertOptions();
        convertOptions.bookmarksOutlineLevel = 1;
        convertOptions.centerWindow = true;
        convertOptions.compressImages = false;
        convertOptions.displayDocTitle = true;
        convertOptions.dpi = 1024;
        convertOptions.expandedOutlineLevels = 1;
        convertOptions.fitWindow = false;
        convertOptions.fromPage = 1;
        convertOptions.pagesCount = 1;
        convertOptions.grayscale = true;
        convertOptions.headingsOutlineLevels = 1;
        convertOptions.imageQuality = 100;
        convertOptions.linearize = false;
        convertOptions.marginTop = 5;
        convertOptions.marginLeft = 5;
        convertOptions.password = "password";
        convertOptions.unembedFonts = true;
        convertOptions.removeUnusedStreams = true;
        convertOptions.removeUnusedObjects = true;
        convertOptions.removePdfaCompliance = false;
        convertOptions.height = 1024;

        settings.convertOptions = convertOptions;
        settings.outputPath = null; // set OutputPath as null will result the output as document IOStream

        var request = new groupdocs_conversion_cloud_1.ConvertDocumentRequest(settings);
        convertApi.convertDocumentDownload(request)
            .then(function (response) {
                console.log("Document converted successfully: " + response.length);
            })
            .catch(function (error) {
                console.log("Error: " + error.message);
            });
    }
}
module.exports = Conversion_Node_Convert_To_Pdf_Stream;

Python

# Import modules
import groupdocs_conversion_cloud
from Common_Utilities.Utils import Common_Utilities


class Conversion_Python_Convert_To_Pdf_Stream:
    
    @classmethod
    def Run(self):
        # Create instance of the API
        api = Common_Utilities.Get_ConvertApi_Instance()
        
        try:
            settings = groupdocs_conversion_cloud.ConvertSettings()
            settings.storage_name = Common_Utilities.myStorage;
            settings.file_path = "conversions\\password-protected.docx"
            settings.format = "jpeg"
            
            loadOptions = groupdocs_conversion_cloud.DocxLoadOptions()
            loadOptions.password = "password"
            
            settings.load_options = loadOptions;
            
            convertOptions = groupdocs_conversion_cloud.PdfConvertOptions()
            convertOptions.bookmarks_outline_level = 1;
            convertOptions.center_window = True
            convertOptions.compress_images = False;
            convertOptions.display_doc_title = True
            convertOptions.dpi = 1024
            convertOptions.expanded_outline_levels = 1
            convertOptions.fit_window = False
            convertOptions.from_page = 1
            convertOptions.pages_count = 1
            convertOptions.grayscale = True
            convertOptions.headings_outline_levels = 1
            convertOptions.image_quality = 100
            convertOptions.linearize = False
            convertOptions.margin_top = 5
            convertOptions.margin_left = 5
            convertOptions.password = "password"
            convertOptions.unembed_fonts = True
            convertOptions.remove_unused_streams = True
            convertOptions.remove_unused_objects = True
            convertOptions.remove_pdfa_compliance = False
            convertOptions.height = 1024
            
            settings.convert_options = convertOptions
            settings.output_path = None  # leave OutputPath will result the output as document IOStream
            
            request = groupdocs_conversion_cloud.ConvertDocumentRequest(settings)
            response = api.convert_document_download(request)

            print("Document converted successfully: " + str(len(response)))
        except groupdocs_conversion_cloud.ApiException as e:
            print("Exception while calling API: {0}".format(e.message))

// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go-samples
package convert

import (
 "fmt"
 "os"

 "github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go-samples/config"
 "github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go/models"
)

func ConvertToPdf() {

 settings := models.ConvertSettings{
  Format:     "pdf",
  FilePath:   "WordProcessing/four-pages.docx",
 }

 result, _, err := config.Client.ConvertApi.ConvertDocument(config.Ctx, settings)

 if err != nil {
  fmt.Printf("ConvertToPdf error: %v\n", err)
  return
 }

 // Get file info
 fileInfo, errInfo := result.Stat()
 if errInfo != nil {
  t.Error(errInfo)
 }

 // Get the size of the file
 fileSize := fileInfo.Size()
}

Convert to PDF with Advanced Options

This example demonstrates how to convert word processing documents into pdf documents with advanced conversion options.

There are steps that usage of GroupDocs.Conversion Cloud consists of:

Upload input document into cloud storage
Convert document
Download converted document from storage

Steps 1 and 3 are storage operations, please refer to this GroupDocs.Conversion Cloud Storage Operations for usage details.

Step 3 is not needed if the “OutputPath” option is not provided: the convert API method will return the converted document in the response body.

Resource

HTTP POST ~/conversion

Swagger UI lets you call this REST API directly from the browser.

cURL example

Request


# First get JSON Web Token
# Please get your Client Id and Client Secret from https://dashboard.groupdocs.cloud/applications. Kindly place Client Id in "client_id" and Client Secret in "client_secret" argument.
curl -v "https://api.groupdocs.cloud/connect/token" \
-X POST \
-d "grant_type#client_credentials&client_id#xxxx&client_secret#xxxx" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"

# cURL example to convert document
curl -v "https://api.groupdocs.cloud/v2.0/conversion/conversion" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"
-d "{
        'FilePath': 'WordProcessing/password-protected.docx',
        'Format': 'pdf',
        'LoadOptions': {'Password': 'password'},
        'ConvertOptions': {
            'FromPage': 1,
            'Dpi': 1024,
            'UnembedFonts': true
        },
        'OutputPath': 'Output'
    }"

Response


[
  {
    "name": "password-protected.pdf",
    "size": 4434,
    "path": "Output/password-protected.pdf",
    "url": "https://api.groupdocs.cloud/v2.0/conversion/storage/file/Output/password-protected.pdf"
  }
]

SDK examples

// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-dotnet-samples
string MyAppKey = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
string MyAppSid = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
var configuration = new Configuration(MyAppSid, MyAppKey);
  
// Create necessary API instances
var apiInstance = new ConvertApi(configuration);
 
// Prepare convert settings
var settings = new ConvertSettings
{
    FilePath = "WordProcessing/password-protected.docx",
    Format = "pdf",
    LoadOptions = new DocxLoadOptions { Password = "password" },
    ConvertOptions = new PdfConvertOptions
    {
        CenterWindow = true,
        CompressImages = false,
        DisplayDocTitle = true,
        Dpi = 1024,
        FitWindow = false,
        FromPage = 1,
        Grayscale = false,
        ImageQuality = 100,
        Linearize = false,
        MarginTop = 5,
        MarginLeft = 5,
        Password = "password",
        UnembedFonts = true,
        RemoveUnusedStreams = true,
        RemoveUnusedObjects = true,
        RemovePdfaCompliance = false
    },
    OutputPath = "converted"
};
// Convert to specified format
var response = apiInstance.ConvertDocument(new ConvertDocumentRequest(settings));

Java

// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java-samples
String MyAppKey = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
String MyAppSid = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
Configuration configuration = new Configuration(MyAppSid, MyAppKey);
  
// Create API instance
ConvertApi apiInstance = new ConvertApi(configuration);
 
// Prepare convert settings
ConvertSettings settings = new ConvertSettings();
settings.setFilePath("WordProcessing/password-protected.docx");
settings.setFormat("pdf");
 
DocxLoadOptions loadOptions = new DocxLoadOptions();
loadOptions.setPassword("password");
 
settings.setLoadOptions(loadOptions);
 
PdfConvertOptions convertOptions = new PdfConvertOptions();
convertOptions.setCenterWindow(true);
convertOptions.setCompressImages(false);
convertOptions.setDisplayDocTitle(true);
convertOptions.setDpi(1024.0);
convertOptions.setFitWindow(false);
convertOptions.setFromPage(1);
convertOptions.setGrayscale(false);
convertOptions.setImageQuality(100);
convertOptions.setLinearize(false);
convertOptions.setMarginTop(5);
convertOptions.setMarginLeft(5);
convertOptions.setPassword("password");
convertOptions.setUnembedFonts(true);
convertOptions.setRemoveUnusedStreams(true);
convertOptions.setRemoveUnusedObjects(true);
convertOptions.setRemovePdfaCompliance(false);
 
settings.setConvertOptions(convertOptions);
settings.setOutputPath("converted");
 
List<StoredConvertedResult> result = apiInstance.convertDocument(new ConvertDocumentRequest(settings));

PHP

// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php-samples
use GroupDocs\Conversion\Model;
use GroupDocs\Conversion\Model\Requests;
 
$AppSid = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$AppKey = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
$configuration = new GroupDocs\Conversion\Configuration();
$configuration->setAppSid($AppSid);
$configuration->setAppKey($AppKey);
 
$apiInstance = new GroupDocs\Conversion\ConvertApi($configuration);
 
// Prepare convert settings
$settings = new Model\ConvertSettings();
$settings->setFilePath("WordProcessing/password-protected.docx");
$settings->setFormat("pdf");
$loadOptions = new Model\DocxLoadOptions();
$loadOptions->setPassword("password");
$settings->setLoadOptions($loadOptions);
 
$convertOptions = new Model\PdfConvertOptions();
$convertOptions->setCenterWindow(true);
$convertOptions->setCompressImages(false);
$convertOptions->setDisplayDocTitle(true);
$convertOptions->setDpi(1024.0);
$convertOptions->setFitWindow(false);
$convertOptions->setFromPage(1);
$convertOptions->setGrayscale(false);
$convertOptions->setImageQuality(100);
$convertOptions->setLinearize(false);
$convertOptions->setMarginTop(5);
$convertOptions->setMarginLeft(5);
$convertOptions->setPassword("password");
$convertOptions->setUnembedFonts(true);
$convertOptions->setRemoveUnusedStreams(true);
$convertOptions->setRemoveUnusedObjects(true);
$convertOptions->setRemovePdfaCompliance(false);
 
$settings->setConvertOptions($convertOptions);
$settings->setOutputPath("converted");
 
// Convert
$result = $apiInstance->convertDocument(new Requests\ConvertDocumentRequest($settings));

Ruby

# For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby-samples
require 'groupdocs_conversion_cloud'
 
$app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
# Create necessary API instances
apiInstance = GroupDocsConversionCloud::ConvertApi.from_keys($app_sid, $app_key)
 
# Prepare convert settings
settings = GroupDocsConversionCloud::ConvertSettings.new
settings.file_path = "WordProcessing/password-protected.docx"
settings.format = "pdf"
 
loadOptions = GroupDocsConversionCloud::DocxLoadOptions.new
loadOptions.password = "password"
convertOptions = GroupDocsConversionCloud::PdfConvertOptions.new
convertOptions.center_window = true
convertOptions.compress_images = false
convertOptions.display_doc_title = true
convertOptions.dpi = 1024.0
convertOptions.fit_window = false
convertOptions.from_page = 1
convertOptions.grayscale = false
convertOptions.image_quality = 100
convertOptions.linearize = false
convertOptions.margin_top = 5
convertOptions.margin_left = 5
convertOptions.password = "password"
convertOptions.unembed_fonts = true
convertOptions.remove_unused_streams = true
convertOptions.remove_unused_objects = true
convertOptions.remove_pdfa_compliance = false
 
settings.load_options = loadOptions
settings.convert_options = convertOptions
settings.output_path = "converted"
 
# Convert
result = apiInstance.convert_document(GroupDocsConversionCloud::ConvertDocumentRequest.new(settings))

Node.js

// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-node-samples
global.conversion_cloud = require("groupdocs-conversion-cloud");
 
global.appSid = "XXXX-XXXX-XXXX-XXXX"; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
global.appKey = "XXXXXXXXXXXXXXXX"; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
global.convertApi = conversion_cloud.ConvertApi.fromKeys(appSid, appKey);
 
let settings = new conversion_cloud.ConvertSettings();
settings.filePath = "WordProcessing/password-protected.docx";
settings.format = "pdf";
 
let loadOptions = new conversion_cloud.DocxLoadOptions();
loadOptions.password = "password";
 
settings.loadOptions = loadOptions;
let convertOptions = new conversion_cloud.PdfConvertOptions();
convertOptions.centerWindow = true;
convertOptions.compressImages = false;
convertOptions.displayDocTitle = true;
convertOptions.dpi = 1024.0;
convertOptions.fitWindow = false;
convertOptions.fromPage = 1;
convertOptions.grayscale = false;
convertOptions.imageQuality = 100;
convertOptions.linearize = false;
convertOptions.marginTop = 5;
convertOptions.marginLeft = 5;
convertOptions.password = "password";
convertOptions.unembedFonts = true;
convertOptions.removeUnusedStreams = true;
convertOptions.removeUnusedObjects = true;
convertOptions.removePdfaCompliance = false;
settings.convertOptions = convertOptions
settings.outputPath = "converted";
 
let result = await convertApi.convertDocument(new conversion_cloud.ConvertDocumentRequest(settings));

Python

# For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python-samples
import groupdocs_conversion_cloud
 
app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
# Create necessary API instances
apiInstance = groupdocs_conversion_cloud.ConvertApi.from_keys(Common.app_sid, Common.app_key)
 
# Prepare convert settings
settings = groupdocs_conversion_cloud.ConvertSettings()
settings.file_path = "WordProcessing/password-protected.docx"
settings.format = "pdf"
 
loadOptions = groupdocs_conversion_cloud.DocxLoadOptions()
loadOptions.password = "password"
convertOptions = groupdocs_conversion_cloud.PdfConvertOptions()
convertOptions.center_window = True
convertOptions.compress_images = False
convertOptions.display_doc_title = True
convertOptions.dpi = 1024.0
convertOptions.fit_window = False
convertOptions.from_page = 1
convertOptions.grayscale = False
convertOptions.image_quality = 100
convertOptions.linearize = False
convertOptions.margin_top = 5
convertOptions.margin_left = 5
convertOptions.password = "password"
convertOptions.unembed_fonts = True
convertOptions.remove_unused_streams = True
convertOptions.remove_unused_objects = True
convertOptions.remove_pdfa_compliance = False
 
settings.load_options = loadOptions
settings.convert_options = convertOptions
settings.output_path = "converted"
 
# Convert
result = apiInstance.convert_document(groupdocs_conversion_cloud.ConvertDocumentRequest(settings))

// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go-samples
package convert

import (
 "fmt"

 "github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go-samples/config"
 "github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-go/models"
)

func ConvertToPdf() {

 settings := models.ConvertSettings{
  Format:     "pdf",
  FilePath:   "WordProcessing/four-pages.docx",
  OutputPath: "converted",
  ConvertOptions: &models.PdfConvertOptions{
   CenterWindow:         true,
   CompressImages:       false,
   DisplayDocTitle:      true,
   Dpi:                  1024,
   FitWindow:            false,
   FromPage:             1,
   Grayscale:            false,
   ImageQuality:         100,
   Linearize:            false,
   MarginTop:            5,
   MarginLeft:           5,
   Password:             "password",
   UnembedFonts:         true,
   RemoveUnusedStreams:  true,
   RemoveUnusedObjects:  true,
   RemovePdfaCompliance: false,
  },
 }

 result, _, err := config.Client.ConvertApi.ConvertDocument(config.Ctx, settings)

 if err != nil {
  fmt.Printf("ConvertToPdf error: %v\n", err)
  return
 }

 fmt.Printf("Document converted successfully: %v\n", result[0].Url)
}

We value your opinion. Your feedback will help us improve our documentation.

6. Convert to PDF Formats Leave feedback

On this page

Convert to PDF Formats

Resource

cURL example

SDK examples

Convert to PDF Formats with Stream Output

Resource

cURL example

SDK examples

Convert to PDF with Advanced Options

Resource

cURL example

SDK examples

Was this page helpful?

Any additional feedback you'd like to share with us?

Please tell us how we can improve this page.

Thank you for your feedback!

On this page