Linearize PDFs

Optimize PDFs for quick viewing on the web, especially for mobile clients. Linearization allows your end users to view large PDF documents incrementally so that they can view pages much faster in lower bandwidth conditions.

REST API

See our public API Reference for Linearize PDF

Linearize PDF

Linearizing a PDF creates a web-optimized PDF file which supports incremental access in network environments.

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

Java

.NET

Node JS

REST API

// 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.linearizepdf.LinearizePDF
 
     public class LinearizePDF {
       // Initialize the logger.
       private static final Logger LOGGER = LoggerFactory.getLogger(LinearizePDF.class);
    
       public static void main(String[] args) {
    
           try (InputStream inputStream = Files.newInputStream(new File("src/main/resources/linearizePDFInput.pdf").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);
    
                // Creates an asset(s) from source file(s) and upload
                Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.PDF.getMediaType());
    
                // Creates a new job instance
                LinearizePDFJob linearizePDFJob = new LinearizePDFJob(asset);
    
                // Submit the job and gets the job result
                String location = pdfServices.submit(linearizePDFJob);
                PDFServicesResponse<LinearizePDFResult> pdfServicesResponse = pdfServices.getJobResult(location, LinearizePDFResult.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
                Files.createDirectories(Paths.get("output/"));
                OutputStream outputStream = Files.newOutputStream(new File("output/linearizePDFOutput.pdf").toPath());
                LOGGER.info("Saving asset at output/linearizePDFOutput.pdf");
                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.linearizepdf.LinearizePDF
4 
5     public class LinearizePDF {
6       // Initialize the logger.
7       private static final Logger LOGGER = LoggerFactory.getLogger(LinearizePDF.class);
8    
9       public static void main(String[] args) {
10    
11           try (InputStream inputStream = Files.newInputStream(new File("src/main/resources/linearizePDFInput.pdf").toPath())) {
12                // Initial setup, create credentials instance
13                Credentials credentials = new ServicePrincipalCredentials(
14                        System.getenv("PDF_SERVICES_CLIENT_ID"),
15                        System.getenv("PDF_SERVICES_CLIENT_SECRET"));
16    
17                // Creates a PDF Services instance
18                PDFServices pdfServices = new PDFServices(credentials);
19    
20                // Creates an asset(s) from source file(s) and upload
21                Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.PDF.getMediaType());
22    
23                // Creates a new job instance
24                LinearizePDFJob linearizePDFJob = new LinearizePDFJob(asset);
25    
26                // Submit the job and gets the job result
27                String location = pdfServices.submit(linearizePDFJob);
28                PDFServicesResponse<LinearizePDFResult> pdfServicesResponse = pdfServices.getJobResult(location, LinearizePDFResult.class);
29    
30                // Get content from the resulting asset(s)
31                Asset resultAsset = pdfServicesResponse.getResult().getAsset();
32                StreamAsset streamAsset = pdfServices.getContent(resultAsset);
33    
34                // Creates an output stream and copy stream asset's content to it
35                Files.createDirectories(Paths.get("output/"));
36                OutputStream outputStream = Files.newOutputStream(new File("output/linearizePDFOutput.pdf").toPath());
37                LOGGER.info("Saving asset at output/linearizePDFOutput.pdf");
38                IOUtils.copy(streamAsset.getInputStream(), outputStream);
39                outputStream.close();
40           } catch (ServiceApiException | IOException | SDKException | ServiceUsageException ex) {
41               LOGGER.error("Exception encountered while executing operation", ex);
42           }
43       }
44     }

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

 namespace LinearizePDF
 {
   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 and create a new operation instance.
               ExecutionContext executionContext = ExecutionContext.Create(credentials);
               LinearizePDFOperation linearizePDFOperation = LinearizePDFOperation.CreateNew();

               // Set operation input from a source file.
               FileRef sourceFileRef = FileRef.CreateFromLocalFile(@"linearizePDFInput.pdf");
               linearizePDFOperation.SetInput(sourceFileRef);

               // Execute the operation.
               FileRef result = linearizePDFOperation.Execute(executionContext);

               // Save the result to the specified location.
               result.SaveAs(Directory.GetCurrentDirectory() + "/output/linearizePDFOutput.pdf");
           }
           catch (ServiceUsageException ex)
           {
               log.Error("Exception encountered while executing operation", ex);
           }
           // Catch more errors here . . .
       }

       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 LinearizePDF/
4// dotnet run LinearizePDF.csproj
5
6 namespace LinearizePDF
7 {
8   class Program
9   {
10       private static readonly ILog log = LogManager.GetLogger(typeof(Program));
11       static void Main()
12       {
13           //Configure the logging
14           ConfigureLogging();
15           try
16           {
17               // Initial setup, create credentials instance.
18               Credentials credentials = Credentials.ServicePrincipalCredentialsBuilder()
19                    .WithClientId("PDF_SERVICES_CLIENT_ID")
20                    .WithClientSecret("PDF_SERVICES_CLIENT_SECRET")
21                    .Build();
22
23               // Create an ExecutionContext using credentials and create a new operation instance.
24               ExecutionContext executionContext = ExecutionContext.Create(credentials);
25               LinearizePDFOperation linearizePDFOperation = LinearizePDFOperation.CreateNew();
26
27               // Set operation input from a source file.
28               FileRef sourceFileRef = FileRef.CreateFromLocalFile(@"linearizePDFInput.pdf");
29               linearizePDFOperation.SetInput(sourceFileRef);
30
31               // Execute the operation.
32               FileRef result = linearizePDFOperation.Execute(executionContext);
33
34               // Save the result to the specified location.
35               result.SaveAs(Directory.GetCurrentDirectory() + "/output/linearizePDFOutput.pdf");
36           }
37           catch (ServiceUsageException ex)
38           {
39               log.Error("Exception encountered while executing operation", ex);
40           }
41           // Catch more errors here . . .
42       }
43
44       static void ConfigureLogging()
45       {
46           ILoggerRepository logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
47           XmlConfigurator.Configure(logRepository, new FileInfo("log4net.config"));
48       }
49   }
50 }

// Get the samples from http://www.adobe.com/go/pdftoolsapi_node_sample
// Run the sample:
// node src/linearizepdf/linearize-pdf.js

const {
    ServicePrincipalCredentials,
    PDFServices,
    MimeType,
    LinearizePDFJob,
    LinearizePDFResult,
    SDKError,
    ServiceUsageError,
    ServiceApiError
} = require("@dcloud/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});

        // Creates an asset(s) from source file(s) and upload
        readStream = fs.createReadStream("./linearizePDFInput.pdf");
        const inputAsset = await pdfServices.upload({
            readStream,
            mimeType: MimeType.PDF
        });

        // Creates a new job instance
        const job = new LinearizePDFJob({inputAsset});

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

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

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

        const outputStream = fs.createWriteStream(outputFilePath);
        streamAsset.readStream.pipe(outputStream);
    } 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/linearizepdf/linearize-pdf.js
4
5const {
6    ServicePrincipalCredentials,
7    PDFServices,
8    MimeType,
9    LinearizePDFJob,
10    LinearizePDFResult,
11    SDKError,
12    ServiceUsageError,
13    ServiceApiError
14} = require("@dcloud/pdfservices-node-sdk");
15const fs = require("fs");
16
17(async () => {
18    let readStream;
19    try {
20        // Initial setup, create credentials instance
21        const credentials = new ServicePrincipalCredentials({
22            clientId: process.env.PDF_SERVICES_CLIENT_ID,
23            clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET
24        });
25
26        // Creates a PDF Services instance
27        const pdfServices = new PDFServices({credentials});
28
29        // Creates an asset(s) from source file(s) and upload
30        readStream = fs.createReadStream("./linearizePDFInput.pdf");
31        const inputAsset = await pdfServices.upload({
32            readStream,
33            mimeType: MimeType.PDF
34        });
35
36        // Creates a new job instance
37        const job = new LinearizePDFJob({inputAsset});
38
39        // Submit the job and get the job result
40        const pollingURL = await pdfServices.submit({job});
41        const pdfServicesResponse = await pdfServices.getJobResult({
42            pollingURL,
43            resultType: LinearizePDFResult
44        });
45
46        // Get content from the resulting asset(s)
47        const resultAsset = pdfServicesResponse.result.asset;
48        const streamAsset = await pdfServices.getContent({asset: resultAsset});
49
50        // Creates an output stream and copy stream asset's content to it
51        const outputFilePath = "./linearizePDFOutput.pdf";
52        console.log(`Saving asset at ${outputFilePath}`);
53
54        const outputStream = fs.createWriteStream(outputFilePath);
55        streamAsset.readStream.pipe(outputStream);
56    } catch (err) {
57        if (err instanceof SDKError || err instanceof ServiceUsageError || err instanceof ServiceApiError) {
58            console.log("Exception encountered while executing operation", err);
59        } else {
60            console.log("Exception encountered while executing operation", err);
61        }
62    } finally {
63        readStream?.destroy();
64    }
65})();

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

curl --location --request POST 'https://pdf-services.adobe.io/operation/linearizepdf' \
--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"
}'
Copied to your clipboard
1// Please refer our REST API docs for more information 
2// https://developer.adobe.com/document-services/docs/apis/#tag/Linearize-PDF
3
4curl --location --request POST 'https://pdf-services.adobe.io/operation/linearizepdf' \
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}'

Compress PDFs

Protect PDF

Last updated 4/9/2024

Was this helpful?

Yes

Linearize PDFs

REST API.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Linearize PDF

REST API