Edit in GitHubLog an issue

PDF Accessibility Auto-Tag API

API Output Format

The output of the PDF Accessibility Auto-Tag API contains the following:

  • The tagged PDF file.
  • A report in XLSX format, if the report generation was enabled. This report provides information related to the tags found in the original document, if any, and the auto-tagged document.

API limitations


  • File size: Files up to a maximum of 100 MB are supported.
  • Number of Pages: Non-scanned PDFs up to 200 pages and scanned PDFs up to 100 pages are supported, however limits may be lower for files with a large number of tables.
  • Rate limits: Keep request rate below 25 requests per minute.
  • Page Size: The API supports standard page sizes not more than 17.5” or less than 6” in either dimension.
  • Hidden Objects: PDF files that contain content that is not visible on the page like JavaScript, OCG (optional content groups), etc are not supported. Files that contain such hidden information may fail to process. For such cases, removing hidden content prior to processing files again may return a successful result.
  • Language: The API is currently optimized for English language content. Files containing content in French, German, Spanish, Danish, Dutch, Norwegian (Bokmal), Galician, Catalan, Finnish, Italian, Swedish, Portuguese, and Romanian should return good results most of the time. Files containing content in Afrikaans, Bosnian, Croatian, Czech, Hungarian, Indonesian, Malay, Polish, Russian, Serbian, Turkish, Hindi, Marathi and other similar languages should return good results often. Non-English files may have issues with non-English punctuation. OCR is configured for English content.
  • OCR and Scan quality: The quality of text extracted from scanned files is dependent on the clarity of content in the input file and is currently configured for English content. Conditions like skewed pages, shadowing, obscured or overlapping fonts, and page resolution less than 200 DPI can all result in lower quality text output.
  • Form fields: Files containing XFA and other fillable form elements are not supported.
  • Unprotected files: The API supports files that are unprotected or where security restrictions allow editing of content. Files that are secured and do not allow editing of content will not be processed. If the password of a protected PDF is known, the permissions of the file can be modified using the PDF Services API as shown here.
  • Annotations: Content in PDF files containing annotations such as highlights and sticky notes will be processed, but annotations that obscure text could impact output quality. Text within annotations will not be included in the output.
  • PDF Producers: The PDF Accessibility Auto-Tag API is designed to add tags to PDF to make it easier to make the file accessible. Files created from applications that produce other types of content like illustrations, CAD drawings or other types of vector art may not return high quality results.
  • PDF Collections: PDFs that are made from a collection of files including PDF Portfolios are not currently supported.

Error codes

ScenarioError codeError message
Unknown error/ failure
ERROR
Unexpected error
Timeout
TIMEOUT
Unexpected error: Processing timeout
Disqualified
DISQUALIFIED
File is not suitable for conversion
Unsupported XFA file
DISQUALIFIED_XFA
File is not suitable for conversion: File contains an XFA form
Page limit violation
DISQUALIFIED_PAGE_LIMIT
File is not suitable for conversion: File exceeds page limit
Scan page limit violation
DISQUALIFIED_SCAN_PAGE_LIMIT
File is not suitable for conversion: Scanned file exceeds page limit
File size violation
DISQUALIFIED_FILE_SIZE
File is not suitable for conversion: File exceeds size limit
Encryption permission
DISQUALIFIED_PERMISSIONS
File is not suitable for conversion: File permissions do not allow conversion
Complex file
DISQUALIFIED_COMPLEX_FILE
File is not suitable for conversion: File content is too complex
Unsupported language
DISQUALIFIED_LANGUAGE
File is not suitable for conversion: File content language is unsupported
Bad PDF
BAD_PDF
The PDF file is damaged or its content is too complex
Bad PDF file type
BAD_PDF_FILE_TYPE
The input file is not a PDF file
Damaged input file
BAD_PDF_DAMAGED
The input file is damaged
Complex table
BAD_PDF_COMPLEX_TABLE
The input file contains a table that is too complex to process
Complex content
BAD_PDF_COMPLEX_INPUT
The input file contains content that is too complex to process
Unsupported font
BAD_PDF_UNSUPPORTED_FONT
The input file contains font data that is corrupted or not supported
Large PDF file
BAD_PDF_LARGE_FILE
The input file size exceeds the maximum allowed
Protected PDF
PROTECTED_PDF
PDF is encrypted or password-protected
Empty or corrupted input
BAD_INPUT
Input is corrupted or empty
Invalid input parameters
BAD_INPUT_PARAMS
Invalid input parameters
User not enrolled to allowed Atlas plans
INVALID_PLAN_CODE
Unauthorized to execute this operation. User is not enrolled to plans allowed for the service

REST API

See our public API Reference for PDF Accessibility Auto-Tag API.

Generate tagged PDF from a PDF

The sample below generates a tagged PDF from a PDF.

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

Copied to your clipboard
// Get the samples from https://github.com/adobe/pdfservices-java-sdk-samples
// Run the sample:
// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.autotagpdf.AutotagPDF
public class AutotagPDF {
// Initialize the logger.
private static final Logger LOGGER = LoggerFactory.getLogger(AutotagPDF.class);
public static void main(String[] args) {
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);
AutotagPDFOperation autotagPDFOperation = AutotagPDFOperation.createNew();
// Set operation input from a source file.
FileRef source = FileRef.createFromLocalFile("autotagPDFInput.pdf");
autotagPDFOperation.setInput(source);
// Execute the operation
AutotagPDFOutput autotagPDFOutput = autotagPDFOperation.execute(executionContext);
// Save the tagged PDF output at the specified location
autotagPDFOutput.getTaggedPDF().saveAs("autotagPDFOutput.pdf");
} catch (ServiceApiException | IOException | SdkException | ServiceUsageException ex) {
LOGGER.error("Exception encountered while executing operation", ex);
}
}

Generate tagged PDF by setting options with command line arguments

The sample below generates a tagged PDF by setting options through command line arguments.

Here is a sample list of command line arguments and their description:

  • --input < input file path >
  • --output < output file path >
  • --report { If this argument is present then the output will be generated with the report }
  • --shift_headings { If this argument is present then the headings will be shifted in the output PDF file }
Copied to your clipboard
// Get the samples from https://github.com/adobe/pdfservices-java-sdk-samples
// Run the sample:
// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.autotagpdf.AutotagPDFParamaterised
public class AutotagPDFParameterised {
private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(AutotagPDFParameterised.class);
public static void main(String[] args) {
LOGGER.info("--input " + getInputFilePathFromCmdArgs(args));
LOGGER.info("--output " + getOutputFilePathFromCmdArgs(args));
LOGGER.info("--report " + getGenerateReportFromCmdArgs(args));
LOGGER.info("--shift_headings " + getShiftHeadingsFromCmdArgs(args));
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);
AutotagPDFOperation autotagPDFOperation = AutotagPDFOperation.createNew();
// Set input for operation from command line args
autotagPDFOperation.setInput(FileRef.createFromLocalFile(getInputFilePathFromCmdArgs(args)));
// Get and Build AutotagPDF options from command line args and set them into the operation
AutotagPDFOptions autotagPDFOptions = getOptionsFromCmdArgs(args);
autotagPDFOperation.setOptions(autotagPDFOptions);
// Execute the operation
AutotagPDFOutput autotagPDFOutput = autotagPDFOperation.execute(executionContext);
// Save the output files at the specified location
String outputPath = getOutputFilePathFromCmdArgs(args);
autotagPDFOutput.getTaggedPDF().saveAs(outputPath + "autotagPDFInput-tagged.pdf");
if (autotagPDFOptions != null && autotagPDFOptions.isGenerateReport())
autotagPDFOutput.getReport().saveAs(outputPath + "autotagPDFInput-report.xlsx");
}
catch (ServiceApiException | IOException | ServiceUsageException e) {
System.out.println(e);
}
}
private static AutotagPDFOptions getOptionsFromCmdArgs(String[] args) {
Boolean generateReport = getGenerateReportFromCmdArgs(args);
Boolean shiftHeadings = getShiftHeadingsFromCmdArgs(args);
AutotagPDFOptions.Builder builder = AutotagPDFOptions.autotagPDFOptionsBuilder();
if (generateReport)
builder.generateReport();
if (shiftHeadings)
builder.shiftHeadings();
return builder.build();
}
private static Boolean getShiftHeadingsFromCmdArgs(String[] args) {
return Arrays.asList(args).contains("--shift_headings");
}
private static Boolean getGenerateReportFromCmdArgs(String[] args) {
return Arrays.asList(args).contains("--report");
}
private static String getInputFilePathFromCmdArgs(String[] args) {
String inputFilePath = "src/main/resources/autotagPDFInput.pdf";
int inputFilePathIndex = Arrays.asList(args).indexOf("--input");
if (inputFilePathIndex >= 0 && inputFilePathIndex < args.length - 1) {
inputFilePath = args[inputFilePathIndex + 1];
} else
LOGGER.info("input file not specified, using default value : autotagPdfInput.pdf");
return inputFilePath;
}
private static String getOutputFilePathFromCmdArgs(String[] args) {
String outputFilePath = "output/AutotagPDFParameterised/";
int outputFilePathIndex = Arrays.asList(args).indexOf("--output");
if (outputFilePathIndex >= 0 && outputFilePathIndex < args.length - 1) {
outputFilePath = args[outputFilePathIndex + 1];
} else
LOGGER.info("output path not specified, using default value : " + outputFilePath);
return outputFilePath;
}
}
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2024 Adobe. All rights reserved.