redocly logoAPI docs by Redocly

PDF Services API

Generate Token

Creates an access token using client id and client secret. Click here to refer underlying IMS authentication APIs.

Generate access token to perform PDF Services operations

Creates an access token using client id and client Secret.

Request Body schema: application/x-www-form-urlencoded

Params for generating the access token.

client_id
required
string

Contains the client id obtained upon client registration.

client_secret
required
string

Contains the client secret obtained upon client registration.

Responses

Response samples

Content type
application/json
{
  • "access_token": "*******",
  • "token_type": "Bearer",
  • "expires_in": "86399"
}

Assets

Upload and download assets to Adobe internal storage.
Uploading and downloading of assets is not required when using a custom external storage solution with signed URLs.

Note: Assets uploaded to Adobe internal storage are transiently stored for 24 hours.

Get upload pre-signed URI.

Get the pre-signed URI to directly upload the content to the adobe's internal cloud provider.

Output: Response will have the asset URI of created asset and pre-signed URI for uploading the content.

Note: The pre-signed URI provided for uploading or downloading the content has an expiry of 1 hour.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for getting upload presigned url Operation

mediaType
string

The content type of the file to be stored. For e.g: application/pdf.

Responses

Request samples

Content type
application/json
{
  • "mediaType": "application/pdf"
}

Response samples

Content type
application/json
{}

Get download pre-signed URI.

Get the pre-signed URI to fetch the content directly from the cloud provider.

Note: The pre-signed URI provided for uploading or downloading the content has an expiry of 1 hour.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
{}

Delete the asset from storage.

Delete the stored asset from the cloud provider.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get asset metadata.

Get the metadata of the stored temporary asset.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
{
  • "entity": "49505D56624424F00A49423A@techacct.adobe.com",
  • "size": 13552,
  • "type": "application/pdf"
}

Combine PDF

Combine multiple PDF Files into a single PDF File

Combine multiple PDF Files into a single PDF File

Combines multiple PDF files(upto 20 files) into a single PDF file. Allows specifying which pages of the source files to combine. By default all the pages of source files are considered if explicit PageRanges are not specified.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Combine PDF Operation. Refer to the External Section below for using external storage with Combine PDF operation.

One of
required
Array of objects

The array of assets with the required PageRanges to include in the output PDF document.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assets": [
    ],
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the combine pdf job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Compress PDF

Compress a PDF File

Compress a PDF File

Compress PDFs to reduce the file size prior to performing workflow operations that use bandwidth or memory.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Compress PDF Operation. Refer to the External Section below for using external storage with Compress PDF operation.

One of
assetID
required
string

A file assetID. For more details click here .

compressionLevel
string
Enum: "LOW" "MEDIUM" "HIGH"

Specify the level of compression to reduce the file size of the pdf. Supported levels of compression which reduces the file size of pdf:

  1. Low : Reduces resolution of the coloured and grayscale images above 250 dpi to 200 dpi. This option uses JP2K high quality compression.

  2. Medium : Reduces resolution of the coloured and grayscale images above 200 dpi to 144 dpi. This option uses JP2K medium quality compression.

  3. High : Reduces resolution of the coloured and grayscale images above 100 dpi to 72 dpi. This option uses JPEG medium quality compression. Output pdf will not contain hidden layers, document structure, metadata, javascript, user properties and print settings.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "compressionLevel": "LOW",
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the compress PDF job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Create PDF

Create PDF document from Microsoft Office documents (Word, Excel and PowerPoint) and Image file formats.

Create PDF document from non PDF document.

Create PDF document from Microsoft Office documents (Word, Excel and PowerPoint) and Image file formats.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Create PDF Operation. Refer to the External Section below for using external storage with Create PDF Operation.

One of
assetID
required
string

A file assetID. Supported file formats are bmp, doc, docx, gif, jpeg, jpg, png, ppt, pptx, rtf, tif, tiff, txt, xls and xlsx. For more details click here .

documentLanguage
string (documentLanguage)
Default: "en-US"
Enum: "ca-ES" "cs-CZ" "da-DK" "de-DE" "en-AE" "en-GB" "en-IL" "en-US" "es-ES" "es-MX" "eu-ES" "fi-FI" "fr-CA" "fr-FR" "fr-MA" "hr-HR" "ht-HU" "it-IT" "ja-JP" "ko-KR" "nb-NO" "nl-NL" "pl-PL" "pt-BR" "pt-PT" "ro-RO" "ru-RU" "sk-SK" "sl-SI" "sv-SE" "tr-TR" "uk-UA" "zh-CN" "zh-TW" "lt-LT" "el-GR" "zh-HK" "hu-HU" "et-EE" "lv-LV" "bg-BG" "mt-MT" "sr-SR" "ca-CA" "mk-MK" "de-CH" "no-NO" "iw-IL"

Specifies the default language for the input non-PDF document. In absence of font info within file’s content, an appropriate font is chosen on its basis.

Note : ja-JP Locale is currently not supported in EU region.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "documentLanguage": "en-US",
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the create PDF job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Document Generation

Merge Word based templates with input JSON data to create Word and PDF documents

Merge Word based templates with input JSON data to create Word and PDF documents

Merges the input JSON data with Word based templates to create dynamic documents. To learn more about document generation and document templates, please see the documentation.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Document Generation Operation. Refer to the External Section below for using external storage with Document Generation API

One of
assetID
required
string

A file assetID. For more details click here .

outputFormat
string
Default: "pdf"
Enum: "docx" "pdf"

Specifies the target format of the generated output document. Possible values are pdf and docx.

jsonDataForMerge
required
object

Specifies the JSON data to merge into the document template.

fragments
object

Specifies the Fragments JSON object or a JSON array to resolve fragments in the document template. To know more about fragments use-case in document generation and document templates, please see the documentation.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "outputFormat": "pdf",
  • "jsonDataForMerge": {
    },
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the document generation job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Export PDF

Convert a PDF File to a non-PDF File

Export a PDF file into a number of supported formats.

Export a PDF file into a number of supported formats. The supported formats are doc, docx, pptx, xlsx, rtf.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Parameter to specify output document target format. Refer to the External Section below for using external storage with Export PDF Operation.

One of
assetID
required
string

A file assetID. For more details click here .

targetFormat
required
string
Enum: "doc" "docx" "pptx" "xlsx" "rtf"

Target exported File Format

ocrLang
string (ocrLang)
Enum: "en-GB" "en-US" "nl-NL" "fr-FR" "de-DE" "it-IT" "es-ES" "sv-SE" "da-DK" "fi-FI" "nb-NO" "pt-BR" "pt-PT" "ca-CA" "nn-NO" "de-CH" "ja-JP" "bg-BG" "hr-HR" "cs-CZ" "et-EE" "el-GR" "hu-HU" "lv-LV" "lt-LT" "pl-PL" "ro-RO" "ru-RU" "zh-CN" "sl-SI" "zh-Hant" "tr-TR" "ko-KR" "sk-SK" "eu-ES" "gl-ES" "mk-MK" "mt-MT" "sr-SR" "uk-UA" "iw-IL"

Language to be used for ocr operation

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "targetFormat": "docx",
  • "ocrLang": "en-US",
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the export PDF job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Export PDF Form Data

The Export PDF Form Data API will retrieve the data from a PDF form and return it as a JSON file.

Export PDF Form Data Operation

The Export PDF Form Data API will retrieve the data from a PDF form and return it as a JSON file where field names of form will be the keys and value will be the data of the form.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Input Params for Export PDF Form Data Operation.

One of
assetID
required
string

A file assetID. For more details click here .

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the Export PDF Form Data job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Extract PDF

Extract content from PDF documents and output it in a structured JSON format, along with tables and figures

Extract content from PDF documents and output it in a structured JSON format, along with tables and figures

Extract PDF Content, Tables content and Tables/Figures renditions from a PDF document. Various available options are: (mutually exclusive)

  1. Extract text with structure (headings, paragraphs, lists and footnotes)

  2. Extract tables data as CSV or XLSX

  3. Extract tables as images.

  4. Extract bounding boxes for characters present in text blocks(paragraphs, list, headings)

  5. Extract figures or images as PNG

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Extract PDF Operation. Refer to the External Section below for using external storage with Extract PDF Operation.

One of
assetID
required
string

A file assetID. For more details click here .

getCharBounds
boolean
Default: false

Extract bounding boxes for characters present in text blocks(paragraphs, list, headings)

includeStyling
boolean
Default: false

Boolean specifying whether to add styling information to json output

elementsToExtract
Array of strings
Default: ["text"]
Items Enum: "text" "tables"

List of elements that should be extracted as json. Possible values are text and tables.

tableOutputFormat
string
Default: "xlsx"

Specifies the format of table contents output. Possible values are csv and xlsx.

renditionsToExtract
Array of strings
Items Enum: "tables" "figures"

List of elements whose renditions should be generated. Possible values are figures and tables.

includeHeaderFooter
boolean
Default: false

If true, extract header and footer information as part of json.

tagEncapsulatedText
Array of strings
Default: ["Figure"]
Items Value: "Figure"

List of elements from which to extract encapsulated text content.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "getCharBounds": false,
  • "includeStyling": false,
  • "elementsToExtract": [
    ],
  • "tableOutputFormat": "xlsx",
  • "renditionsToExtract": [
    ],
  • "includeHeaderFooter": false,
  • "tagEncapsulatedText": [
    ],
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the extract pdf job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Html to PDF

Convert HTML Resources to a PDF File

Convert HTML Resources to a PDF File

Creates PDFs from static/dynamic HTML or HTML(with inline CSS) or just a URL. It's a common scenario for enterprise to provide end users with a HTML template with form fields. In case of dynamic HTML this API allows you to capture the users unique data entries and then save it as PDF. Collected data is stored in a JSON file, and the source HTML file must include <script src='./json.js' type='text/javascript'></script>. You can also provide the URL of the HTML page in inputUrl parameter. However, creating PDF from URL is not supported in External Storage flow.
We do not provide support under the following conditions:
1. The URL Scheme is not HTTPS.
2. The hostname resolves to a non-routable IP address. This encompasses scenarios where redirects lead to non-routable IP addresses as well.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for converting HTML to PDF Operation. Refer to the External Section below for using external storage with HTML to PDF Operation.

One of
assetID
string

A file assetID. For more details click here .

inputUrl
string

Parameter to provide the URL as input. Provide one of the value between assetID and inputUrl

json
string
Default: null

JavaScript variables to be placed in global scope to reference while rendering the HTML. This mechanism is intended to be used to supply data that might otherwise be retrieved using ajax requests. The actual mechanics of accessing this content varies depending if rendering from a zip file or from a url. When rendering from a zip file, the source collateral must include a script element such as: <script src='./json.js' type='text/javascript'></script> When rendering from a URL, the content of this json object is injected into the browser VM before the page is rendered.

includeHeaderFooter
boolean
Default: false

Determine whether to add default headers and footers to the output pages. The default header includes a short date and the contents of document title. The default footer includes a file name and a page n/m reference.

object

Parameters for specifying the layout of the output page.

waitTimeToLoad
number
Default: 100

Specifies the maximum time (in milliseconds) to wait before finalizing the PDF. After this duration, the HTML is captured and converted into a PDF, regardless of whether all elements have finished loading or rendering. If a customer provides a custom value, it overrides the default.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "json": "{}",
  • "includeHeaderFooter": true,
  • "pageLayout": {
    },
  • "waitTimeToLoad": 100,
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the Html to PDF job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Import PDF Form Data

The Import PDF Form Data API will take the form data provided as a JSON, insert it into the PDF form, and generate the resulting PDF.

Import PDF Form Data Operation

The Import PDF Form Data API will take the form data provided as a JSON, insert it into the PDF form, and generate the resulting PDF where field names of form will be the keys and value will be the data of the form in the input JSON.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Input Params for Import PDF Form Data Operation.

One of
assetID
required
string

A file assetID. For more details click here .

jsonFormFieldsData
required
object

A JSON object containing the form data for the PDF. Each key in this object should correspond to a field name in the PDF form (including nested or hierarchical field names), and the associated value should be the data to insert into that field. For example:

{
  "name": {
    "first": "John",
    "last": "Doe"
  },
  "dob": "01/14/2025",
  "address": {
    "city": "Springfield",
    "state": "IL"
  }
}

This JSON corresponds to the following PDF field names:

  • name.first
  • name.last
  • dob
  • address.city
  • address.state

The API will use these key-value pairs to populate the respective fields in the PDF form.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "jsonFormFieldsData": {
    },
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the Import PDF Form Data job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Linearize PDF

Convert a PDF File to a Linearized or Web Optimized PDF File

Convert a PDF File to a Linearized or Web Optimized PDF File

Linearize a PDF Document to create a web-optimized PDF Document which supports incremental access in network environments. Refer to the External Section below for using external storage with Linearize PDF Operation.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Linearize PDF Operation. Refer to the External Section below for using external storage with Linearize PDF Operation.

One of
assetID
required
string

A file assetID. For more details click here .

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the linearize pdf job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

OCR

Perform OCR on a PDF File

Perform OCR on a PDF File

Perform OCR on PDF Document by providing specific language and type.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for OCR PDF Operation. Refer to the External Section below for using external storage with OCR PDF Operation.

One of
assetID
required
string

A file assetID. For more details click here .

ocrLang
string (ocrLang)
Default: "en-US"
Enum: "da-DK" "lt-LT" "sl-SI" "el-GR" "ru-RU" "en-US" "zh-HK" "hu-HU" "et-EE" "pt-BR" "uk-UA" "nb-NO" "pl-PL" "lv-LV" "fi-FI" "ja-JP" "es-ES" "bg-BG" "en-GB" "cs-CZ" "mt-MT" "de-DE" "hr-HR" "sk-SK" "sr-SR" "ca-CA" "mk-MK" "ko-KR" "de-CH" "nl-NL" "zh-CN" "sv-SE" "it-IT" "no-NO" "tr-TR" "fr-FR" "ro-RO" "iw-IL"

Specifies the input language to be used for OCR.

ocrType
string
Default: "searchable_image"
Enum: "searchable_image" "searchable_image_exact"

Specifies OCR Type.

There are two types which produce a different result:

  1. One type ensures that text is searchable and selectable, but modifies the original image during the cleanup process (for example, deskews it) before placing an invisible text layer over it. This type removes unwanted artifacts and may result in a more readable document in some scenarios.

  2. The second (EXACT) type, also overlays a searchable text layer over the original image, but in this case, the original image is unchanged. This type produces maximum fidelity to the original image.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "ocrLang": "en-US",
  • "ocrType": "searchable_image",
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the ocr job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Page Manipulation

Rotate and delete pages of a PDF File

Rotate and delete pages of a PDF File

Selectively rotate or delete pages in a PDF document. For example, you can change portrait view to landscape view or remove certain pages from a PDF document.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Page Manipulation PDF Operation. Refer to the External Section below for using external storage with Page Manipulation Operation.

One of
assetID
required
string

A file assetID. For more details click here .

required
Array of items

A list of page actions to be performed on an input PDF document in a given order.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "pageActions": [
    ],
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the page manipulation job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

PDF Accessibility Auto-Tag

Operation to create the tagged pdf and excel report for accessibility auto-tag use case.

PDF Accessibility Auto-Tag Operation

Operation to create the tagged pdf and excel report for accessibility auto-tag use case. Automatic tagging provides significant quality improvements over untagged PDF files including more accurate results for heading levels, reading order, complex lists, links, references, and tables. Screen reader users also benefit significantly from the improvements to heading levels for navigation.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Input Params for Accessibility Auto-Tag Operation. Refer to the External Section below for using external storage with Accessibility Auto-Tag Operation.

One of
assetID
required
string

A file assetID. For more details click here .

shiftHeadings
boolean
Default: false

Boolean specifying whether to shift headings.

generateReport
boolean
Default: false

Boolean specifying whether to generate excel report.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "shiftHeadings": false,
  • "generateReport": false,
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the accessibility auto-tag job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

PDF Accessibility Checker

Accessibility Checker API will check PDF files to see if they meet the machine-verifiable requirements of PDF/UA and WCAG 2.0.

PDF Accessibility Checker Operation

Accessibility Checker API will check PDF files to see if they meet the machine-verifiable requirements of PDF/UA and WCAG 2.0. It will generate a report that summarizes the findings of the accessibility checks. Additional human remediation may be required to ensure that the reading order of elements is correct and that alternative text tags properly convey the meaning of an image. The report contains links to documentation that assist in manually fixing problems using Adobe Acrobat Pro.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Input Params for Accessibility Checker Operation.

One of
assetID
required
string

A file assetID. For more details click here .

pageStart
number

The parameter allows for the specification of the starting page for the accessibility check. If "pageStart" is not provided, the first page is considered the default startPage. It should be greater than equal to 1.

pageEnd
number

The parameter allows for the specification of the ending page for the accessibility check. If "pageEnd" is not provided, the last page is considered the default pageEnd. It should be greater than equal to 1.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "pageStart": 1,
  • "pageEnd": 5,
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the PDF accessibility checker job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

PDF Electronic Seal

Create electronic seal on PDF documents like invoices, agreements etc using the digital certificate issued to the user by Trust Service Provider.

PDF Electronic Seal Operation

An operation to create an electronic seal on input PDF documents using the digital certificate issued to the user by Trust Service Provider. To know more about PDF Electronic Seal, please see the documentation.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params to specify the options required for applying Electronic Seal. Refer to the External Section below for using external storage with Electronic Seal Operation.

One of
inputDocumentAssetID
required
string

A file assetID of a PDF document to which a seal has to be applied. For more details click here .

sealImageAssetID
string

A file assetID of the logo/watermark/background image to be used as part of the appearance of the seal field. For more details click here . The asset format should be one of the below format

  1. application/pdf
  2. image/jpeg
  3. image/png.
required
object (sealOptions)

Specifies all the sealing parameters.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "inputDocumentAssetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "sealImageAssetID": "urn:aaid:AS:UE1:23c30ee0-2e4d-46d6-87f2-087832fca718",
  • "sealOptions": {
    },
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the electronic seal job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

PDF Properties

Extract basic information about a PDF document.

Extract basic information about a PDF document.

Extract basic information about the document such as page count, pdf version, if the file is encrypted, if the file linearized, if the file contains embedded files etc.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Pdf Properties Operation. Refer to the External Section below for using external storage with PDF Properties Operation.

One of
assetID
required
string

A file assetID. For more details click here .

pageLevel
boolean
Default: false

To get page level properties of the PDF.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "pageLevel": false,
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the PDF properties job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

PDF To Images

Convert a PDF File to image files

Convert a PDF file into supported image formats.

Convert a PDF file into supported image formats. Each image file name ends with _(unpadded_page_index_number). For example, a PDF file with 15 pages will generate 15 image files. The first file name ends with _1 and the last file name ends with _15. With External Storage, supported output type is zipOfPageImages only.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Parameter to specify output document target format. Refer to the External Section below for using external storage with PDF to Images Operation.

One of
assetID
required
string

A file assetID. For more details click here .

targetFormat
required
string
Enum: "jpeg" "png" "tiff"

Target exported image File Format

outputType
required
string
Enum: "listOfPageImages" "zipOfPageImages"

If it is set to zipOfPageImages then the response will be provided as a zip response, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "targetFormat": "jpeg",
  • "outputType": "listOfPageImages",
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the pdf to image job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

PDF Watermark

PDF Watermark API will add a watermark in PDF document.

Add Watermark in PDF Document

PDF Watermark API will add a watermark on specified pages of PDF document using a source watermark PDF. The first page of source watermark PDF will be added as a watermark in input PDF document.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Add Watermark Operation. Refer to the External Section below for using external storage with PDF Watermark API

One of
inputDocumentAssetID
required
string

A file assetID of a PDF document on which watermark has to be applied. For more details click here .

watermarkDocumentAssetID
required
string

A file assetID of a PDF document whose first page will be used as watermark. The output generated will retain the content and watermark of the first page. For more details click here .

Array of objects (pageRanges)

Specifies the page ranges on which watermark has to be applied in the input PDF file.

object (appearance)

Specifies the appearance parameters for watermark.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "inputDocumentAssetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "watermarkDocumentAssetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "pageRanges": [
    ],
  • "appearance": {
    },
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the add watermark job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Protect PDF

Add encryption and/or restrict permissions on a PDF File

Add encryption and/or restrict permissions on a PDF File

Secure a PDF Document with user or/and owner password and set the restrictions on certain features like printing, editing and copying in the PDF document. You can specify the type of content to be encrypted with your specified encryption algorithm.
All Adobe products enforce the restrictions set by the permissions password. However, if third-party products don’t support these settings, document recipients can bypass some or all of your restrictions.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Protect PDF Operation. Refer to the External Section below for using external storage with Protect PDF Operation.

One of
assetID
required
string

A file assetID. For more details click here .

required
userPassword (string) or ownerPassword (string)

Enables the use of passwords to encrypt the input PDF document. At least one of userPassword and ownerPassword must be specified and non-empty. Each password can be up to 128 characters in length.

encryptionAlgorithm
required
string
Enum: "AES_128" "AES_256"

Sets the encryption algorithm. For AES-128 encryption, the password supports LATIN-I characters only. For AES-256 encryption, the password supports Unicode character set.

contentToEncrypt
string
Default: "ALL_CONTENT"
Enum: "ALL_CONTENT" "ALL_CONTENT_EXCEPT_METADATA" "ONLY_EMBEDDED_FILES"

Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.

permissions
Array of strings
Items Enum: "PRINT_LOW_QUALITY" "PRINT_HIGH_QUALITY" "EDIT_CONTENT" "EDIT_FILL_AND_SIGN_FORM_FIELDS" "EDIT_ANNOTATIONS" "EDIT_DOCUMENT_ASSEMBLY" "COPY_CONTENT"

Permissions to allow printing, editing and content copying in the PDF document. By default, none of the specified actions are permitted. PRINT_HIGH_QUALITY permission includes PRINT_LOW_QUALITY permission. EDIT_CONTENT permission includes EDIT_DOCUMENT_ASSEMBLY and EDIT_FILL_AND_SIGN_FORM_FIELDS permissions. Permissions settings will only be used in case the ownerPassword is set.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "passwordProtection": {
    },
  • "encryptionAlgorithm": "AES_256",
  • "contentToEncrypt": "ALL_CONTENT",
  • "permissions": [
    ],
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the protect pdf job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Remove Protection

Remove password protection from a PDF File

Remove password protection from a PDF File

Remove security from a PDF document. If the PDF is protected by owner password then the owner password is required in the field password to remove security otherwise user password is required.

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Remove Protection PDF Operation. Refer to the External Section below for using external storage with Remove Protection Operation.

One of
assetID
required
string

A file assetID. For more details click here .

password
required
string

Password required for removing security/permissions from the PDF document.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "password": "XXXXX",
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the remove protection job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}

Split PDF

Split a PDF File into multiple PDF Files

Split a PDF File into multiple PDF Files

Split a PDF document into multiple smaller documents by simply specifying either the number of files, pages per file, or page ranges. Various available options are: (mutually exclusive)

  1. Use the page count to specify the maximum number of pages in each of the output file(s).

  2. Creating smaller PDFs with a set number of pages, you can split PDFs into multiple smaller documents by specifying page ranges where each page range corresponds to a single output file.

  3. Split PDFs by file count. In this case, the operation creates the specified number of files with each containing an identical number of pages (if possible).

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Request Body schema: application/json

Params for Split PDF Operation. Refer to the External Section below for using external storage with Split PDF Operation.

One of
assetID
required
string

A file assetID. For more details click here .

required
fileCount (number) or pageCount (number) or Array of pageRanges (objects)

Provide option to split the PDF document. Different options for splitting PDF document are mutually exclusive.

Array of objects (notifiers)

Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.

Responses

Request samples

Content type
application/json
Example
{
  • "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
  • "splitoption": {
    },
  • "notifiers": []
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll the split pdf job for completion

path Parameters
jobID
required
string

Job ID of the request

header Parameters
Authorization
required
string

Bearer + Token (Learn more about getting the access token)

x-api-key
required
string

The clientId from the generated credentials

Responses

Response samples

Content type
application/json
Example
{
  • "status": "in progress"
}