Create Empty PDF

Introduction

This example allows you to create an empty PDF file using Aspose.PDF REST API. The API has the following properties

Parameter	Required	Description	Parameter Type	Data Type
name	yes	The new document name.	path	string
storage	no	The document storage	query	query
folder	no	The new document folder.	query	query

Resource

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

cURL Example

Request

Get Auth Token

// Please get your App Key and App SID from https://dashboard.aspose.cloud/#/apps. Kindly place App Key in "client_secret" and App SID in "client_id" argument.

curl -v "https://api.aspose.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 -X PUT "https://api.aspose.cloud/v3.0/pdf/4pages.pdf"\
-H "accept: application/json" 

-H "authorization: Bearer <jwt token>

Response

    {

  "Document": {

    "DocumentProperties": {

      "List": [

        {

          "Name": "Author",

          "Value": "",

          "BuiltIn": true,

          "Links": [

            {

              "Href": "/Author",

              "Rel": "self",

              "Type": null,

              "Title": null

            }

          ]

        },

        {

          "Name": "CreationDate",

          "Value": "07/06/2020 10:34:34.000 AM",

          "BuiltIn": true,

          "Links": [

            {

              "Href": "/CreationDate",

              "Rel": "self",

              "Type": null,

              "Title": null

            }

          ]

        },

        {

          "Name": "Creator",

          "Value": "Aspose Ltd.",

          "BuiltIn": true,

          "Links": [

            {

              "Href": "/Creator",

              "Rel": "self",

              "Type": null,

              "Title": null

            }

          ]

        },

        {

          "Name": "Keywords",

          "Value": null,

          "BuiltIn": true,

          "Links": [

            {

              "Href": "/Keywords",

              "Rel": "self",

              "Type": null,

              "Title": null

            }

          ]

        },

        {

          "Name": "ModDate",

          "Value": "07/06/2020 10:34:34.000 AM",

          "BuiltIn": true,

          "Links": [

            {

              "Href": "/ModDate",

              "Rel": "self",

              "Type": null,

              "Title": null

            }

          ]

        },

        {

          "Name": "Producer",

          "Value": "Aspose.PDF for .NET 20.6",

          "BuiltIn": true,

          "Links": [

            {

              "Href": "/Producer",

              "Rel": "self",

              "Type": null,

              "Title": null

            }

          ]

        },

        {

          "Name": "Subject",

          "Value": "",

          "BuiltIn": true,

          "Links": [

            {

              "Href": "/Subject",

              "Rel": "self",

              "Type": null,

              "Title": null

            }

          ]

        },

        {

          "Name": "Title",

          "Value": "",

          "BuiltIn": true,

          "Links": [

            {

              "Href": "/Title",

              "Rel": "self",

              "Type": null,

              "Title": null

            }

          ]

        }

      ],

      "Links": [

        {

          "Href": "/4pages.pdf/documentproperties",

          "Rel": "self",

          "Type": null,

          "Title": null

        }

      ]

    },

    "DisplayProperties": {

      "CenterWindow": false,

      "Direction": "L2R",

      "DisplayDocTitle": false,

      "HideMenuBar": false,

      "HideToolBar": false,

      "HideWindowUI": false,

      "NonFullScreenPageMode": "UseNone",

      "PageLayout": "Default",

      "PageMode": "UseNone",

      "Links": [

        {

          "Href": "/4pages.pdf/displayproperties",

          "Rel": "self",

          "Type": null,

          "Title": null

        }

      ]

    },

    "Pages": {

      "List": [

        {

          "Id": 1,

          "Images": {

            "List": [],

            "Links": [

              {

                "Href": "/4pages.pdf/pages/1/images",

                "Rel": "self",

                "Type": null,

                "Title": null

              }

            ]

          },

          "Rectangle": {

            "LLX": 0,

            "LLY": 0,

            "URX": 595,

            "URY": 842

          },

          "Links": [

            {

              "Href": "/1",

              "Rel": "self",

              "Type": null,

              "Title": null

            }

          ]

        }

      ],

      "Links": [

        {

          "Href": "/4pages.pdf/pages",

          "Rel": "self",

          "Type": null,

          "Title": null

        }

      ]

    },

    "Links": [

      {

        "Href": "/4pages.pdf",

        "Rel": "self",

        "Type": null,

        "Title": null

      },

      {

        "Href": "/4pages.pdf",

        "Rel": "alternate",

        "Type": "application/pdf",

        "Title": "Download As PDF"

      },

      {

        "Href": "/4pages.pdf",

        "Rel": "alternate",

        "Type": "image/tiff",

        "Title": "Download As TIFF"

      },

      {

        "Href": "/4pages.pdf",

        "Rel": "alternate",

        "Type": "application/msword",

        "Title": "Download As DOC"

      },

      {

        "Href": "/4pages.pdf",

        "Rel": "alternate",

        "Type": "application/vnd.ms-xpsdocument",

        "Title": "Download As XPS"

      },

      {

        "Href": "/4pages.pdf",

        "Rel": "alternate",

        "Type": "application/zip",

        "Title": "Download As TeX"

      },

      {

        "Href": "/4pages.pdf",

        "Rel": "alternate",

        "Type": "application/zip",

        "Title": "Download As HTML"

      },

      {

        "Href": "/4pages.pdf",

        "Rel": "alternate",

        "Type": "application/pdf",

        "Title": "Download As PDF/A-1a"

      },

      {

        "Href": "/4pages.pdf",

        "Rel": "alternate",

        "Type": "application/pdf",

        "Title": "Download As PDF/A-1b"

      }

    ]

  },

  "Messages": null,

  "Code": 200,

  "Status": "OK"

}

SDK Source

Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of making requests and handling responses and lets you focus on writing code specific to your particular project. Checkout our GitHub repository for a complete list of Aspose.PDF SDKs along with working examples, to get you started in no time.

SDK Examples

Create Empty PDF

C#

// For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
PdfApi pdfApi = new PdfApi(Common.APP_KEY, Common.APP_SID, Common.BASEPATH);
StorageApi storageApi = new StorageApi(Common.APP_KEY, Common.APP_SID, Common.BASEPATH);

String fileName = "input.pdf";
String templateFile = "";
String dataFile = "";
String templateType = "";
String storage = "";
String folder = "";

try
{
    // Upload source file to aspose cloud storage
    storageApi.PutCreate( fileName, "", "", System.IO.File.ReadAllBytes(Common.GetDataDir() + fileName));

    // Invoke Aspose.PDF Cloud SDK API to create empty pdf file
    DocumentResponse apiResponse = pdfApi.PutCreateDocument(fileName, templateFile, dataFile, templateType, storage, folder);

    if (apiResponse != null && apiResponse.Status.Equals("OK"))
    {
        Console.WriteLine("Create Empty PDF, Done!");
        Console.ReadKey();
    }
}
catch (Exception ex)
{
    System.Diagnostics.Debug.WriteLine("error:" + ex.Message + "\n" + ex.StackTrace);
}

PHP

# For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
<?php
require_once realpath(__DIR__ . '/..') . '/vendor/autoload.php';
require_once realpath(__DIR__ . '/..') . '/Utils.php';

use Aspose\PDF\PdfApi;
use Aspose\PDF\AsposeApp;

class Document {

	public $pdfApi;

	public function __construct() {
		AsposeApp::$appSID = Utils::appSID;
		AsposeApp::$apiKey = Utils::apiKey;
		$this->pdfApi = new PdfApi();
	}

	public function createNewDocument() {
		// Upload file to Aspose Cloud Storage
		$fileName = "newPDFFile.pdf";

		$result = $this->pdfApi->PutCreateDocument($fileName, $templateFile = null, $dataFile = null, $templateType = null, $storage = "", $folder = "");
		print_r ( $result );
	}
}

$document = new Document();
$document->createNewDocument();

?>

Ruby

# For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
require 'aspose_pdf_cloud'

class Document

  include AsposePDFCloud
  include AsposeStorageCloud

  def initialize
    #Get App key and App SID from https://cloud.aspose.com
    AsposeApp.app_key_and_sid("APP_KEY", "APP_SID")
    @pdf_api = PdfApi.new  
  end

  def upload_file(file_name)
    @storage_api = StorageApi.new 
    response = @storage_api.put_create(file_name, File.open("../../../data/" << file_name,"r") { |io| io.read } )
  end

  # Create new document.
  def create_new_document
    file_name = "newPDFFile.pdf"
    response = @pdf_api.put_create_document(file_name)
  end

end

document = Document.new()
puts document.create_new_document

Python

import asposepdfcloud
from asposepdfcloud.PdfApi import PdfApi
from asposepdfcloud.PdfApi import ApiException

import asposestoragecloud
from asposestoragecloud.StorageApi import StorageApi
from asposestoragecloud.StorageApi import ResponseMessage

import random
import string

apiKey = "XXXXX" #sepcify App Key
appSid = "XXXXX" #sepcify App SID
apiServer = "http://api.aspose.com/v1.1"
data_folder = "../../data/"

#Instantiate Aspose Storage API SDK
storage_apiClient = asposestoragecloud.ApiClient.ApiClient(apiKey, appSid, True)
storageApi = StorageApi(storage_apiClient)
#Instantiate Aspose Pdf API SDK
api_client = asposepdfcloud.ApiClient.ApiClient(apiKey, appSid, True)
pdfApi = PdfApi(api_client);

#set input file name
name = ''.join(random.choice(string.ascii_uppercase + string.digits) for _ in range(8))
name = name + ".pdf"

try:
    #invoke Aspose.Pdf Cloud SDK API to create an empty PDF file
    response = pdfApi.PutCreateDocument(name)

    if response.Status == "OK":
        print "Empty Pdf has been created successfully"
        #download pdf from storage server
        response = storageApi.GetDownload(Path=name)
        outfilename = "c:/temp/" + name
        with open(outfilename, 'wb') as f:
                    for chunk in response.InputStream:
                        f.write(chunk)

except ApiException as ex:
            print "ApiException:"
            print "Code:" + str(ex.code)
            print "Message:" + ex.message

Node.js

For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
var fs = require('fs');
var assert = require('assert');
var PdfApi = require('asposepdfcloud');
var StorageApi = require('asposestoragecloud');
var configProps = require('../config/config.json');
var data_path = '../../../Data/';

var AppSID = configProps.app_sid;
var AppKey = configProps.api_key;
var outFolder = configProps.out_folder;
var config = {'appSid':AppSID,'apiKey':AppKey , 'debug' : true};

// Instantiate Aspose Storage API SDK
var storageApi = new StorageApi(config);
// Instantiate Aspose.Pdf API SDK
var pdfApi = new PdfApi(config);

// Set input file name
var name = "CreateEmptyPdf.pdf";

try {
// Invoke Aspose.Pdf Cloud SDK API to create an empty PDF file
pdfApi.PutCreateDocument(name, null, null, null, null, null, function(responseMessage) {
		assert.equal(responseMessage.status, 'OK');
		console.log("Empty Pdf has been created successfully");

		// Download pdf from storage server
		storageApi.GetDownload(name, null, null, function(responseMessage) {
			assert.equal(responseMessage.status, 'OK');
			var writeStream = fs.createWriteStream(data_path + "CreateEmptyPdf_out.pdf");
			writeStream.write(responseMessage.body);
			});
	});

}catch (e) 
{
  console.log("exception in example");
  console.log(e);
}

Java

// For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
String fileName = "input.pdf";
String templateFile = "";
String dataFile = "";
String templateType = "";
String storage = "";
String folder = "";
Path inputFile = Utils.getPath(CreateEmptyPDFExample.class, fileName);
try
{
	StorageApi storageApi = new StorageApi(Configuration.apiKey, Configuration.appSID, true);
	// Instantiate Aspose Words API SDK
	PdfApi pdfApi = new PdfApi(Configuration.apiKey, Configuration.appSID, true);
    // Upload source file to aspose cloud storage
    storageApi.PutCreate(fileName, "", "", inputFile.toFile());
    // Invoke Aspose.PDF Cloud SDK API to create empty pdf file
    DocumentResponse apiResponse = pdfApi.PutCreateDocument(fileName, templateFile, dataFile, templateType, storage, folder);
    if (apiResponse != null && apiResponse.getStatus().equals("OK"))
    {
        System.out.println("Create Empty PDF, Done!");
    }
}
catch (Exception ex)
{
   ex.printStackTrace();
}

Android

// For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.PDF-for-Cloud
String fileName = "input.pdf";
String templateFile = "";
String dataFile = "";
String templateType = "";
String storage = "";
String folder = "";
File input = Utils.stream2file("input","pdf", context.getResources().openRawResource(R.raw.sample_input));
try
{
	StorageApi storageApi = new StorageApi(Configuration.apiKey, Configuration.appSID, true);
	// Instantiate Aspose Words API SDK
	PdfApi pdfApi = new PdfApi(Configuration.apiKey, Configuration.appSID, true);
    // Upload source file to aspose cloud storage
    storageApi.PutCreate(fileName, "", "", input);
    // Invoke Aspose.PDF Cloud SDK API to create empty pdf file
    DocumentResponse apiResponse = pdfApi.PutCreateDocument(fileName, templateFile, dataFile, templateType, storage, folder);
    if (apiResponse != null && apiResponse.getStatus().equals("OK"))
    {
        System.out.println("Create Empty PDF, Done!");
    }
}
catch (Exception ex)
{
   ex.printStackTrace();
}

Go

// For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
fileName := "input.pdf"

// init words cloud api
config := asposepdfcloud.NewConfiguration(AppSid, AppKey, BaseURL)
client := asposepdfcloud.NewAPIClient(config)

options := map[string]interface{}{
	"storage": "First Storage",
}

//Create empty document
documentResponse, response, _ := client.PdfApi.PutCreateDocument(fileName, options)

fmt.Println(response.Status)
fmt.Println(documentResponse.Document.Pages.List[0].Id)