Get PDF Properties

Use this service to get the metadata properties of a PDF. Metadata including page count, PDF version, file size, compliance levels, font info, permissions and more are provided in JSON format for easy processing.

This data can be used to: check if a document is fully text searchable (OCR), understand the e-signature certificate info, find out compliance levels (e.g., PDF/A and PDF/UA), assess file size before compressing, check permissions related to copy, edit, printing, encryption, and much more.

REST API

See our public API Reference for PDF Properties.

Fetch PDF Properties

The sample below fetches the properties of an input PDF.

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.pdfproperties.GetPDFProperties

  public class GetPDFProperties {

    // Initialize the logger.
    private static final Logger LOGGER = LoggerFactory.getLogger(GetPDFProperties.class);

    public static void main(String[] args) {

      try (InputStream inputStream = Files.newInputStream(new File("src/main/resources/pdfPropertiesInput.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());

        // Create parameters for the job
        PDFPropertiesParams pdfPropertiesParams = PDFPropertiesParams.pdfPropertiesParamsBuilder()
                .includePageLevelProperties()
                .build();

        // Creates a new job instance
        PDFPropertiesJob pdfPropertiesJob = new PDFPropertiesJob(asset)
                .setParams(pdfPropertiesParams);

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

        PDFProperties pdfProperties = pdfServicesResponse.getResult().getPdfProperties();
        
        // Fetch the requisite properties of the specified PDF.
        LOGGER.info("Size of the specified PDF file: {}", pdfProperties.getDocument().getFileSize());
        LOGGER.info("Version of the specified PDF file: {}", pdfProperties.getDocument().getPDFVersion());
        LOGGER.info("Page count of the specified PDF file: {}", pdfProperties.getDocument().getPageCount());
      } 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.pdfproperties.GetPDFProperties
4
5  public class GetPDFProperties {
6
7    // Initialize the logger.
8    private static final Logger LOGGER = LoggerFactory.getLogger(GetPDFProperties.class);
9
10    public static void main(String[] args) {
11
12      try (InputStream inputStream = Files.newInputStream(new File("src/main/resources/pdfPropertiesInput.pdf").toPath())) {
13        // Initial setup, create credentials instance
14        Credentials credentials = new ServicePrincipalCredentials(
15                System.getenv("PDF_SERVICES_CLIENT_ID"),
16                System.getenv("PDF_SERVICES_CLIENT_SECRET"));
17
18        // Creates a PDF Services instance
19        PDFServices pdfServices = new PDFServices(credentials);
20
21        // Creates an asset(s) from source file(s) and upload
22        Asset asset = pdfServices.upload(inputStream, PDFServicesMediaType.PDF.getMediaType());
23
24        // Create parameters for the job
25        PDFPropertiesParams pdfPropertiesParams = PDFPropertiesParams.pdfPropertiesParamsBuilder()
26                .includePageLevelProperties()
27                .build();
28
29        // Creates a new job instance
30        PDFPropertiesJob pdfPropertiesJob = new PDFPropertiesJob(asset)
31                .setParams(pdfPropertiesParams);
32
33        // Submit the job and gets the job result
34        String location = pdfServices.submit(pdfPropertiesJob);
35        PDFServicesResponse<PDFPropertiesResult> pdfServicesResponse = pdfServices.getJobResult(location, PDFPropertiesResult.class);
36
37        PDFProperties pdfProperties = pdfServicesResponse.getResult().getPdfProperties();
38        
39        // Fetch the requisite properties of the specified PDF.
40        LOGGER.info("Size of the specified PDF file: {}", pdfProperties.getDocument().getFileSize());
41        LOGGER.info("Version of the specified PDF file: {}", pdfProperties.getDocument().getPDFVersion());
42        LOGGER.info("Page count of the specified PDF file: {}", pdfProperties.getDocument().getPageCount());
43      } catch (ServiceApiException | IOException | SDKException | ServiceUsageException ex) {
44        LOGGER.error("Exception encountered while executing operation", ex);
45      }
46    }
47  }

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

namespace GetPDFProperties
{
    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);
            PDFPropertiesOperation pdfPropertiesOperation = PDFPropertiesOperation.CreateNew();

            // Provide an input FileRef for the operation
            FileRef source = FileRef.CreateFromLocalFile(@"pdfPropertiesInput.pdf");
            pdfPropertiesOperation.SetInput(source);

            // Build PDF Properties options to include page level properties and set them into the operation
            PDFPropertiesOptions pdfPropertiesOptions = PDFPropertiesOptions.PDFPropertiesOptionsBuilder()
            .IncludePageLevelProperties(true)
            .Build();
            pdfPropertiesOperation.SetOptions(pdfPropertiesOptions);

            // Execute the operation ang get properties of the PDF in PDFProperties object.
            PDFProperties pdfProperties = pdfPropertiesOperation.Execute(executionContext);
            Console.WriteLine("The resultant PDF Properties are: " + result.ToString());

        }
        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 PDFPropertiesAsJSONObject/
4// dotnet run GetPDFProperties.csproj
5
6namespace GetPDFProperties
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            PDFPropertiesOperation pdfPropertiesOperation = PDFPropertiesOperation.CreateNew();
26
27            // Provide an input FileRef for the operation
28            FileRef source = FileRef.CreateFromLocalFile(@"pdfPropertiesInput.pdf");
29            pdfPropertiesOperation.SetInput(source);
30
31            // Build PDF Properties options to include page level properties and set them into the operation
32            PDFPropertiesOptions pdfPropertiesOptions = PDFPropertiesOptions.PDFPropertiesOptionsBuilder()
33            .IncludePageLevelProperties(true)
34            .Build();
35            pdfPropertiesOperation.SetOptions(pdfPropertiesOptions);
36
37            // Execute the operation ang get properties of the PDF in PDFProperties object.
38            PDFProperties pdfProperties = pdfPropertiesOperation.Execute(executionContext);
39            Console.WriteLine("The resultant PDF Properties are: " + result.ToString());
40
41        }
42        catch (ServiceUsageException ex)
43        {
44            log.Error("Exception encountered while executing operation", ex);
45        }
46        // Catch more errors here. . .
47    }
48
49        static void ConfigureLogging()
50    {
51        ILoggerRepository logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
52        XmlConfigurator.Configure(logRepository, new FileInfo("log4net.config"));
53    }
54    }
55}

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

const {
    ServicePrincipalCredentials,
    PDFServices,
    MimeType,
    PDFPropertiesParams,
    PDFPropertiesJob,
    PDFPropertiesResult,
    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});

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

        // Create parameters for the job
        const params = new PDFPropertiesParams({
            includePageLevelProperties: true
        });

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

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

        const pdfProperties = pdfServicesResponse.result.pdfProperties;

        // Fetch the requisite properties of the specified PDF.
        console.log(`Size of the specified PDF file: ${pdfProperties.document.fileSize}`);
        console.log(`Version of the specified PDF file: ${pdfProperties.document.pdfVersion}`);
        console.log(`Page count of the specified PDF file: ${pdfProperties.document.pageCount}`);
    } 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/pdfproperties/get-pdf-properties.js
4
5const {
6    ServicePrincipalCredentials,
7    PDFServices,
8    MimeType,
9    PDFPropertiesParams,
10    PDFPropertiesJob,
11    PDFPropertiesResult,
12    SDKError,
13    ServiceUsageError,
14    ServiceApiError
15} = require("@adobe/pdfservices-node-sdk");
16const fs = require("fs");
17
18(async () => {
19    let readStream;
20    try {
21        // Initial setup, create credentials instance
22        const credentials = new ServicePrincipalCredentials({
23            clientId: process.env.PDF_SERVICES_CLIENT_ID,
24            clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET
25        });
26
27        // Creates a PDF Services instance
28        const pdfServices = new PDFServices({credentials});
29
30        // Creates an asset(s) from source file(s) and upload
31        readStream = fs.createReadStream("./pdfPropertiesInput.pdf");
32        const inputAsset = await pdfServices.upload({
33            readStream,
34            mimeType: MimeType.PDF
35        });
36
37        // Create parameters for the job
38        const params = new PDFPropertiesParams({
39            includePageLevelProperties: true
40        });
41
42        // Creates a new job instance
43        const job = new PDFPropertiesJob({inputAsset, params});
44
45        // Submit the job and get the job result
46        const pollingURL = await pdfServices.submit({job});
47        const pdfServicesResponse = await pdfServices.getJobResult({
48            pollingURL,
49            resultType: PDFPropertiesResult
50        });
51
52        const pdfProperties = pdfServicesResponse.result.pdfProperties;
53
54        // Fetch the requisite properties of the specified PDF.
55        console.log(`Size of the specified PDF file: ${pdfProperties.document.fileSize}`);
56        console.log(`Version of the specified PDF file: ${pdfProperties.document.pdfVersion}`);
57        console.log(`Page count of the specified PDF file: ${pdfProperties.document.pageCount}`);
58    } catch (err) {
59        if (err instanceof SDKError || err instanceof ServiceUsageError || err instanceof ServiceApiError) {
60            console.log("Exception encountered while executing operation", err);
61        } else {
62            console.log("Exception encountered while executing operation", err);
63        }
64    } finally {
65        readStream?.destroy();
66    }
67})();

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

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

Extract PDF

PDF Accessibility Auto-Tag

Last updated 4/9/2024

Was this helpful?

Yes

Get PDF Properties

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

Fetch PDF Properties.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

REST API

Fetch PDF Properties