Getting Started

This document will guide you through the necessary steps to setup and make a request to the Document Generation API.
Use Document Generation API to merge JSON data into Word based document templates and produce high fidelity PDF and Word documents from any application.
To learn more about the Document Generation, read Overview

Live Demo

The Document Generation API Demo demonstrates how easy it is to generate customized documents from Word-based document templates and input JSON data.

How It Works

This section details out step by step instructions to get started with Document Generation.

1. Author your Word-based document templates

Authoring a document template involves adding the template tags to your Word document as illustrated below:

Document template with heading and template tags

Using MS Word Add-In
The quickest way to author a Word-based document template is by using Adobe Document Generation Word Add-In. The Add-in significantly reduces the time and effort required to insert the template tags into a Word document.

Learn more about our Word Add-in.

Manually
Alternatively, you can create a document template by manually inserting the template tags into a Word document. Here are some prebuilt sample document templates to start with.

Learn more about Template Tags.

2. Prepare your JSON data

Compose the JSON data that will be merged with your Word-based document template.

{
    "Client" : {
      "Name" : "Some Corp Inc",
      "Address" : "Somewhere Street"
    }
}
Copied to your clipboard
1{
2    "Client" : {
3      "Name" : "Some Corp Inc",
4      "Address" : "Somewhere Street"
5    }
6}

3. Generate PDF and Word documents using Document Generation API

Once you are ready with the Word-based document template and the JSON data, the final step is to invoke the Document Generation API to generate the output PDF or Word documents.
There are two ways to access the Document Generation API:

3.1. REST API
You can use our cloud based REST API to generate documents.

Before you begin with the REST API, refer How To Get Started to learn more about generating the required credentials and invoking the APIs.

3.2. REST API with External Storage

The Adobe Document Generation API now supports accessing client files directly from their external storage. Clients can use Signed URLs from their storage solution to conveniently access and utilize their files through the Document Generation API.

To learn more, please visit External Storage for Adobe PDF Services APIs.

3.3. PDF Services SDK
Alternatively, you can use our offering through PDF Services SDK.

To get started with PDF Services SDK, refer Quickstarts.

Please allow-list the following hostnames before using Adobe PDF Services SDK:

ims-na1.adobelogin.com (Required for all the clients)

For clients using SDK version 4.x and above :

Using United States (Default) region for processing documents :
- dcplatformstorageservice-prod-us-east-1.s3-accelerate.amazonaws.com (Not required, if using external storage for both input and output)
- pdf-services-ue1.adobe.io
- pdf-services.adobe.io (Default URI)

Using Europe region for processing documents :
- dcplatformstorageservice-prod-eu-west-1.s3.amazonaws.com (Not required, if using external storage for both input and output)
- pdf-services-ew1.adobe.io

For clients using SDK version 3.x and above :

Using United States region for processing documents :
- dcplatformstorageservice-prod-us-east-1.s3-accelerate.amazonaws.com
- pdf-services-ue1.adobe.io
- pdf-services.adobe.io (Default URI)

Using Europe region for processing documents :
- dcplatformstorageservice-prod-eu-west-1.s3.amazonaws.com
- pdf-services-ew1.adobe.io

For clients using SDK version upto 2.x :

cpf-ue1.adobe.io

Generate PDF or Word document

The sample below generates the output document in the PDF format. Similarly, you can specify DOCX as the OutputFormat to generate Word documents.

Please refer the API usage guide to understand how to use our APIs.

Java

.NET

Node JS

REST API

REST API with External Storage

// Get the samples from https://www.adobe.com/go/pdftoolsapi_java_samples
// Run the sample:
// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.documentmerge.MergeDocumentToPDF
 
   package com.adobe.pdfservices.operation.samples.documentmerge;
 
   public class MergeDocumentToPDF {
 
      // Initialize the logger.
      private static final Logger LOGGER = LoggerFactory.getLogger(MergeDocumentToPDF.class);
 
      public static void main(String[] args) {
 
          try (InputStream inputStream = Files.newInputStream(new File("src/main/resources/documentMergeTemplate.docx").toPath())) {
            // Initial setup, create credentials instance
            Credentials credentials = new ServicePrincipalCredentials(
                    System.getenv("PDF_SERVICES_CLIENT_ID"),
                    System.getenv("PDF_SERVICES_CLIENT_SECRET"));

            // Creates a PDF Services instance
            PDFServices pdfServices = new PDFServices(credentials);
 
            // Setup input data for the document merge process.
            JSONObject jsonDataForMerge = new JSONObject("{\"customerName\": \"Kane Miller\",\"customerVisits\": 100}");
 
            // Creates an asset(s) from source file(s) and upload
            Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.DOCX.getMediaType());

            // Create parameters for the job
            DocumentMergeParams documentMergeParams = DocumentMergeParams.documentMergeParamsBuilder()
                    .withJsonDataForMerge(jsonDataForMerge)
                    .withOutputFormat(OutputFormat.PDF)
                    .build();

            // Creates a new job instance
            DocumentMergeJob documentMergeJob = new DocumentMergeJob(asset, documentMergeParams);

            // Submit the job and gets the job result
            String location = pdfServices.submit(documentMergeJob);
            PDFServicesResponse<DocumentMergeResult> pdfServicesResponse = pdfServices.getJobResult(location, DocumentMergeResult.class);

            // Get content from the resulting asset(s)
            Asset resultAsset = pdfServicesResponse.getResult().getAsset();
            StreamAsset streamAsset = pdfServices.getContent(resultAsset);
 
            // Creates an output stream and copy stream asset's content to it
            OutputStream outputStream = Files.newOutputStream(new File("output/documentMergeOutput.pdf").toPath());
            IOUtils.copy(streamAsset.getInputStream(), outputStream);
            outputStream.close();
          } catch (ServiceApiException | IOException | SDKException | ServiceUsageException ex) {
              LOGGER.error("Exception encountered while executing operation", ex);
          }
      }
   }
     
Copied to your clipboard
1// Get the samples from https://www.adobe.com/go/pdftoolsapi_java_samples
2// Run the sample:
3// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.documentmerge.MergeDocumentToPDF
4 
5   package com.adobe.pdfservices.operation.samples.documentmerge;
6 
7   public class MergeDocumentToPDF {
8 
9      // Initialize the logger.
10      private static final Logger LOGGER = LoggerFactory.getLogger(MergeDocumentToPDF.class);
11 
12      public static void main(String[] args) {
13 
14          try (InputStream inputStream = Files.newInputStream(new File("src/main/resources/documentMergeTemplate.docx").toPath())) {
15            // Initial setup, create credentials instance
16            Credentials credentials = new ServicePrincipalCredentials(
17                    System.getenv("PDF_SERVICES_CLIENT_ID"),
18                    System.getenv("PDF_SERVICES_CLIENT_SECRET"));
19
20            // Creates a PDF Services instance
21            PDFServices pdfServices = new PDFServices(credentials);
22 
23            // Setup input data for the document merge process.
24            JSONObject jsonDataForMerge = new JSONObject("{\"customerName\": \"Kane Miller\",\"customerVisits\": 100}");
25 
26            // Creates an asset(s) from source file(s) and upload
27            Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.DOCX.getMediaType());
28
29            // Create parameters for the job
30            DocumentMergeParams documentMergeParams = DocumentMergeParams.documentMergeParamsBuilder()
31                    .withJsonDataForMerge(jsonDataForMerge)
32                    .withOutputFormat(OutputFormat.PDF)
33                    .build();
34
35            // Creates a new job instance
36            DocumentMergeJob documentMergeJob = new DocumentMergeJob(asset, documentMergeParams);
37
38            // Submit the job and gets the job result
39            String location = pdfServices.submit(documentMergeJob);
40            PDFServicesResponse<DocumentMergeResult> pdfServicesResponse = pdfServices.getJobResult(location, DocumentMergeResult.class);
41
42            // Get content from the resulting asset(s)
43            Asset resultAsset = pdfServicesResponse.getResult().getAsset();
44            StreamAsset streamAsset = pdfServices.getContent(resultAsset);
45 
46            // Creates an output stream and copy stream asset's content to it
47            OutputStream outputStream = Files.newOutputStream(new File("output/documentMergeOutput.pdf").toPath());
48            IOUtils.copy(streamAsset.getInputStream(), outputStream);
49            outputStream.close();
50          } catch (ServiceApiException | IOException | SDKException | ServiceUsageException ex) {
51              LOGGER.error("Exception encountered while executing operation", ex);
52          }
53      }
54   }
55

// Get the samples from https://www.adobe.com/go/pdftoolsapi_net_samples
// Run the sample:
// cd MergeDocumentToPDF/
// dotnet run MergeDocumentToPDF.csproj

  namespace MergeDocumentToPDF
   {
       class Program
       {
           private static readonly ILog log = LogManager.GetLogger(typeof(Program));
  
           static void Main()
           {
               //Configure the logging.
               ConfigureLogging();
               try
               {
                   // Initial setup, create credentials instance.
                   Credentials credentials = Credentials.ServicePrincipalCredentialsBuilder()
                            .WithClientId("PDF_SERVICES_CLIENT_ID")
                            .WithClientSecret("PDF_SERVICES_CLIENT_SECRET")
                            .Build();
  
                   // Create an ExecutionContext using credentials.
                   ExecutionContext executionContext = ExecutionContext.Create(credentials);
  
                   // Setup input data for the document merge process.
                   JObject jsonDataForMerge = JObject.Parse("{\"customerName\": \"Kane Miller\",\"customerVisits\": 100}");
  
                   // Create a new DocumentMerge Options instance.
                   DocumentMergeOptions documentMergeOptions = new DocumentMergeOptions(jsonDataForMerge, OutputFormat.PDF);
  
                   // Create a new DocumentMerge Operation instance with the DocumentMerge Options instance.
                   DocumentMergeOperation documentMergeOperation = DocumentMergeOperation.CreateNew(documentMergeOptions);
  
                   // Set the operation input document template from a source file.
                   documentMergeOperation.SetInput(FileRef.CreateFromLocalFile(@"documentMergeTemplate.docx"));
  
                   // Execute the operation.
                   FileRef result = documentMergeOperation.Execute(executionContext);
  
                   // Save the result to the specified location.
                   result.SaveAs(Directory.GetCurrentDirectory() + "/output/documentMergeOutput.pdf");
               }
               catch (ServiceUsageException ex)
               {
                   log.Error("Exception encountered while executing operation", ex);
               }
               catch (ServiceApiException ex)
               {
                   log.Error("Exception encountered while executing operation", ex);
               }
               catch (SDKException ex)
               {
                   log.Error("Exception encountered while executing operation", ex);
               }
               catch (IOException ex)
               {
                   log.Error("Exception encountered while executing operation", ex);
               }
               catch (Exception ex)
               {
                   log.Error("Exception encountered while executing operation", ex);
               }
           }
  
           static void ConfigureLogging()
           {
               ILoggerRepository logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
               XmlConfigurator.Configure(logRepository, new FileInfo("log4net.config"));
           }
       }
   }
Copied to your clipboard
1// Get the samples from https://www.adobe.com/go/pdftoolsapi_net_samples
2// Run the sample:
3// cd MergeDocumentToPDF/
4// dotnet run MergeDocumentToPDF.csproj
5
6  namespace MergeDocumentToPDF
7   {
8       class Program
9       {
10           private static readonly ILog log = LogManager.GetLogger(typeof(Program));
11  
12           static void Main()
13           {
14               //Configure the logging.
15               ConfigureLogging();
16               try
17               {
18                   // Initial setup, create credentials instance.
19                   Credentials credentials = Credentials.ServicePrincipalCredentialsBuilder()
20                            .WithClientId("PDF_SERVICES_CLIENT_ID")
21                            .WithClientSecret("PDF_SERVICES_CLIENT_SECRET")
22                            .Build();
23  
24                   // Create an ExecutionContext using credentials.
25                   ExecutionContext executionContext = ExecutionContext.Create(credentials);
26  
27                   // Setup input data for the document merge process.
28                   JObject jsonDataForMerge = JObject.Parse("{\"customerName\": \"Kane Miller\",\"customerVisits\": 100}");
29  
30                   // Create a new DocumentMerge Options instance.
31                   DocumentMergeOptions documentMergeOptions = new DocumentMergeOptions(jsonDataForMerge, OutputFormat.PDF);
32  
33                   // Create a new DocumentMerge Operation instance with the DocumentMerge Options instance.
34                   DocumentMergeOperation documentMergeOperation = DocumentMergeOperation.CreateNew(documentMergeOptions);
35  
36                   // Set the operation input document template from a source file.
37                   documentMergeOperation.SetInput(FileRef.CreateFromLocalFile(@"documentMergeTemplate.docx"));
38  
39                   // Execute the operation.
40                   FileRef result = documentMergeOperation.Execute(executionContext);
41  
42                   // Save the result to the specified location.
43                   result.SaveAs(Directory.GetCurrentDirectory() + "/output/documentMergeOutput.pdf");
44               }
45               catch (ServiceUsageException ex)
46               {
47                   log.Error("Exception encountered while executing operation", ex);
48               }
49               catch (ServiceApiException ex)
50               {
51                   log.Error("Exception encountered while executing operation", ex);
52               }
53               catch (SDKException ex)
54               {
55                   log.Error("Exception encountered while executing operation", ex);
56               }
57               catch (IOException ex)
58               {
59                   log.Error("Exception encountered while executing operation", ex);
60               }
61               catch (Exception ex)
62               {
63                   log.Error("Exception encountered while executing operation", ex);
64               }
65           }
66  
67           static void ConfigureLogging()
68           {
69               ILoggerRepository logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
70               XmlConfigurator.Configure(logRepository, new FileInfo("log4net.config"));
71           }
72       }
73   }

// Get the samples from http://www.adobe.com/go/pdftoolsapi_node_sample
// Run the sample:
// node src/documentmerge/merge-document-to-pdf.js

const {
    ServicePrincipalCredentials,
    PDFServices,
    MimeType,
    DocumentMergeParams,
    OutputFormat,
    DocumentMergeJob,
    DocumentMergeResult,
    SDKError,
    ServiceUsageError,
    ServiceApiError
} = require("@adobe/pdfservices-node-sdk");
const fs = require("fs");

(async () => {
    let readStream;
    try {
        // Initial setup, create credentials instance
        const credentials = new ServicePrincipalCredentials({
            clientId: process.env.PDF_SERVICES_CLIENT_ID,
            clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET
        });

        // Creates a PDF Services instance
        const pdfServices = new PDFServices({credentials});

        // Setup input data for the document merge process
        const jsonDataForMerge = {
            customerName: "Kane Miller",
            customerVisits: 100
        }

        // Creates an asset(s) from source file(s) and upload
        readStream = fs.createReadStream("./documentMergeTemplate.docx");
        const inputAsset = await pdfServices.upload({
            readStream,
            mimeType: MimeType.DOCX
        });
        
        // Create parameters for the job
        const params = new DocumentMergeParams({
            jsonDataForMerge,
            outputFormat: OutputFormat.PDF
        });

        // Creates a new job instance
        const job = new DocumentMergeJob({inputAsset, params});

        // Submit the job and get the job result
        const pollingURL = await pdfServices.submit({job});
        const pdfServicesResponse = await pdfServices.getJobResult({
            pollingURL,
            resultType: DocumentMergeResult
        });

        // Get content from the resulting asset(s)
        const resultAsset = pdfServicesResponse.result.asset;
        const streamAsset = await pdfServices.getContent({asset: resultAsset});

        // Creates a write stream and copy stream asset's content to it
        const outputFilePath = "./documentMergeOutput.pdf";
        console.log(`Saving asset at ${outputFilePath}`);

        const writeStream = fs.createWriteStream(outputFilePath);
        streamAsset.readStream.pipe(writeStream);
    } catch (err) {
        if (err instanceof SDKError || err instanceof ServiceUsageError || err instanceof ServiceApiError) {
            console.log("Exception encountered while executing operation", err);
        } else {
            console.log("Exception encountered while executing operation", err);
        }
    } finally {
        readStream?.destroy();
    }
})();
Copied to your clipboard
1// Get the samples from http://www.adobe.com/go/pdftoolsapi_node_sample
2// Run the sample:
3// node src/documentmerge/merge-document-to-pdf.js
4
5const {
6    ServicePrincipalCredentials,
7    PDFServices,
8    MimeType,
9    DocumentMergeParams,
10    OutputFormat,
11    DocumentMergeJob,
12    DocumentMergeResult,
13    SDKError,
14    ServiceUsageError,
15    ServiceApiError
16} = require("@adobe/pdfservices-node-sdk");
17const fs = require("fs");
18
19(async () => {
20    let readStream;
21    try {
22        // Initial setup, create credentials instance
23        const credentials = new ServicePrincipalCredentials({
24            clientId: process.env.PDF_SERVICES_CLIENT_ID,
25            clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET
26        });
27
28        // Creates a PDF Services instance
29        const pdfServices = new PDFServices({credentials});
30
31        // Setup input data for the document merge process
32        const jsonDataForMerge = {
33            customerName: "Kane Miller",
34            customerVisits: 100
35        }
36
37        // Creates an asset(s) from source file(s) and upload
38        readStream = fs.createReadStream("./documentMergeTemplate.docx");
39        const inputAsset = await pdfServices.upload({
40            readStream,
41            mimeType: MimeType.DOCX
42        });
43        
44        // Create parameters for the job
45        const params = new DocumentMergeParams({
46            jsonDataForMerge,
47            outputFormat: OutputFormat.PDF
48        });
49
50        // Creates a new job instance
51        const job = new DocumentMergeJob({inputAsset, params});
52
53        // Submit the job and get the job result
54        const pollingURL = await pdfServices.submit({job});
55        const pdfServicesResponse = await pdfServices.getJobResult({
56            pollingURL,
57            resultType: DocumentMergeResult
58        });
59
60        // Get content from the resulting asset(s)
61        const resultAsset = pdfServicesResponse.result.asset;
62        const streamAsset = await pdfServices.getContent({asset: resultAsset});
63
64        // Creates a write stream and copy stream asset's content to it
65        const outputFilePath = "./documentMergeOutput.pdf";
66        console.log(`Saving asset at ${outputFilePath}`);
67
68        const writeStream = fs.createWriteStream(outputFilePath);
69        streamAsset.readStream.pipe(writeStream);
70    } catch (err) {
71        if (err instanceof SDKError || err instanceof ServiceUsageError || err instanceof ServiceApiError) {
72            console.log("Exception encountered while executing operation", err);
73        } else {
74            console.log("Exception encountered while executing operation", err);
75        }
76    } finally {
77        readStream?.destroy();
78    }
79})();

// Please refer our REST API docs for more information 
// https://developer.adobe.com/document-services/docs/apis/#tag/Document-Generation

curl --location --request POST 'https://pdf-services.adobe.io/operation/documentgeneration' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--data-raw '{
    "assetID": "urn:aaid:AS:UE1:23c30ee0-2e4d-46d6-87f2-087832fca718",
    "outputFormat": "pdf",
    "jsonDataForMerge": {
        "customerName": "Kane Miller",
        "customerVisits": 100,
        "itemsBought": [
            {
                "name": "Sprays",
                "quantity": 50,
                "amount": 100
            },
            {
                "name": "Chemicals",
                "quantity": 100,
                "amount": 200
            }
        ],
        "totalAmount": 300,
        "previousBalance": 50,
        "lastThreeBillings": [
            100,
            200,
            300
        ],
        "photograph": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP88h8AAu0B9XNPCQQAAAAASUVORK5CYII="
    }
}'
Copied to your clipboard
1// Please refer our REST API docs for more information 
2// https://developer.adobe.com/document-services/docs/apis/#tag/Document-Generation
3
4curl --location --request POST 'https://pdf-services.adobe.io/operation/documentgeneration' \
5--header 'x-api-key: {{Placeholder for client_id}}' \
6--header 'Content-Type: application/json' \
7--header 'Authorization: Bearer {{Placeholder for token}}' \
8--data-raw '{
9    "assetID": "urn:aaid:AS:UE1:23c30ee0-2e4d-46d6-87f2-087832fca718",
10    "outputFormat": "pdf",
11    "jsonDataForMerge": {
12        "customerName": "Kane Miller",
13        "customerVisits": 100,
14        "itemsBought": [
15            {
16                "name": "Sprays",
17                "quantity": 50,
18                "amount": 100
19            },
20            {
21                "name": "Chemicals",
22                "quantity": 100,
23                "amount": 200
24            }
25        ],
26        "totalAmount": 300,
27        "previousBalance": 50,
28        "lastThreeBillings": [
29            100,
30            200,
31            300
32        ],
33        "photograph": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP88h8AAu0B9XNPCQQAAAAASUVORK5CYII="
34    }
35}'

// Please refer our REST API docs for more information 
// https://developer.adobe.com/document-services/docs/apis/#tag/Document-Generation

curl --location --request POST 'https://pdf-services.adobe.io/operation/documentgeneration' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--data-raw '{
    "input": {
        "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/49b1d57e-23bf-4b82-a541-ba56d9b97011?X-Amz-Security-Token=FwoGZXIvYXdzEFkaDFswafxir9Mr713TUCLTAfNWbys2go%2Fmzni%2BRJvHz2rKFVfBpo%2B0R%2BowBf0Dc4TIqDAtRp%2FozbJn9qvJRkK75mSCTSWKxqGGEFowKFBQB3L2mCGDINh41F%2F0%2FQR6OswJX%2FJ4IGZPl7PrBUVv1bfNQpadx8MLfYMuJVNjGoU7MIsBMpIpDyHcRjM%2BpetRbLFtSUaD6dDCo%2BborzDaNfE%2BqFFkrwqJIe1YJkJcrABN5zYOiJPHts49YSS32jwe2%2B9awi9hesOeNSDCpoVfHi819qMCh%2FUvrKOao4MK0%2BfuPCzSEPootaLFpAYyLaqOMBNjLcQMegek%2B35KHxza2ow0U9DHrSVsxhpue53SzBU4UcOkDHBDTA7cTQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230620T072137Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47KCSF4JF5%2F20230620%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=bc06223d01162803cc43bd8f21bddceb9377a3fab29e31ecd5c52778b528b66e",
        "storage": "S3"
    },
    "output": {
        "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/304625c6-f467-4c1b-bbd4-2411ad3bef06?X-Amz-Security-Token=FwoGZXIvYXdzEFkaDGn9S98klYSKO2WCGCLTAa0xfP3yS7Pz%2BaCkG8OcFbQOKSiFCSKzUbr4P%2FxMc5s3Mhd2k75p0KlBthAkrKU%2BUmbs9xZgBbDfoPeagO3sNEcbI9L1hkT%2Fgq5yoUOtekldoIHPTCrqCwrqAeV6lsGO5MnxRPFxfFVPvUfeVVL0OfmYdqKwFPe%2FJn3B4iGoJr%2B5%2BZ1JgNLXqjd1cbmCliNmOldNCdcqK2xlaqgmiFdK3wXm9cd97EnLT3UYL30MrnNjgAYu%2BTDSGFhEDO%2FmdUWQQ7RWsEq1LM5deOjWsX27tl6pxSgoj6XFpAYyLRlGz%2FpXXNuAO%2FBUkMMjIJ6NHVNTpJ0tJQcbq88Ti%2Bp5a4iu82ojskR5ehfT0g%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230620T072142Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47L6LJD4VQ%2F20230620%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=63c7394449c51588a5bd33e2d680647c1b28f88ea5d783d75649edf96477454b",
        "storage": "S3"
    },
    "params": {
        "jsonDataForMerge": {
            "customerName": "Kane Miller",
            "customerVisits": 100,
            "itemsBought": [
                {
                    "name": "Sprays",
                    "quantity": 50,
                    "amount": 100
                },
                {
                    "name": "Chemicals",
                    "quantity": 100,
                    "amount": 200
                }
            ],
            "totalAmount": 300,
            "previousBalance": 50,
            "lastThreeBillings": [
            100,
            200,
            300
            ],
            "photograph": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP88h8AAu0B9XNPCQQAAAAASUVORK5CYII="
        }
    }
}'
Copied to your clipboard
1// Please refer our REST API docs for more information 
2// https://developer.adobe.com/document-services/docs/apis/#tag/Document-Generation
3
4curl --location --request POST 'https://pdf-services.adobe.io/operation/documentgeneration' \
5--header 'x-api-key: {{Placeholder for client_id}}' \
6--header 'Content-Type: application/json' \
7--header 'Authorization: Bearer {{Placeholder for token}}' \
8--data-raw '{
9    "input": {
10        "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/49b1d57e-23bf-4b82-a541-ba56d9b97011?X-Amz-Security-Token=FwoGZXIvYXdzEFkaDFswafxir9Mr713TUCLTAfNWbys2go%2Fmzni%2BRJvHz2rKFVfBpo%2B0R%2BowBf0Dc4TIqDAtRp%2FozbJn9qvJRkK75mSCTSWKxqGGEFowKFBQB3L2mCGDINh41F%2F0%2FQR6OswJX%2FJ4IGZPl7PrBUVv1bfNQpadx8MLfYMuJVNjGoU7MIsBMpIpDyHcRjM%2BpetRbLFtSUaD6dDCo%2BborzDaNfE%2BqFFkrwqJIe1YJkJcrABN5zYOiJPHts49YSS32jwe2%2B9awi9hesOeNSDCpoVfHi819qMCh%2FUvrKOao4MK0%2BfuPCzSEPootaLFpAYyLaqOMBNjLcQMegek%2B35KHxza2ow0U9DHrSVsxhpue53SzBU4UcOkDHBDTA7cTQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230620T072137Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47KCSF4JF5%2F20230620%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=bc06223d01162803cc43bd8f21bddceb9377a3fab29e31ecd5c52778b528b66e",
11        "storage": "S3"
12    },
13    "output": {
14        "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/304625c6-f467-4c1b-bbd4-2411ad3bef06?X-Amz-Security-Token=FwoGZXIvYXdzEFkaDGn9S98klYSKO2WCGCLTAa0xfP3yS7Pz%2BaCkG8OcFbQOKSiFCSKzUbr4P%2FxMc5s3Mhd2k75p0KlBthAkrKU%2BUmbs9xZgBbDfoPeagO3sNEcbI9L1hkT%2Fgq5yoUOtekldoIHPTCrqCwrqAeV6lsGO5MnxRPFxfFVPvUfeVVL0OfmYdqKwFPe%2FJn3B4iGoJr%2B5%2BZ1JgNLXqjd1cbmCliNmOldNCdcqK2xlaqgmiFdK3wXm9cd97EnLT3UYL30MrnNjgAYu%2BTDSGFhEDO%2FmdUWQQ7RWsEq1LM5deOjWsX27tl6pxSgoj6XFpAYyLRlGz%2FpXXNuAO%2FBUkMMjIJ6NHVNTpJ0tJQcbq88Ti%2Bp5a4iu82ojskR5ehfT0g%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230620T072142Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47L6LJD4VQ%2F20230620%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=63c7394449c51588a5bd33e2d680647c1b28f88ea5d783d75649edf96477454b",
15        "storage": "S3"
16    },
17    "params": {
18        "jsonDataForMerge": {
19            "customerName": "Kane Miller",
20            "customerVisits": 100,
21            "itemsBought": [
22                {
23                    "name": "Sprays",
24                    "quantity": 50,
25                    "amount": 100
26                },
27                {
28                    "name": "Chemicals",
29                    "quantity": 100,
30                    "amount": 200
31                }
32            ],
33            "totalAmount": 300,
34            "previousBalance": 50,
35            "lastThreeBillings": [
36            100,
37            200,
38            300
39            ],
40            "photograph": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP88h8AAu0B9XNPCQQAAAAASUVORK5CYII="
41        }
42    }
43}'

As a result of the Document Generation API, template tags are replaced with the input JSON data.

Document template with template tags being replaced by actual values

Generate PDF or Word document (with Fragments)

The sample below shows the use of Fragments in the word template and generates the output document in the DOCX format.