PDF Services API

Document Generation :

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

post documentGeneration

Submit a Document Generation Job

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.

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/vnd.openxmlformats-officedocument.wordprocessingml.document required: ["dc:format","cpf:location"] params (object, required) Parameters for specifying the input JSON data and the desired output format. cpf:inline (object, required) outputFormat (string, optional) Specifies the target format of the generated output document. Possible values are pdf and docx. enum: docx, pdf default: pdf jsonDataForMerge (object, required) Specifies the JSON data to merge into the document template. fragments (object, optional) 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. required: ["jsonDataForMerge"] required: ["cpf:inline"] required: ["documentIn","params"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call documentOut (object, required) Contains the information about the file content part name and format of the output expected. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/pdf application/vnd.openxmlformats-officedocument.wordprocessingml.document required: ["dc:format","cpf:location"] required: ["documentOut"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb" }, "cpf:inputs": { "documentIn": { "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "cpf:location": "InputFile0" }, "params": { "cpf:inline": { "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=" } } } }, "cpf:outputs": { "documentOut": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/vnd.openxmlformats-officedocument.wordprocessingml.document


required: ["dc:format","cpf:location"]

params
(object, required)
Parameters for specifying the input JSON data and the desired output format.

cpf:inline
(object, required)

outputFormat
(string, optional)
Specifies the target format of the generated output document. Possible values are pdf and docx.

enum: docx, pdf
default: pdf
jsonDataForMerge
(object, required)
Specifies the JSON data to merge into the document template.


fragments
(object, optional)
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.



required: ["jsonDataForMerge"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{ "cpf:status": { "completed": false, "type": "", "title": "In Progress", "status": 202 }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb" }, "cpf:inputs": { "documentIn": { "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "cpf:location": "InputFile0" }, "params": { "cpf:inline": { "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=" } } } } }

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/vnd.openxmlformats-officedocument.wordprocessingml.document


required: ["dc:format","cpf:location"]

params
(object, required)
Parameters for specifying the input JSON data and the desired output format.

cpf:inline
(object, required)

outputFormat
(string, optional)
Specifies the target format of the generated output document. Possible values are pdf and docx.

enum: docx, pdf
default: pdf
jsonDataForMerge
(object, required)
Specifies the JSON data to merge into the document template.


fragments
(object, optional)
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.



required: ["jsonDataForMerge"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:inputs": {
    "documentIn": {
      "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "cpf:location": "InputFile0"
    },
    "params": {
      "cpf:inline": {
        "outputFormat": "pdf",
        "jsonDataForMerge": {}
      }
    }
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb"
  },
  "cpf:status": {
    "completed": true,
    "type": "",
    "title": "JSON data for merge can not be null or empty; transactionId=DqF2zBJ4MhfZAd8FdWfhrjVyrk3ZFiDZ",
    "status": 400,
    "report": "{\"error_code\":\"EMPTY_JSON_DATA_FOR_MERGE\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/vnd.openxmlformats-officedocument.wordprocessingml.document


required: ["dc:format","cpf:location"]

params
(object, required)
Parameters for specifying the input JSON data and the desired output format.

cpf:inline
(object, required)

outputFormat
(string, optional)
Specifies the target format of the generated output document. Possible values are pdf and docx.

enum: docx, pdf
default: pdf
jsonDataForMerge
(object, required)
Specifies the JSON data to merge into the document template.


fragments
(object, optional)
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.



required: ["jsonDataForMerge"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/vnd.openxmlformats-officedocument.wordprocessingml.document


required: ["dc:format","cpf:location"]

params
(object, required)
Parameters for specifying the input JSON data and the desired output format.

cpf:inline
(object, required)

outputFormat
(string, optional)
Specifies the target format of the generated output document. Possible values are pdf and docx.

enum: docx, pdf
default: pdf
jsonDataForMerge
(object, required)
Specifies the JSON data to merge into the document template.


fragments
(object, optional)
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.



required: ["jsonDataForMerge"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/vnd.openxmlformats-officedocument.wordprocessingml.document


required: ["dc:format","cpf:location"]

params
(object, required)
Parameters for specifying the input JSON data and the desired output format.

cpf:inline
(object, required)

outputFormat
(string, optional)
Specifies the target format of the generated output document. Possible values are pdf and docx.

enum: docx, pdf
default: pdf
jsonDataForMerge
(object, required)
Specifies the JSON data to merge into the document template.


fragments
(object, optional)
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.



required: ["jsonDataForMerge"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests="{
   \"cpf:engine\":{
      \"repo:assetId\":\"urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb\"
   },
   \"cpf:inputs\":{
      \"documentIn\":{
         \"dc:format\":\"application/vnd.openxmlformats-officedocument.wordprocessingml.document\",
         \"cpf:location\":\"InputFile0\"
      },
      \"params\":{
         \"cpf:inline\":{
            \"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=\"
            }
         }
      }
   },
   \"cpf:outputs\":{
      \"documentOut\":{
         \"dc:format\":\"application/pdf\",
         \"cpf:location\":\"multipartLabel\"
      }
   }
}"' \
--form 'InputFile0=@"{{Placeholder for the input document template (absolute path)}}"'

get documentGeneration.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
INVALID_JSON
JSON data provided for document merge process is invalid


400
UNSUPPORTED_OR_CORRUPTED_TEMPLATE
Either unsupported or corrupted file content provided. The only supported format is docx


400
PASSWORD_PROTECTED
The document template is password protected and cannot be processed


400
UNSUPPORTED_IMAGE_FORMAT
Image format provided in the JSON input is not supported


400
INVALID_IMAGE_DATA
Image data provided is not a valid Base64 scheme


400
INVALID_EXPRESSION
Unsupported expression in the document template: e.getMessage()


400
SOURCE_TEMPLATE_EMPTY
The document template is of zero length file


400
EMPTY_JSON_DATA_FOR_MERGE
JSON data for merge can not be null or empty


400
OUTPUT_TOO_LARGE
Generated document is too large


500
REQUEST_TIMEOUT
Operation timed out


500
INTERNAL_SERVER_ERROR
Internal server error



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/vnd.openxmlformats-officedocument.wordprocessingml.document


required: ["dc:format","cpf:location"]

params
(object, required)
Parameters for specifying the input JSON data and the desired output format.

cpf:inline
(object, required)

outputFormat
(string, optional)
Specifies the target format of the generated output document. Possible values are pdf and docx.

enum: docx, pdf
default: pdf
jsonDataForMerge
(object, required)
Specifies the JSON data to merge into the document template.


fragments
(object, optional)
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.



required: ["jsonDataForMerge"]


required: ["cpf:inline"]


required: ["documentIn","params"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

documentOut
(object, required)
Contains the information about the file content part name and format of the output expected.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: 
application/pdf
application/vnd.openxmlformats-officedocument.wordprocessingml.document


required: ["dc:format","cpf:location"]


required: ["documentOut"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{ "cpf:inputs": { "documentIn": { "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "cpf:location": "InputFile0" }, "params": { "cpf:inline": { "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=" } } } }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb" }, "cpf:status": { "completed": true, "type": "", "status": 200 }, "cpf:outputs": { "documentOut": { "cpf:location": "multipartLabel", "dc:format": "application/pdf" } } }

<output_file_content_part>

The file part containing output file content. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOut.cpf:location field.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/vnd.openxmlformats-officedocument.wordprocessingml.document


required: ["dc:format","cpf:location"]

params
(object, required)
Parameters for specifying the input JSON data and the desired output format.

cpf:inline
(object, required)

outputFormat
(string, optional)
Specifies the target format of the generated output document. Possible values are pdf and docx.

enum: docx, pdf
default: pdf
jsonDataForMerge
(object, required)
Specifies the JSON data to merge into the document template.


fragments
(object, optional)
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.



required: ["jsonDataForMerge"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/vnd.openxmlformats-officedocument.wordprocessingml.document


required: ["dc:format","cpf:location"]

params
(object, required)
Parameters for specifying the input JSON data and the desired output format.

cpf:inline
(object, required)

outputFormat
(string, optional)
Specifies the target format of the generated output document. Possible values are pdf and docx.

enum: docx, pdf
default: pdf
jsonDataForMerge
(object, required)
Specifies the JSON data to merge into the document template.


fragments
(object, optional)
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.



required: ["jsonDataForMerge"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/vnd.openxmlformats-officedocument.wordprocessingml.document


required: ["dc:format","cpf:location"]

params
(object, required)
Parameters for specifying the input JSON data and the desired output format.

cpf:inline
(object, required)

outputFormat
(string, optional)
Specifies the target format of the generated output document. Possible values are pdf and docx.

enum: docx, pdf
default: pdf
jsonDataForMerge
(object, required)
Specifies the JSON data to merge into the document template.


fragments
(object, optional)
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.



required: ["jsonDataForMerge"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/vnd.openxmlformats-officedocument.wordprocessingml.document


required: ["dc:format","cpf:location"]

params
(object, required)
Parameters for specifying the input JSON data and the desired output format.

cpf:inline
(object, required)

outputFormat
(string, optional)
Specifies the target format of the generated output document. Possible values are pdf and docx.

enum: docx, pdf
default: pdf
jsonDataForMerge
(object, required)
Specifies the JSON data to merge into the document template.


fragments
(object, optional)
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.



required: ["jsonDataForMerge"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

--Boundary_82063_58341146_1615382912303
Content-Type: application/json
Content-Disposition: form-data; name="contentAnalyzerResponse"
{"cpf:inputs":{"documentIn":{"dc:format":"application/vnd.openxmlformats-officedocument.wordprocessingml.document","cpf:location":"InputFile0"},"params":{"cpf:inline":{"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="}}}},"cpf:engine":{"repo:assetId":"urn:aaid:cpf:Service-52d5db6097ed436ebb96f13a4c7bf8fb"},"cpf:status":{"completed":true,"type":"","status":200},"cpf:outputs":{"documentOut":{"cpf:location":"multipartLabel","dc:format":"application/pdf"}}}
--Boundary_82063_58341146_1615382912303
Content-Type: application/octet-stream
Content-Disposition: form-data; name="multipartLabel"
%PDF-1.6
%����
164 0 obj
<</Linearized 1/L 117012/O 166/E 100832/N 2/T 116651/H [ 502 231]>>
--Boundary_82063_58341146_1615382912303--

Extract :

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

Download Postman collection

Try Out With SDK

post extractPDF

Submit an Extract PDF Job

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

Extract text with structure (headings, paragraphs, lists and footnotes)
Extract tables data as CSV or XLSX
Extract tables as images.
Extract bounding boxes for characters present in text blocks(paragraphs, list, headings)
Extract figures or images as PNG
(Beta) Extract styling information of each element( Bold / Italics / Superscript etc) in addition to above mentioned items. Note: This option is experimental which means that the output may change without notice. It is provided for evaluation and feedback purposes only. Use of this option is not supported under the Document Cloud Services versioning policy

To learn more about Extract API, please see the documentation

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695 required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/pdf required: ["dc:format","cpf:location"] params (object, required) cpf:inline (object, required) getCharBounds (boolean, optional) Extract bounding boxes for characters present in text blocks(paragraphs, list, headings) default: false includeStyling (boolean, optional) Boolean specifying whether to add styling information to jsonoutput default: false elementsToExtract (array, required) List of elements that should be extracted as json. Possible values are text and tables [ string : enum: text, tables ] tableOutputFormat (string, optional) Specifies the format of table contents output. Possible values are csv and xlsx default: xlsx renditionsToExtract (array, optional) List of elements whose renditions should be generated. Possible values are figures and tables. default: [ string : enum: tables, figures ] required: ["elementsToExtract"] required: ["cpf:inline"] required: ["documentIn","params"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call elementsInfo (object, required) Contains the information about the file content part name and format of the extracted PDF Elements Info cpf:location (string, required) The expected <json_output_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/json required: ["dc:format","cpf:location"] elementsRenditions (object, required) List of images/renditions for requested PDF elements like figures/tables and table content in csv or xlsx format cpf:location (string, required) The expected <renditions_or_table_content_part>index that will contain the contents of renditions or table. Since, multiple files are expected so the part name for files will be like <renditions_or_table_content_part>index, here index can be 0,1,2... depending on the no. of files. dc:format (string, required) The expected format of the output: csv, xlsx or png required: ["dc:format","cpf:location"] required: ["elementsInfo","elementsRenditions"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695" }, "cpf:inputs": { "documentIn": { "cpf:location": "fileInput1", "dc:format": "application/pdf" }, "params": { "cpf:inline": { "elementsToExtract": [ "text", "tables" ], "renditionsToExtract": [ "tables", "figures" ] } } }, "cpf:outputs": { "elementsInfo": { "cpf:location": "jsonoutput", "dc:format": "application/json" }, "elementsRenditions": { "cpf:location": "fileoutpart", "dc:format": "text/directory" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)

cpf:inline
(object, required)

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

default: false
includeStyling
(boolean, optional)
Boolean specifying whether to add styling information to jsonoutput

default: false
elementsToExtract
(array, required)
List of elements that should be extracted as json. Possible values are text and tables

[
string
: 
enum: text, tables
]
tableOutputFormat
(string, optional)
Specifies the format of table contents output. Possible values are csv and xlsx

default: xlsx
renditionsToExtract
(array, optional)
List of elements whose renditions should be generated. Possible values are figures and tables.

default: 
[
string
: 
enum: tables, figures
]

required: ["elementsToExtract"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": false,
    "type": "",
    "title": "In Progress",
    "status": 202
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695"
  },
  "cpf:inputs": {
    "documentIn": {
      "cpf:location": "fileInput1",
      "dc:format": "application/pdf"
    },
    "params": {
      "cpf:inline": {
        "elementsToExtract": [
          "text",
          "tables"
        ],
        "renditionsToExtract": [
          "tables",
          "figures"
        ]
      }
    }
  }
}

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)

cpf:inline
(object, required)

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

default: false
includeStyling
(boolean, optional)
Boolean specifying whether to add styling information to jsonoutput

default: false
elementsToExtract
(array, required)
List of elements that should be extracted as json. Possible values are text and tables

[
string
: 
enum: text, tables
]
tableOutputFormat
(string, optional)
Specifies the format of table contents output. Possible values are csv and xlsx

default: xlsx
renditionsToExtract
(array, optional)
List of elements whose renditions should be generated. Possible values are figures and tables.

default: 
[
string
: 
enum: tables, figures
]

required: ["elementsToExtract"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "I/O Validation Error.",
    "title": "Value for I/O object params does not match the required schema {\"type\":\"object\",\"properties\":{\"elementsToExtract\":{\"type\":\"array\",\"items\":{\"enum\":[\"text\",\"tables\"],\"type\":\"string\"},\"dc:description\":\"List specifying elements whose structured information need to be extracted from the PDF document. List must have values from  Text,Table.\"},\"renditionsToExtract\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"figures\",\"tables\"]},\"dc:description\":\"List specifying elements whose renditions are required.\"}},\"required\":[\"elementsToExtract\"]}.",
    "status": 400,
    "report": "{\"error_code\":\"IO_SCHEMA_MISMATCH\"}"
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695"
  },
  "cpf:inputs": {
    "documentIn": {
      "cpf:location": "fileInput1",
      "dc:format": "application/pdf"
    },
    "params": {
      "cpf:inline": {
        "elementsToExtract": [
          "text",
          "tables"
        ],
        "renditionsToExtract": "tables"
      }
    }
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)

cpf:inline
(object, required)

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

default: false
includeStyling
(boolean, optional)
Boolean specifying whether to add styling information to jsonoutput

default: false
elementsToExtract
(array, required)
List of elements that should be extracted as json. Possible values are text and tables

[
string
: 
enum: text, tables
]
tableOutputFormat
(string, optional)
Specifies the format of table contents output. Possible values are csv and xlsx

default: xlsx
renditionsToExtract
(array, optional)
List of elements whose renditions should be generated. Possible values are figures and tables.

default: 
[
string
: 
enum: tables, figures
]

required: ["elementsToExtract"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)

cpf:inline
(object, required)

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

default: false
includeStyling
(boolean, optional)
Boolean specifying whether to add styling information to jsonoutput

default: false
elementsToExtract
(array, required)
List of elements that should be extracted as json. Possible values are text and tables

[
string
: 
enum: text, tables
]
tableOutputFormat
(string, optional)
Specifies the format of table contents output. Possible values are csv and xlsx

default: xlsx
renditionsToExtract
(array, optional)
List of elements whose renditions should be generated. Possible values are figures and tables.

default: 
[
string
: 
enum: tables, figures
]

required: ["elementsToExtract"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)

cpf:inline
(object, required)

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

default: false
includeStyling
(boolean, optional)
Boolean specifying whether to add styling information to jsonoutput

default: false
elementsToExtract
(array, required)
List of elements that should be extracted as json. Possible values are text and tables

[
string
: 
enum: text, tables
]
tableOutputFormat
(string, optional)
Specifies the format of table contents output. Possible values are csv and xlsx

default: xlsx
renditionsToExtract
(array, optional)
List of elements whose renditions should be generated. Possible values are figures and tables.

default: 
[
string
: 
enum: tables, figures
]

required: ["elementsToExtract"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create' \
--header 'Accept: application/json, text/plain, /' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--form 'contentAnalyzerRequests={
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695\"
    },
    \"cpf:inputs\": {
        \"documentIn\": {
            \"cpf:location\": \"fileInput1\",
            \"dc:format\": \"application/pdf\"
        },
        \"params\": {
            \"cpf:inline\": {
                \"elementsToExtract\": [
                    \"text\", \"tables\"
                ],
                \"renditionsToExtract\": [ \"tables\", \"figures\"]
            }
        }
    },
    \"cpf:outputs\": {
        \"elementsInfo\": {
            \"cpf:location\": \"jsonoutput\",
            \"dc:format\": \"application/json\"
        },
        \"elementsRenditions\": {
            \"cpf:location\": \"fileoutpart\",
            \"dc:format\": \"text/directory\"
        }
    }
}' \
--form 'fileInput1=@"{{Placeholder for the input document template (absolute path)}}"'

get extractPDF.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change)




400
DISQUALIFIED
DISQUALIFIED - File not suitable for content extraction


400
DISQUALIFIED_XFA
DISQUALIFIED - File not suitable for content extraction: File contains an XFA form. Not supported for content extraction


400
DISQUALIFIED_PAGE_LIMIT
DISQUALIFIED - File not suitable for content extraction: File exceeds page limit


400
DISQUALIFIED_SCAN_PAGE_LIMIT
DISQUALIFIED - File not suitable for content extraction: Scanned file exceeds page limit


400
DISQUALIFIED_FILE_SIZE
DISQUALIFIED - File not suitable for content extraction: File exceeds size limit


400
DISQUALIFIED_PERMISSIONS
DISQUALIFIED - File not suitable for content extraction: File permissions do not allow content extraction


400
DISQUALIFIED_COMPLEX_FILE
DISQUALIFIED - File not suitable for content extraction: File contents are too complex for content extraction


400
DISQUALIFIED_LANGUAGE
DISQUALIFIED - File not suitable for content extraction: File content language is unsupported


400
BAD_PDF
BAD_PDF - Unable to extract content.


400
BAD_PDF_FILE_TYPE
BAD_PDF - Unable to extract content.: The input file is not a PDF file


400
BAD_PDF_DAMAGED
BAD_PDF - Unable to extract content.: The input file is damaged


400
BAD_PDF_COMPLEX_TABLE
BAD_PDF - Unable to extract content.: The input file contains a table that is too complex to process


400
BAD_PDF_COMPLEX_INPUT
BAD_PDF - Unable to extract content.: The input file contains content that is too complex to process


400
BAD_PDF_UNSUPPORTED_FONT
BAD_PDF - Unable to extract content.: The input file contains font data that is corrupted or not supported


400
BAD_PDF_LARGE_FILE
BAD_PDF - Unable to extract content.: The input file size exceeds the maximum allowed


400
PROTECTED_PDF
PROTECTED_PDF - Unable to extract content. File is encrypted or password-protected


400
BAD_INPUT
Input is corrupted or empty


400
BAD_INPUT_PARAMS
Invalid input parameters


500
ERROR
ERROR - Unable to extract content. Internal error


500
TIMEOUT
ERROR - Unable to extract content. Internal error: Processing timeout



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)

cpf:inline
(object, required)

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

default: false
includeStyling
(boolean, optional)
Boolean specifying whether to add styling information to jsonoutput

default: false
elementsToExtract
(array, required)
List of elements that should be extracted as json. Possible values are text and tables

[
string
: 
enum: text, tables
]
tableOutputFormat
(string, optional)
Specifies the format of table contents output. Possible values are csv and xlsx

default: xlsx
renditionsToExtract
(array, optional)
List of elements whose renditions should be generated. Possible values are figures and tables.

default: 
[
string
: 
enum: tables, figures
]

required: ["elementsToExtract"]


required: ["cpf:inline"]


required: ["documentIn","params"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

elementsInfo
(object, required)
Contains the information about the file content part name and format of the extracted PDF Elements Info

cpf:location
(string, required)
The expected <json_output_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/json


required: ["dc:format","cpf:location"]

elementsRenditions
(object, required)
List of images/renditions for requested PDF elements like figures/tables and table content in csv or xlsx format

cpf:location
(string, required)
The expected <renditions_or_table_content_part>index that will contain the contents of renditions or table. Since, multiple files are expected so the part name for files will be like  <renditions_or_table_content_part>index, here index can be 0,1,2... depending on the no. of files.

dc:format
(string, required)
The expected format of the output: csv, xlsx or png


required: ["dc:format","cpf:location"]


required: ["elementsInfo","elementsRenditions"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:inputs": {
    "documentIn": {
      "cpf:location": "fileInput1",
      "dc:format": "application/pdf"
    },
    "params": {
      "cpf:inline": {
        "elementsToExtract": [
          "text"
        ],
        "renditionsToExtract": [
          "tables",
          "figures"
        ]
      }
    }
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695"
  },
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200
  },
  "cpf:outputs": {
    "elementsRenditions": [
      {
        "cpf:location": "fileoutpart0",
        "dc:format": "image/png"
      },
      {
        "cpf:location": "fileoutpart1",
        "dc:format": "text/csv"
      },
      {
        "cpf:location": "fileoutpart2",
        "dc:format": "image/png"
      }
    ],
    "elementsInfo": {
      "cpf:location": "jsonoutput",
      "dc:format": "application/json"
    }
  }
}

<json_output_part>

Extracted text elements info with styling info and Bounding boxes if requested.

See the JSON schema for a description of the default output. (Please refer the Styling JSON schema for a description of the output when the styling option is enabled.).

<renditions_or_table_content_part>index

The file parts containing table content and renditions of tables/figures if requested. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.elementsRenditions[index].cpf:location field followed by index.

For table content file part, contentAnalyzerRequests.cpf:outputs.elementsRenditions[index].dc:format value will be either text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.

For renditions file part, contentAnalyzerRequests.cpf:outputs.elementsRenditions[index].dc:format value will be image/png.

The element corresponding to this rendition or table content within the <json_output_part> json content has its "filePaths" key value as this <renditions_or_table_content_part>index

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)

cpf:inline
(object, required)

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

default: false
includeStyling
(boolean, optional)
Boolean specifying whether to add styling information to jsonoutput

default: false
elementsToExtract
(array, required)
List of elements that should be extracted as json. Possible values are text and tables

[
string
: 
enum: text, tables
]
tableOutputFormat
(string, optional)
Specifies the format of table contents output. Possible values are csv and xlsx

default: xlsx
renditionsToExtract
(array, optional)
List of elements whose renditions should be generated. Possible values are figures and tables.

default: 
[
string
: 
enum: tables, figures
]

required: ["elementsToExtract"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)

cpf:inline
(object, required)

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

default: false
includeStyling
(boolean, optional)
Boolean specifying whether to add styling information to jsonoutput

default: false
elementsToExtract
(array, required)
List of elements that should be extracted as json. Possible values are text and tables

[
string
: 
enum: text, tables
]
tableOutputFormat
(string, optional)
Specifies the format of table contents output. Possible values are csv and xlsx

default: xlsx
renditionsToExtract
(array, optional)
List of elements whose renditions should be generated. Possible values are figures and tables.

default: 
[
string
: 
enum: tables, figures
]

required: ["elementsToExtract"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)

cpf:inline
(object, required)

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

default: false
includeStyling
(boolean, optional)
Boolean specifying whether to add styling information to jsonoutput

default: false
elementsToExtract
(array, required)
List of elements that should be extracted as json. Possible values are text and tables

[
string
: 
enum: text, tables
]
tableOutputFormat
(string, optional)
Specifies the format of table contents output. Possible values are csv and xlsx

default: xlsx
renditionsToExtract
(array, optional)
List of elements whose renditions should be generated. Possible values are figures and tables.

default: 
[
string
: 
enum: tables, figures
]

required: ["elementsToExtract"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)

cpf:inline
(object, required)

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

default: false
includeStyling
(boolean, optional)
Boolean specifying whether to add styling information to jsonoutput

default: false
elementsToExtract
(array, required)
List of elements that should be extracted as json. Possible values are text and tables

[
string
: 
enum: text, tables
]
tableOutputFormat
(string, optional)
Specifies the format of table contents output. Possible values are csv and xlsx

default: xlsx
renditionsToExtract
(array, optional)
List of elements whose renditions should be generated. Possible values are figures and tables.

default: 
[
string
: 
enum: tables, figures
]

required: ["elementsToExtract"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

--Boundary_7486_1638004035_1618820114945 Content-Type: application/json Content-Disposition: form-data; name="contentAnalyzerResponse"

{"cpf:inputs":{"documentIn":{"cpf:location":"fileInput1","dc:format":"application/pdf"},"params":{"cpf:inline":{"elementsToExtract":["text"],"renditionsToExtract":[]}}},"cpf:engine":{"repo:assetId":"urn:aaid:cpf:58af6e2c-1f0c-400d-9188-078000185695"},"cpf:status":{"completed":true,"type":"","status":200},"cpf:outputs":{"elementsRenditions":[],"elementsInfo":{"cpf:location":"jsonoutput","dc:format":"application/json"}}} --Boundary_7486_1638004035_1618820114945 Content-Type: application/octet-stream Content-Disposition: form-data; name="jsonoutput"

{ "version": { "json_export": "155", "page_segmentation": "53", "schema": "0.1", "structure": "1.829.0" }, "extended_metadata": { "ID_instance": "43 44 20 35 30 20 43 43 20 31 33 20 32 39 20 32 39 20 34 44 20 33 34 20 38 44 20 30 37 20 37 35 20 31 38 20 46 46 20 41 35 20 38 32 20 44 35 20 ", "ID_permanent": "46 33 20 35 46 20 41 34 20 30 41 20 30 33 20 42 34 20 34 46 20 34 45 20 39 39 20 43 44 20 35 32 20 44 45 20 31 30 20 46 37 20 46 38 20 42 46 20 ", "pdf_version": "1.7", "pdfa_compliance_level": "", "is_encrypted": false, "has_acroform": false, "is_digitally_signed": false, "pdfua_compliance_level": "", "page_count": 3, "has_embedded_files": false, "is_certified": false, "is_XFA": false, "language": "en-US" }, "elements": [ { "Bounds": [ 44.94239807128906, 756.8654937744141, 239.15545654296876, 766.8869934082031 ], "Font": { "alt_family_name": "Clean", "embedded": true, "encoding": "Custom", "family_name": "Adobe Clean", "font_type": "Type1", "italic": false, "monospaced": false, "name": "WKLBWE+AdobeClean-Regular", "subset": true, "weight": 400 }, "HasClip": false, "Lang": "en", "ObjectID": 644, "Page": 0, "Path": "//Document/Sect/P", "Text": "Adobe Vendor Security Review Program White Paper ", "TextSize": 8.5, "attributes": { "SpaceAfter": 18 }

    },
    --------------------------------------
    },
]

} --Boundary_7486_1638004035_1618820114945--

Create :

Convert a non-PDF File to a PDF File

Download Postman collection

Try Out With SDK

post createPDF

Submit a Create PDF Job

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

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430 required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/msword application/vnd.ms-excel application/vnd.ms-powerpoint application/vnd.openxmlformats-officedocument.presentationml.presentation application/vnd.openxmlformats-officedocument.spreadsheetml.sheet application/vnd.openxmlformats-officedocument.wordprocessingml.document image/bmp image/gif image/jpeg image/png image/tiff text/plain text/rtf required: ["dc:format","cpf:location"] params (object, optional) Params for Create PDF Operation cpf:inline (object, required) wordFormatOptions (object, optional) Options applicable for word files documentLanguage (string, optional) 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. 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, kr-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 additionalProperties: false excelFormatOptions (object, optional) Options applicable for excel files documentLanguage (string, optional) 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. 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, kr-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 additionalProperties: false pptFormatOptions (object, optional) Options applicable for powerpoint files documentLanguage (string, optional) 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. 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, kr-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 additionalProperties: false additionalProperties: false required: ["cpf:inline"] required: ["documentIn"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call documentOut (object, required) Contains the information about the file content part name and format of the output expected. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/pdf required: ["dc:format","cpf:location"] required: ["documentOut"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430" }, "cpf:inputs": { "documentIn": { "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "cpf:location": "multipartLabel" } }, "cpf:outputs": { "documentOut": { "dc:format": "application/pdf", "cpf:location": "multipartLabelOut" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/msword
application/vnd.ms-excel
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/bmp
image/gif
image/jpeg
image/png
image/tiff
text/plain
text/rtf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Create PDF Operation

cpf:inline
(object, required)

wordFormatOptions
(object, optional)
Options applicable for word files

documentLanguage
(string, optional)
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.

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, kr-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
excelFormatOptions
(object, optional)
Options applicable for excel files

documentLanguage
(string, optional)
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.

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, kr-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
pptFormatOptions
(object, optional)
Options applicable for powerpoint files

documentLanguage
(string, optional)
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.

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, kr-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

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{ "cpf:status": { "completed": false, "type": "", "title": "In Progress", "status": 202, "report": "" }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430" }, "cpf:inputs": { "documentIn": { "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "cpf:location": "multipartLabel" } } }

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/msword
application/vnd.ms-excel
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/bmp
image/gif
image/jpeg
image/png
image/tiff
text/plain
text/rtf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Create PDF Operation

cpf:inline
(object, required)

wordFormatOptions
(object, optional)
Options applicable for word files

documentLanguage
(string, optional)
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.

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, kr-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
excelFormatOptions
(object, optional)
Options applicable for excel files

documentLanguage
(string, optional)
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.

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, kr-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
pptFormatOptions
(object, optional)
Options applicable for powerpoint files

documentLanguage
(string, optional)
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.

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, kr-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

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{ "cpf:status": { "completed": true, "title": "Invalid I/O in the request. I/O name: documentIn I/O value: {\"sensei:multipart_field_name\":\"multipartLabel\",\"dc:format\":\"application/vnd.openxmlformats-officedocument.wordprocessingml.documentt\"} dc:format not one of supported media types.", "status": 400, "report": "{\"error_code\":\"MEDIA_TYPE_UNSUPPORTED\"}" }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430" }, "cpf:inputs": { "documentIn": { "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.documentt", "cpf:location": "multipartLabel" } } }

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/msword
application/vnd.ms-excel
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/bmp
image/gif
image/jpeg
image/png
image/tiff
text/plain
text/rtf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Create PDF Operation

cpf:inline
(object, required)

wordFormatOptions
(object, optional)
Options applicable for word files

documentLanguage
(string, optional)
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.

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, kr-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
excelFormatOptions
(object, optional)
Options applicable for excel files

documentLanguage
(string, optional)
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.

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, kr-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
pptFormatOptions
(object, optional)
Options applicable for powerpoint files

documentLanguage
(string, optional)
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.

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, kr-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

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/msword
application/vnd.ms-excel
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/bmp
image/gif
image/jpeg
image/png
image/tiff
text/plain
text/rtf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Create PDF Operation

cpf:inline
(object, required)

wordFormatOptions
(object, optional)
Options applicable for word files

documentLanguage
(string, optional)
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.

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, kr-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
excelFormatOptions
(object, optional)
Options applicable for excel files

documentLanguage
(string, optional)
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.

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, kr-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
pptFormatOptions
(object, optional)
Options applicable for powerpoint files

documentLanguage
(string, optional)
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.

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, kr-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

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/msword
application/vnd.ms-excel
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/bmp
image/gif
image/jpeg
image/png
image/tiff
text/plain
text/rtf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Create PDF Operation

cpf:inline
(object, required)

wordFormatOptions
(object, optional)
Options applicable for word files

documentLanguage
(string, optional)
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.

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, kr-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
excelFormatOptions
(object, optional)
Options applicable for excel files

documentLanguage
(string, optional)
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.

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, kr-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
pptFormatOptions
(object, optional)
Options applicable for powerpoint files

documentLanguage
(string, optional)
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.

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, kr-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

required: ["cpf:inline"]


required: ["documentIn"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests={
    \"cpf:inputs\": {
        \"documentIn\": {
            \"cpf:location\": \"InputFile0\",
            \"dc:format\": \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\"
        }
    },
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430\"
    },
    \"cpf:outputs\": {
        \"documentOut\": {
            \"cpf:location\": \"multipartLabelOut\",
            \"dc:format\": \"application/pdf\"
        }
    }
}' \
--form 'InputFile0=@"{{Placeholder for input file (absolute path)}}"'

get createPDF.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
SOURCE_EMPTY
The input file is a zero length file.


400
REQUEST_TOO_LARGE
The input file is too large.


400
CORRUPT_DOCUMENT
For $(format) mime-type The input file appears to be corrupted and cannot be processed.


400
PASSWORD_PROTECTED
Source file is protected and cannot be processed.


500
INTERNAL_SERVER_ERROR
An Internal Server Error has occurred.


500
REQUEST_TIMEOUT
The operation has timed out, please try after some time.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/msword
application/vnd.ms-excel
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/bmp
image/gif
image/jpeg
image/png
image/tiff
text/plain
text/rtf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Create PDF Operation

cpf:inline
(object, required)

wordFormatOptions
(object, optional)
Options applicable for word files

documentLanguage
(string, optional)
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.

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, kr-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
excelFormatOptions
(object, optional)
Options applicable for excel files

documentLanguage
(string, optional)
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.

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, kr-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
pptFormatOptions
(object, optional)
Options applicable for powerpoint files

documentLanguage
(string, optional)
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.

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, kr-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

required: ["cpf:inline"]


required: ["documentIn"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

documentOut
(object, required)
Contains the information about the file content part name and format of the output expected.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentOut"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:inputs": {
    "documentIn": {
      "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "cpf:location": "multipartLabel"
    }
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430"
  },
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200,
    "report": ""
  },
  "cpf:outputs": {
    "documentOut": {
      "cpf:location": "multipartLabelOut",
      "dc:format": "application/pdf"
    }
  }
}

<output_file_content_part>

The file part containing output file content. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOut.cpf:location field.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/msword
application/vnd.ms-excel
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/bmp
image/gif
image/jpeg
image/png
image/tiff
text/plain
text/rtf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Create PDF Operation

cpf:inline
(object, required)

wordFormatOptions
(object, optional)
Options applicable for word files

documentLanguage
(string, optional)
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.

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, kr-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
excelFormatOptions
(object, optional)
Options applicable for excel files

documentLanguage
(string, optional)
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.

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, kr-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
pptFormatOptions
(object, optional)
Options applicable for powerpoint files

documentLanguage
(string, optional)
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.

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, kr-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

required: ["cpf:inline"]


required: ["documentIn"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/msword
application/vnd.ms-excel
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/bmp
image/gif
image/jpeg
image/png
image/tiff
text/plain
text/rtf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Create PDF Operation

cpf:inline
(object, required)

wordFormatOptions
(object, optional)
Options applicable for word files

documentLanguage
(string, optional)
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.

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, kr-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
excelFormatOptions
(object, optional)
Options applicable for excel files

documentLanguage
(string, optional)
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.

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, kr-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
pptFormatOptions
(object, optional)
Options applicable for powerpoint files

documentLanguage
(string, optional)
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.

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, kr-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

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/msword
application/vnd.ms-excel
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/bmp
image/gif
image/jpeg
image/png
image/tiff
text/plain
text/rtf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Create PDF Operation

cpf:inline
(object, required)

wordFormatOptions
(object, optional)
Options applicable for word files

documentLanguage
(string, optional)
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.

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, kr-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
excelFormatOptions
(object, optional)
Options applicable for excel files

documentLanguage
(string, optional)
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.

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, kr-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
pptFormatOptions
(object, optional)
Options applicable for powerpoint files

documentLanguage
(string, optional)
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.

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, kr-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

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/msword
application/vnd.ms-excel
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-officedocument.wordprocessingml.document
image/bmp
image/gif
image/jpeg
image/png
image/tiff
text/plain
text/rtf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Create PDF Operation

cpf:inline
(object, required)

wordFormatOptions
(object, optional)
Options applicable for word files

documentLanguage
(string, optional)
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.

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, kr-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
excelFormatOptions
(object, optional)
Options applicable for excel files

documentLanguage
(string, optional)
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.

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, kr-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
pptFormatOptions
(object, optional)
Options applicable for powerpoint files

documentLanguage
(string, optional)
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.

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, kr-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

required: ["cpf:inline"]


required: ["documentIn"]

Example:

--Boundary_56207_799502958_1612186721277 Content-Type: application/json Content-Disposition: form-data; name="contentAnalyzerResponse"

{ "cpf:inputs": { "documentIn": { "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "cpf:location": "multipartLabel" } }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-1538ece812254acaac2a07799503a430" }, "cpf:status": { "completed": true, "type": "", "status": 200, "report": "" }, "cpf:outputs": { "documentOut": { "cpf:location": "multipartLabelOut", "dc:format": "application/pdf" } } } --Boundary_56207_799502958_1612186721277 Content-Type: application/octet-stream Content-Disposition: form-data; name="multipartLabelOut"

%PDF-1.6 %�� 21 0 obj <</Linearized 1/L 86835/O 23/E 81424/N 1/T 86520/H [ 488 189 ]>> endobj --Boundary_56207_799502958_1612186721277

HTML To PDF :

Convert HTML Resources to a PDF File

Download Postman collection

Try Out With SDK

post htmlToPDF

Submit a HTML To PDF Job

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.

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7 required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation ONE OF documentIn (object, optional) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/zip text/html required: ["dc:format","cpf:location"] inputUrl (string, optional) Parameter to provide the URL as input. params (object, optional) Parameters for html to pdf conversion. cpf:inline (object, required) json (string, optional) 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. default: {} print (object, optional) Parameters for specifying the print properties. includeHeaderFooter (boolean, optional) 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. default: true additionalProperties: false pageLayout (object, optional) Parameters for specifying the layout of the output page. pageWidth (number, optional) The width (in inches) of the output paper size. default: 11 pageHeight (number, optional) The height (in inches) of the output paper size. default: 8.5 additionalProperties: false additionalProperties: false required: ["cpf:inline"] oneOf: [ {"required":["documentIn"]}, {"required":["inputUrl"]} ] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call documentOut (object, required) Contains the information about the file content part name and format of the output expected. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/pdf required: ["dc:format","cpf:location"] required: ["documentOut"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7" }, "cpf:inputs": { "params": { "cpf:inline": { "json": "[\"a\": \"b\"]", "print": { "includeHeaderFooter": true }, "pageLayout": { "pageWidth": 11, "pageHeight": 8.5 } } }, "documentIn": { "dc:format": "application/zip", "cpf:location": "multipartLabel" } }, "cpf:outputs": { "documentOut": { "dc:format": "application/pdf", "cpf:location": "multipartLabelOut" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

ONE OF
documentIn
(object, optional)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/zip
text/html


required: ["dc:format","cpf:location"]

inputUrl
(string, optional)
Parameter to provide the URL as input.

params
(object, optional)
Parameters for html to pdf conversion.

cpf:inline
(object, required)

json
(string, optional)
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.

default: {}
print
(object, optional)
Parameters for specifying the print properties.

includeHeaderFooter
(boolean, optional)
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.

default: true
pageLayout
(object, optional)
Parameters for specifying the layout of the output page.

pageWidth
(number, optional)
The width (in inches) of the output paper size.

default: 11
pageHeight
(number, optional)
The height (in inches) of the output paper size.

default: 8.5

required: ["cpf:inline"]


oneOf: [
  {"required":["documentIn"]},
  {"required":["inputUrl"]}
]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": false,
    "type": "",
    "title": "In Progress",
    "status": 202,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "json": "[\"a\": \"b\"]",
        "print": {
          "includeHeaderFooter": true
        },
        "pageLayout": {
          "pageWidth": 11,
          "pageHeight": 8.5
        }
      }
    },
    "documentIn": {
      "dc:format": "application/zip",
      "cpf:location": "multipartLabel"
    }
  }
}

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

ONE OF
documentIn
(object, optional)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/zip
text/html


required: ["dc:format","cpf:location"]

inputUrl
(string, optional)
Parameter to provide the URL as input.

params
(object, optional)
Parameters for html to pdf conversion.

cpf:inline
(object, required)

json
(string, optional)
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.

default: {}
print
(object, optional)
Parameters for specifying the print properties.

includeHeaderFooter
(boolean, optional)
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.

default: true
pageLayout
(object, optional)
Parameters for specifying the layout of the output page.

pageWidth
(number, optional)
The width (in inches) of the output paper size.

default: 11
pageHeight
(number, optional)
The height (in inches) of the output paper size.

default: 8.5

required: ["cpf:inline"]


oneOf: [
  {"required":["documentIn"]},
  {"required":["inputUrl"]}
]


required: ["cpf:engine","cpf:inputs"]

Example:

{ "cpf:status": { "completed": true, "type": "I/O Validation Error.", "title": "Value for I/O object params does not match the required schema {\"default\":{},\"type\":\"object\",\"properties\":{\"print\":{\"description\":\"Parameters for specifying the print properties.\",\"type\":\"object\",\"properties\":{\"includeHeaderFooter\":{\"description\":\"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.\",\"default\":true,\"type\":\"boolean\"}},\"additionalProperties\":false},\"pageLayout\":{\"description\":\"Parameters for specifying the layout of the output page.\",\"type\":\"object\",\"properties\":{\"pageHeight\":{\"description\":\"The height (in inches) of the output paper size.\",\"default\":8.5,\"type\":\"number\"},\"pageWidth\":{\"description\":\"The width (in inches) of the output paper size.\",\"default\":11,\"type\":\"number\"}},\"additionalProperties\":false},\"json\":{\"description\":\"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:\r\n<script src='./json.js' type='text/javascript'></script>\r\nWhen rendering from a URL, the content of this json object is injected into the browser VM before the page is rendered.\",\"default\":\"{}\",\"type\":\"string\"}},\"additionalProperties\":false}.", "status": 400, "report": "{\"error_code\":\"IO_SCHEMA_MISMATCH\"}" }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7" }, "cpf:inputs": { "params": { "cpf:inline": { "json": "[\"a\": \"b\"]", "print": { "includeHeaderFooter": true }, "pageLayout": { "pageWidthh": 11, "pageHeight": 8.5 } } }, "documentIn": { "dc:format": "application/zip", "cpf:location": "multipartLabel" } } }

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

ONE OF
documentIn
(object, optional)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/zip
text/html


required: ["dc:format","cpf:location"]

inputUrl
(string, optional)
Parameter to provide the URL as input.

params
(object, optional)
Parameters for html to pdf conversion.

cpf:inline
(object, required)

json
(string, optional)
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.

default: {}
print
(object, optional)
Parameters for specifying the print properties.

includeHeaderFooter
(boolean, optional)
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.

default: true
pageLayout
(object, optional)
Parameters for specifying the layout of the output page.

pageWidth
(number, optional)
The width (in inches) of the output paper size.

default: 11
pageHeight
(number, optional)
The height (in inches) of the output paper size.

default: 8.5

required: ["cpf:inline"]


oneOf: [
  {"required":["documentIn"]},
  {"required":["inputUrl"]}
]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

ONE OF
documentIn
(object, optional)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/zip
text/html


required: ["dc:format","cpf:location"]

inputUrl
(string, optional)
Parameter to provide the URL as input.

params
(object, optional)
Parameters for html to pdf conversion.

cpf:inline
(object, required)

json
(string, optional)
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.

default: {}
print
(object, optional)
Parameters for specifying the print properties.

includeHeaderFooter
(boolean, optional)
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.

default: true
pageLayout
(object, optional)
Parameters for specifying the layout of the output page.

pageWidth
(number, optional)
The width (in inches) of the output paper size.

default: 11
pageHeight
(number, optional)
The height (in inches) of the output paper size.

default: 8.5

required: ["cpf:inline"]


oneOf: [
  {"required":["documentIn"]},
  {"required":["inputUrl"]}
]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

ONE OF
documentIn
(object, optional)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/zip
text/html


required: ["dc:format","cpf:location"]

inputUrl
(string, optional)
Parameter to provide the URL as input.

params
(object, optional)
Parameters for html to pdf conversion.

cpf:inline
(object, required)

json
(string, optional)
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.

default: {}
print
(object, optional)
Parameters for specifying the print properties.

includeHeaderFooter
(boolean, optional)
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.

default: true
pageLayout
(object, optional)
Parameters for specifying the layout of the output page.

pageWidth
(number, optional)
The width (in inches) of the output paper size.

default: 11
pageHeight
(number, optional)
The height (in inches) of the output paper size.

default: 8.5

required: ["cpf:inline"]


oneOf: [
  {"required":["documentIn"]},
  {"required":["inputUrl"]}
]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests="\"\"{
    \"cpf:inputs\": {
        \"params\": {
            \"cpf:inline\": {
                \"print\": {
                    \"includeHeaderFooter\": true
                },
                \"pageLayout\": {
                    \"pageHeight\": 8.5,
                    \"pageWidth\": 11
                },
                \"json\": \"{\"k1\": \"v1\", \"k2\": \"v2\"}\"
            }
        },
        \"documentIn\": {
            \"cpf:location\": \"InputFile0\",
            \"dc:format\": \"application/zip\"
        },
    },
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7\"
    },
    \"cpf:outputs\": {
        \"documentOut\": {
            \"cpf:location\": \"multipartLabelOut\",
            \"dc:format\": \"application/pdf\"
        }
    }
}\"\""' \
--form 'InputFile0="\"\"\"@\"{{Placeholder for input file (absolute path)}}\"\"\"\""'

get htmlToPDF.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
SOURCE_EMPTY
The input file is a zero length file.


400
REQUEST_TOO_LARGE
The input file is too large.


400
INVALID_ZIP
The zip file provided has invalid content.


400
MISSING_INDEX_HTML
index.html doesn't exist in archive.


400
INVALID_JSON
Provided invalid JSON data object that is used for injecting the data into the HTML before rendering.


400
INVALID_PAGE_WIDTH
Page Width should be greater than 0.


400
INVALID_PAGE_HEIGHT
Page Height should be greater than 0.


400
ENFORCE_HTTPS_ERROR
Only HTTPS URLs supported.


400
BOTH_URL_AND_DOCUMENT_PROVIDED
Both the URL and Input document are provided.


400
NEITHER_URL_NOR_DOCUMENT_PROVIDED
Neither URL Nor the Input document are provided.


500
INTERNAL_SERVER_ERROR
An Internal Server Error has occurred.


500
REQUEST_TIMEOUT
The operation has timed out, please try after some time.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

ONE OF
documentIn
(object, optional)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/zip
text/html


required: ["dc:format","cpf:location"]

inputUrl
(string, optional)
Parameter to provide the URL as input.

params
(object, optional)
Parameters for html to pdf conversion.

cpf:inline
(object, required)

json
(string, optional)
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.

default: {}
print
(object, optional)
Parameters for specifying the print properties.

includeHeaderFooter
(boolean, optional)
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.

default: true
pageLayout
(object, optional)
Parameters for specifying the layout of the output page.

pageWidth
(number, optional)
The width (in inches) of the output paper size.

default: 11
pageHeight
(number, optional)
The height (in inches) of the output paper size.

default: 8.5

required: ["cpf:inline"]


oneOf: [
  {"required":["documentIn"]},
  {"required":["inputUrl"]}
]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

documentOut
(object, required)
Contains the information about the file content part name and format of the output expected.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentOut"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "json": "[\"a\": \"b\"]",
        "print": {
          "includeHeaderFooter": true
        },
        "pageLayout": {
          "pageWidth": 11,
          "pageHeight": 8.5
        }
      }
    },
    "documentIn": {
      "dc:format": "application/zip",
      "cpf:location": "multipartLabel"
    }
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-d28a398065794200b941f4a0f00bae19"
  },
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200,
    "report": ""
  },
  "cpf:outputs": {
    "documentOut": {
      "cpf:location": "multipartLabelOut",
      "dc:format": "application/pdf"
    }
  }
}

<output_file_content_part>

The file part containing output file content. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOut.cpf:location field.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

ONE OF
documentIn
(object, optional)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/zip
text/html


required: ["dc:format","cpf:location"]

inputUrl
(string, optional)
Parameter to provide the URL as input.

params
(object, optional)
Parameters for html to pdf conversion.

cpf:inline
(object, required)

json
(string, optional)
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.

default: {}
print
(object, optional)
Parameters for specifying the print properties.

includeHeaderFooter
(boolean, optional)
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.

default: true
pageLayout
(object, optional)
Parameters for specifying the layout of the output page.

pageWidth
(number, optional)
The width (in inches) of the output paper size.

default: 11
pageHeight
(number, optional)
The height (in inches) of the output paper size.

default: 8.5

required: ["cpf:inline"]


oneOf: [
  {"required":["documentIn"]},
  {"required":["inputUrl"]}
]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

ONE OF
documentIn
(object, optional)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/zip
text/html


required: ["dc:format","cpf:location"]

inputUrl
(string, optional)
Parameter to provide the URL as input.

params
(object, optional)
Parameters for html to pdf conversion.

cpf:inline
(object, required)

json
(string, optional)
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.

default: {}
print
(object, optional)
Parameters for specifying the print properties.

includeHeaderFooter
(boolean, optional)
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.

default: true
pageLayout
(object, optional)
Parameters for specifying the layout of the output page.

pageWidth
(number, optional)
The width (in inches) of the output paper size.

default: 11
pageHeight
(number, optional)
The height (in inches) of the output paper size.

default: 8.5

required: ["cpf:inline"]


oneOf: [
  {"required":["documentIn"]},
  {"required":["inputUrl"]}
]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

ONE OF
documentIn
(object, optional)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/zip
text/html


required: ["dc:format","cpf:location"]

inputUrl
(string, optional)
Parameter to provide the URL as input.

params
(object, optional)
Parameters for html to pdf conversion.

cpf:inline
(object, required)

json
(string, optional)
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.

default: {}
print
(object, optional)
Parameters for specifying the print properties.

includeHeaderFooter
(boolean, optional)
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.

default: true
pageLayout
(object, optional)
Parameters for specifying the layout of the output page.

pageWidth
(number, optional)
The width (in inches) of the output paper size.

default: 11
pageHeight
(number, optional)
The height (in inches) of the output paper size.

default: 8.5

required: ["cpf:inline"]


oneOf: [
  {"required":["documentIn"]},
  {"required":["inputUrl"]}
]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e2ee120a2b06427cb449592f5db967e7 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

ONE OF
documentIn
(object, optional)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/zip
text/html


required: ["dc:format","cpf:location"]

inputUrl
(string, optional)
Parameter to provide the URL as input.

params
(object, optional)
Parameters for html to pdf conversion.

cpf:inline
(object, required)

json
(string, optional)
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.

default: {}
print
(object, optional)
Parameters for specifying the print properties.

includeHeaderFooter
(boolean, optional)
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.

default: true
pageLayout
(object, optional)
Parameters for specifying the layout of the output page.

pageWidth
(number, optional)
The width (in inches) of the output paper size.

default: 11
pageHeight
(number, optional)
The height (in inches) of the output paper size.

default: 8.5

required: ["cpf:inline"]


oneOf: [
  {"required":["documentIn"]},
  {"required":["inputUrl"]}
]

Example:

--Boundary_17204_301972373_1611582119005
Content-Type: application/json
Content-Disposition: form-data; name="contentAnalyzerResponse"
{
    "cpf:inputs": {
        "params": {
            "cpf:inline": {
                "json": "[\"a\": \"b\"]",
                "print": {
                    "includeHeaderFooter": true
                },
                "pageLayout": {
                    "pageWidth": 11,
                    "pageHeight": 8.5
                }
            }
        },
        "documentIn": {
            "dc:format": "application/zip",
            "cpf:location": "multipartLabel"
        }
    },
    "cpf:engine": {
        "repo:assetId": "urn:aaid:cpf:Service-d28a398065794200b941f4a0f00bae19"
    },
    "cpf:status": {
        "completed": true,
        "type": "",
        "status": 200,
        "report": ""
    },
    "cpf:outputs": {
        "documentOut": {
            "cpf:location": "multipartLabelOut",
            "dc:format": "application/pdf"
        }
    }
}
--Boundary_17204_301972373_1611582119005
Content-Type: application/octet-stream
Content-Disposition: form-data; name="multipartLabelOut"
%PDF-1.6
%����
17 0 obj
<</Metadata 30 0 R/Pages 16 0 R/Type/Catalog>>
endobj
--Boundary_17204_301972373_1611582119005

Combine :

Combine multiple PDF Files into a single PDF File

Download Postman collection

Try Out With SDK

post combinePDF

Submit a Combine PDFs Job

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.

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13 required: ["repo:assetId"] cpf:inputs (object, required) The details about the file(s) and the PageRanges provided as input to this operation documentsIn (array, required) The array of source documents with the required PageRanges to include in the output PDF document. [{ documentIn (object, required) cpf:location (string, required) It will contain the <file_part_index> which will be given as part name for the file. dc:format (string, required) The format of the file taken as input: application/pdf required: ["dc:format","cpf:location"] pageRanges (object, optional) Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default. cpf:inline (array, required) An array of ranges to allow specifying which pages to include from the source PDF document. [{ ANY OF start (integer, optional) start index of page end (integer, optional) end index of page anyOf: [ {"required":["start"]}, {"required":["end"]} ] }] required: ["cpf:inline"] required: ["documentIn"] }] required: ["documentsIn"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call documentOut (object, required) Contains the information about the file content part name and format of the output expected. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/pdf required: ["dc:format","cpf:location"] required: ["documentOut"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13" }, "cpf:inputs": { "documentsIn": [ { "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel1" }, "pageRanges": { "cpf:inline": [ { "start": 1, "end": 2 }, { "start": 4 } ] } } ] }, "cpf:outputs": { "documentOut": { "dc:format": "application/pdf", "cpf:location": "multipartLabelOut" } } }
<file_content_part_name>	true	Multiple input file contents. The part name of file content should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentsIn.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file(s) and the PageRanges provided as input to this operation

documentsIn
(array, required)
The array of source documents with the required PageRanges to include in the output PDF document.

[{
documentIn
(object, required)

cpf:location
(string, required)
It will contain the <file_part_index> which will be given as part name for the file.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

pageRanges
(object, optional)
Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default.

cpf:inline
(array, required)
An array of ranges to allow specifying which pages to include from the source PDF document.

[{
ANY OF
start
(integer, optional)
start index of page

end
(integer, optional)
end index of page


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["cpf:inline"]


required: ["documentIn"]
}]

required: ["documentsIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": false,
    "type": "",
    "title": "In Progress",
    "status": 202,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13"
  },
  "cpf:inputs": {
    "documentsIn": [
      {
        "documentIn": {
          "dc:format": "application/pdf",
          "cpf:location": "multipartLabel1"
        },
        "pageRanges": {
          "cpf:inline": [
            {
              "start": 1,
              "end": 2
            },
            {
              "start": 4
            }
          ]
        }
      }
    ]
  }
}

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file(s) and the PageRanges provided as input to this operation

documentsIn
(array, required)
The array of source documents with the required PageRanges to include in the output PDF document.

[{
documentIn
(object, required)

cpf:location
(string, required)
It will contain the <file_part_index> which will be given as part name for the file.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

pageRanges
(object, optional)
Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default.

cpf:inline
(array, required)
An array of ranges to allow specifying which pages to include from the source PDF document.

[{
ANY OF
start
(integer, optional)
start index of page

end
(integer, optional)
end index of page


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["cpf:inline"]


required: ["documentIn"]
}]

required: ["documentsIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Engine Definition Validation Exception.",
    "title": "Required input documentsIn not found.",
    "status": 400,
    "report": "{\"error_code\":\"REQUIRED_INPUTS_MISSING\"}"
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13"
  },
  "cpf:inputs": {
    "documentsInn": [
      {
        "documentIn": {
          "dc:format": "application/pdf",
          "cpf:location": "multipartLabel1"
        },
        "pageRanges": {
          "cpf:inline": [
            {
              "start": 1,
              "end": 2
            },
            {
              "start": 4
            }
          ]
        }
      }
    ]
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file(s) and the PageRanges provided as input to this operation

documentsIn
(array, required)
The array of source documents with the required PageRanges to include in the output PDF document.

[{
documentIn
(object, required)

cpf:location
(string, required)
It will contain the <file_part_index> which will be given as part name for the file.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

pageRanges
(object, optional)
Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default.

cpf:inline
(array, required)
An array of ranges to allow specifying which pages to include from the source PDF document.

[{
ANY OF
start
(integer, optional)
start index of page

end
(integer, optional)
end index of page


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["cpf:inline"]


required: ["documentIn"]
}]

required: ["documentsIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file(s) and the PageRanges provided as input to this operation

documentsIn
(array, required)
The array of source documents with the required PageRanges to include in the output PDF document.

[{
documentIn
(object, required)

cpf:location
(string, required)
It will contain the <file_part_index> which will be given as part name for the file.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

pageRanges
(object, optional)
Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default.

cpf:inline
(array, required)
An array of ranges to allow specifying which pages to include from the source PDF document.

[{
ANY OF
start
(integer, optional)
start index of page

end
(integer, optional)
end index of page


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["cpf:inline"]


required: ["documentIn"]
}]

required: ["documentsIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file(s) and the PageRanges provided as input to this operation

documentsIn
(array, required)
The array of source documents with the required PageRanges to include in the output PDF document.

[{
documentIn
(object, required)

cpf:location
(string, required)
It will contain the <file_part_index> which will be given as part name for the file.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

pageRanges
(object, optional)
Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default.

cpf:inline
(array, required)
An array of ranges to allow specifying which pages to include from the source PDF document.

[{
ANY OF
start
(integer, optional)
start index of page

end
(integer, optional)
end index of page


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["cpf:inline"]


required: ["documentIn"]
}]

required: ["documentsIn"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests={
    \"cpf:inputs\": {
        \"documentsIn\": [{
            \"pageRanges\": {
                \"cpf:inline\": [{
                    \"start\": 1,
                    \"end\": 4
                }]
            },
            \"documentIn\": {
                \"cpf:location\": \"InputFile0\",
                \"dc:format\": \"application/pdf\"
            }
        }, {
            \"pageRanges\": {
                \"cpf:inline\": [{
                    \"start\": 1,
                    \"end\": 25
                }]
            },
            \"documentIn\": {
                \"cpf:location\": \"InputFile1\",
                \"dc:format\": \"application/pdf\"
            }
        }, {
            \"pageRanges\": {
                \"cpf:inline\": [{
                    \"start\": 1
                }, {
                    \"end\": 25
                }, {
                    \"start\": 1,
                    \"end\": 25
                }]
            },
            \"documentIn\": {
                \"cpf:location\": \"InputFile2\",
                \"dc:format\": \"application/pdf\"
            }
        }]
    },
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13\"
    },
    \"cpf:outputs\": {
        \"documentOut\": {
            \"cpf:location\": \"OutputFile\",
            \"dc:format\": \"application/pdf\"
        }
    }
}' \
--form 'InputFile0=@"{{Placeholder for input file (absolute path)}}"' \
--form 'InputFile1=@"{{Placeholder for input file (absolute path)}}"' \
--form 'InputFile2=@"{{Placeholder for input file (absolute path)}}"'

get combinePDF.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
INPUT_FILES_LIMIT_EXCEEDED
This request has exceeded the maximum number of files that can be combined.


400
SOURCE_EMPTY
The input file is a zero length file.


400
REQUEST_TOO_LARGE
The input file is too large.


400
CORRUPT_DOCUMENT
The input file appears to be corrupted and cannot be processed.


400
PASSWORD_PROTECTED
Source file is protected and cannot be processed.


400
PDF_XFA_FORM
Source PDF is a XFA Form and cannot be processed.


400
PDF_CERTIFIED
Source PDF is certified and cannot be processed.


400
PDF_CERTIFICATE_ENCRYPTED
Source file is certificate encrypted and cannot be processed.


400
PDF_HAS_ATTACHMENTS
PDF document containing file attachments is not supported.


400
INVALID_PAGE_RANGE
The page range specified is invalid. Either invalid range syntax, bad page references, or results in a PDF with too many pages relative to the input PDF(s).


500
INTERNAL_SERVER_ERROR
An Internal Server Error has occurred.


500
REQUEST_TIMEOUT
The operation has timed out, please try after some time.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file(s) and the PageRanges provided as input to this operation

documentsIn
(array, required)
The array of source documents with the required PageRanges to include in the output PDF document.

[{
documentIn
(object, required)

cpf:location
(string, required)
It will contain the <file_part_index> which will be given as part name for the file.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

pageRanges
(object, optional)
Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default.

cpf:inline
(array, required)
An array of ranges to allow specifying which pages to include from the source PDF document.

[{
ANY OF
start
(integer, optional)
start index of page

end
(integer, optional)
end index of page


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["cpf:inline"]


required: ["documentIn"]
}]

required: ["documentsIn"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

documentOut
(object, required)
Contains the information about the file content part name and format of the output expected.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentOut"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:inputs": {
    "documentsIn": [
      {
        "documentIn": {
          "dc:format": "application/pdf",
          "cpf:location": "multipartLabel1"
        },
        "pageRanges": {
          "cpf:inline": [
            {
              "start": 1,
              "end": 2
            },
            {
              "start": 4
            }
          ]
        }
      }
    ]
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13"
  },
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200,
    "report": ""
  },
  "cpf:outputs": {
    "documentOut": {
      "cpf:location": "multipartLabelOut",
      "dc:format": "application/pdf"
    }
  }
}

<output_file_content_part>

The file part containing output file content. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOut.cpf:location field.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file(s) and the PageRanges provided as input to this operation

documentsIn
(array, required)
The array of source documents with the required PageRanges to include in the output PDF document.

[{
documentIn
(object, required)

cpf:location
(string, required)
It will contain the <file_part_index> which will be given as part name for the file.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

pageRanges
(object, optional)
Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default.

cpf:inline
(array, required)
An array of ranges to allow specifying which pages to include from the source PDF document.

[{
ANY OF
start
(integer, optional)
start index of page

end
(integer, optional)
end index of page


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["cpf:inline"]


required: ["documentIn"]
}]

required: ["documentsIn"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file(s) and the PageRanges provided as input to this operation

documentsIn
(array, required)
The array of source documents with the required PageRanges to include in the output PDF document.

[{
documentIn
(object, required)

cpf:location
(string, required)
It will contain the <file_part_index> which will be given as part name for the file.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

pageRanges
(object, optional)
Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default.

cpf:inline
(array, required)
An array of ranges to allow specifying which pages to include from the source PDF document.

[{
ANY OF
start
(integer, optional)
start index of page

end
(integer, optional)
end index of page


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["cpf:inline"]


required: ["documentIn"]
}]

required: ["documentsIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file(s) and the PageRanges provided as input to this operation

documentsIn
(array, required)
The array of source documents with the required PageRanges to include in the output PDF document.

[{
documentIn
(object, required)

cpf:location
(string, required)
It will contain the <file_part_index> which will be given as part name for the file.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

pageRanges
(object, optional)
Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default.

cpf:inline
(array, required)
An array of ranges to allow specifying which pages to include from the source PDF document.

[{
ANY OF
start
(integer, optional)
start index of page

end
(integer, optional)
end index of page


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["cpf:inline"]


required: ["documentIn"]
}]

required: ["documentsIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file(s) and the PageRanges provided as input to this operation

documentsIn
(array, required)
The array of source documents with the required PageRanges to include in the output PDF document.

[{
documentIn
(object, required)

cpf:location
(string, required)
It will contain the <file_part_index> which will be given as part name for the file.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

pageRanges
(object, optional)
Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default.

cpf:inline
(array, required)
An array of ranges to allow specifying which pages to include from the source PDF document.

[{
ANY OF
start
(integer, optional)
start index of page

end
(integer, optional)
end index of page


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["cpf:inline"]


required: ["documentIn"]
}]

required: ["documentsIn"]

Example:

--Boundary_58079_229552553_1612198692505
Content-Type: application/json
Content-Disposition: form-data; name="contentAnalyzerResponse"
{
    "cpf:inputs": {
        "documentsIn": [
            {
                "documentIn": {
                    "dc:format": "application/pdf",
                    "cpf:location": "multipartLabel1"
                },
                "pageRanges": {
                    "cpf:inline": [
                        {
                            "start": 1,
                            "end": 2
                        },
                        {
                            "start": 4
                        }
                    ]
                }
            }
        ]
    },
    "cpf:engine": {
        "repo:assetId": "urn:aaid:cpf:Service-916ee91c156b42349a7847a7d564fb13"
    },
    "cpf:status": {
        "completed": true,
        "type": "",
        "status": 200,
        "report": ""
    },
    "cpf:outputs": {
        "documentOut": {
            "cpf:location": "multipartLabelOut",
            "dc:format": "application/pdf"
        }
    }
}
--Boundary_58079_229552553_1612198692505
Content-Type: application/octet-stream
Content-Disposition: form-data; name="multipartLabelOut"
%PDF-1.7
%����
163 0 obj
<</Linearized 1/L 283136/O 165/E 258795/N 2/T 282755/H [
    521 287
]>>
endobj
--Boundary_58079_229552553_1612198692505

Compress :

Compress a PDF File

Download Postman collection

Try Out With SDK

post compressPDF

Submit a Compress PDF Job

Compress PDFs to reduce the file size prior to performing workflow operations that use bandwidth or memory. Supported levels of compression which reduces the file size of pdf:

Low : Reduces resolution of the coloured and grayscale images above 250 dpi to 200 dpi. This option uses JP2K high quality compression.
Medium : Reduces resolution of the coloured and grayscale images above 200 dpi to 144 dpi. This option uses JP2K medium quality compression.
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.

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061 required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/pdf required: ["dc:format","cpf:location"] params (object, optional) Params for Compress PDF Operation. cpf:inline (object, required) compressionLevel (string, optional) Specify the level of compression to reduce the file size of the pdf. enum: HIGH, MEDIUM, LOW additionalProperties: false required: ["cpf:inline"] required: ["documentIn"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call documentOut (object, required) Contains the information about the file content part name and format of the output expected. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/pdf required: ["dc:format","cpf:location"] required: ["documentOut"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061" }, "cpf:inputs": { "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" }, "params": { "cpf:inline": { "compressionLevel": "MEDIUM" } } }, "cpf:outputs": { "documentOut": { "dc:format": "application/pdf", "cpf:location": "multipartLabelOut" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Compress PDF Operation.

cpf:inline
(object, required)

compressionLevel
(string, optional)
Specify the level of compression to reduce the file size of the pdf.

enum: HIGH, MEDIUM, LOW

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": false,
    "type": "",
    "title": "In Progress",
    "status": 202,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061"
  },
  "cpf:inputs": {
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    },
    "params": {
      "cpf:inline": {
        "compressionLevel": "MEDIUM"
      }
    }
  }
}

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Compress PDF Operation.

cpf:inline
(object, required)

compressionLevel
(string, optional)
Specify the level of compression to reduce the file size of the pdf.

enum: HIGH, MEDIUM, LOW

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "I/O Validation Error.",
    "title": "Value for I/O object params does not match the required schema {\"default\":{},\"type\":\"object\",\"properties\":{\"compressionLevel\":{\"description\":\"Specify the level of compression to reduce the file size of the pdf.\",\"default\":\"MEDIUM\",\"enum\":[\"HIGH\",\"MEDIUM\",\"LOW\"],\"type\":\"string\"}},\"additionalProperties\":false}.",
    "status": 400,
    "report": "{\"error_code\":\"IO_SCHEMA_MISMATCH\"}"
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061"
  },
  "cpf:inputs": {
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    },
    "params": {
      "cpf:inline": {
        "compressionLevel": "MEDIUMm"
      }
    }
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Compress PDF Operation.

cpf:inline
(object, required)

compressionLevel
(string, optional)
Specify the level of compression to reduce the file size of the pdf.

enum: HIGH, MEDIUM, LOW

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Compress PDF Operation.

cpf:inline
(object, required)

compressionLevel
(string, optional)
Specify the level of compression to reduce the file size of the pdf.

enum: HIGH, MEDIUM, LOW

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Compress PDF Operation.

cpf:inline
(object, required)

compressionLevel
(string, optional)
Specify the level of compression to reduce the file size of the pdf.

enum: HIGH, MEDIUM, LOW

required: ["cpf:inline"]


required: ["documentIn"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests={
    \"cpf:inputs\": {
        \"params\": {
            \"cpf:inline\": {
                \"compressionLevel\": \"MEDIUM\"
            }
        },
        \"documentIn\": {
            \"cpf:location\": \"InputFile0\",
            \"dc:format\": \"application/pdf\"
        }
    },
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061\"
    },
    \"cpf:outputs\": {
        \"documentOut\": {
            \"cpf:location\": \"multipartLabelOut\",
            \"dc:format\": \"application/pdf\"
        }
    }
}' \
--form 'InputFile0=@"{{Placeholder for input file (absolute path)}}"'

get compressPDF.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
PDF_ALREADY_COMPRESSED
The input file is already compressed.


400
SOURCE_EMPTY
The input file is a zero length file.


400
REQUEST_TOO_LARGE
The input file is too large.


400
CORRUPT_DOCUMENT
The input file appears to be corrupted and cannot be processed.


400
PASSWORD_PROTECTED
Source file is protected and cannot be processed.


400
PDF_CERTIFICATE_ENCRYPTED
Source file is certificate encrypted and cannot be processed.


400
DOCUMENT_RESTRICTED
Source file cannot be processed because of some restrictions.


500
INTERNAL_SERVER_ERROR
An Internal Server Error has occurred.


500
REQUEST_TIMEOUT
The operation has timed out, please try after some time.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Compress PDF Operation.

cpf:inline
(object, required)

compressionLevel
(string, optional)
Specify the level of compression to reduce the file size of the pdf.

enum: HIGH, MEDIUM, LOW

required: ["cpf:inline"]


required: ["documentIn"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

documentOut
(object, required)
Contains the information about the file content part name and format of the output expected.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentOut"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:inputs": {
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    },
    "params": {
      "cpf:inline": {
        "compressionLevel": "MEDIUM"
      }
    }
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061"
  },
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200,
    "report": ""
  },
  "cpf:outputs": {
    "documentOut": {
      "cpf:location": "multipartLabelOut",
      "dc:format": "application/pdf"
    }
  }
}

<output_file_content_part>

The file part containing output file content. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOut.cpf:location field.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Compress PDF Operation.

cpf:inline
(object, required)

compressionLevel
(string, optional)
Specify the level of compression to reduce the file size of the pdf.

enum: HIGH, MEDIUM, LOW

required: ["cpf:inline"]


required: ["documentIn"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Compress PDF Operation.

cpf:inline
(object, required)

compressionLevel
(string, optional)
Specify the level of compression to reduce the file size of the pdf.

enum: HIGH, MEDIUM, LOW

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Compress PDF Operation.

cpf:inline
(object, required)

compressionLevel
(string, optional)
Specify the level of compression to reduce the file size of the pdf.

enum: HIGH, MEDIUM, LOW

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for Compress PDF Operation.

cpf:inline
(object, required)

compressionLevel
(string, optional)
Specify the level of compression to reduce the file size of the pdf.

enum: HIGH, MEDIUM, LOW

required: ["cpf:inline"]


required: ["documentIn"]

Example:

--Boundary_56042_623305933_1612191132581
Content-Type: application/json
Content-Disposition: form-data; name="contentAnalyzerResponse"
{
    "cpf:inputs": {
        "documentIn": {
            "dc:format": "application/pdf",
            "cpf:location": "multipartLabel"
        },
        "params": {
            "cpf:inline": {
                "compressionLevel": "MEDIUM"
            }
        }
    },
    "cpf:engine": {
        "repo:assetId": "urn:aaid:cpf:Service-f37d36f4e6724eed92149a8ff35ea061"
    },
    "cpf:status": {
        "completed": true,
        "type": "",
        "status": 200,
        "report": ""
    },
    "cpf:outputs": {
        "documentOut": {
            "cpf:location": "multipartLabelOut",
            "dc:format": "application/pdf"
        }
    }
}
--Boundary_56042_623305933_1612191132581
Content-Type: application/octet-stream
Content-Disposition: form-data; name="multipartLabelOut"
%PDF-1.6
%����
7 0 obj
<</Linearized 1/L 477587/O 9/E 207563/N 2/T 477328/H [
    416 144
]>>
endobj
--Boundary_56042_623305933_1612191132581

Export :

Convert a PDF File to a non-PDF File

Download Postman collection

Try Out With SDK

post exportPDF

Submit an Export PDF Job

Export a PDF file into a number of supported formats. By default Exporting to an image produces a zip archive containing one image per page. 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. To get the results of Exporting to image as non zip output, please set the outputType parameter to listOfPageImages and use documentOutList key in cpfOutputs.

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888 required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/pdf required: ["dc:format","cpf:location"] params (object, required) Parameter to specify output document target format cpf:inline (object, required) targetFormat (string, required) Target exported File Format enum: doc, docx, jpeg, png, pptx, xlsx, rtf outputType (string, optional) Applicable only in case of PDF to Image conversions. If it is set to zipOfPageImages then the response will be provided as a zip response in documentOut, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat in documentOutList. enum: listOfPageImages, zipOfPageImages required: ["targetFormat"] additionalProperties: false required: ["cpf:inline"] required: ["documentIn","params"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call ONE OF documentOut (object, optional) Contains the information about the file content part name and format of the output expected. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/msword application/vnd.openxmlformats-officedocument.wordprocessingml.document application/vnd.openxmlformats-officedocument.presentationml.presentation application/vnd.openxmlformats-officedocument.spreadsheetml.sheet application/zip text/rtf required: ["dc:format","cpf:location"] documentOutList (object, optional) List of resultant output PDF documents. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. In case of list output multiple files are expected so the part name for files will be like <output_file_content_part_name>index, here index can be 0,1,2... depending on the no. of files. dc:format (string, required) The expected format of the output: image/jpeg image/png required: ["dc:format","cpf:location"] oneOf: [ {"required":["documentOut"]}, {"required":["documentOutList"]} ] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888" }, "cpf:inputs": { "params": { "cpf:inline": { "targetFormat": "docx" } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } }, "cpf:outputs": { "documentOut": { "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "cpf:location": "multipartLabelOut" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Parameter to specify output document target format

cpf:inline
(object, required)

targetFormat
(string, required)
Target exported File Format

enum: doc, docx, jpeg, png, pptx, xlsx, rtf
outputType
(string, optional)
Applicable only in case of PDF to Image conversions. If it is set to zipOfPageImages then the response will be provided as a zip response in documentOut, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat in documentOutList.

enum: listOfPageImages, zipOfPageImages

required: ["targetFormat"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": false,
    "type": "",
    "title": "In Progress",
    "status": 202,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "targetFormat": "docx"
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  }
}

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Parameter to specify output document target format

cpf:inline
(object, required)

targetFormat
(string, required)
Target exported File Format

enum: doc, docx, jpeg, png, pptx, xlsx, rtf
outputType
(string, optional)
Applicable only in case of PDF to Image conversions. If it is set to zipOfPageImages then the response will be provided as a zip response in documentOut, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat in documentOutList.

enum: listOfPageImages, zipOfPageImages

required: ["targetFormat"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": true,
    "title": "Invalid I/O in the request. I/O name: documentOut I/O value: {\"sensei:multipart_field_name\":\"multipartLabelOut\",\"dc:format\":\"application/vnd.openxmlformats-officedocument.wordprocessingml.documentttt\"} dc:format not one of supported media types.",
    "status": 400,
    "report": "{\"error_code\":\"MEDIA_TYPE_UNSUPPORTED\"}"
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "targetFormat": "docx"
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Parameter to specify output document target format

cpf:inline
(object, required)

targetFormat
(string, required)
Target exported File Format

enum: doc, docx, jpeg, png, pptx, xlsx, rtf
outputType
(string, optional)
Applicable only in case of PDF to Image conversions. If it is set to zipOfPageImages then the response will be provided as a zip response in documentOut, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat in documentOutList.

enum: listOfPageImages, zipOfPageImages

required: ["targetFormat"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Parameter to specify output document target format

cpf:inline
(object, required)

targetFormat
(string, required)
Target exported File Format

enum: doc, docx, jpeg, png, pptx, xlsx, rtf
outputType
(string, optional)
Applicable only in case of PDF to Image conversions. If it is set to zipOfPageImages then the response will be provided as a zip response in documentOut, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat in documentOutList.

enum: listOfPageImages, zipOfPageImages

required: ["targetFormat"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Parameter to specify output document target format

cpf:inline
(object, required)

targetFormat
(string, required)
Target exported File Format

enum: doc, docx, jpeg, png, pptx, xlsx, rtf
outputType
(string, optional)
Applicable only in case of PDF to Image conversions. If it is set to zipOfPageImages then the response will be provided as a zip response in documentOut, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat in documentOutList.

enum: listOfPageImages, zipOfPageImages

required: ["targetFormat"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests="\"{
    \"cpf:inputs\": {
        \"params\": {
            \"cpf:inline\": {
                \"targetFormat\": \"docx\",
            }
        },
        \"documentIn\": {
            \"cpf:location\": \"InputFile0\",
            \"dc:format\": \"application/pdf\"
        }
    },
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888\"
    },
    \"cpf:outputs\": {
        \"documentOut\": {
            \"cpf:location\": \"multipartLabelOut\",
            \"dc:format\": \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\"
        }
    }
}\""' \
--form 'InputFile0="\"\"\"@\"{{Placeholder for input file (absolute path)}}\"\"\"\""'

get exportPDF.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
SOURCE_EMPTY
The input file is a zero length file.


400
REQUEST_TOO_LARGE
The input file is too large.


400
CORRUPT_DOCUMENT
For application/pdf mime-type The input file appears to be corrupted and cannot be processed.


400
PDF_ENCRYPTED
Source file is encrypted and cannot be processed.


400
PDF_PORTFOLIO
The input file appears to be corrupted and cannot be processed.


400
DOCUMENTOUTLIST_SUPPORTED_ONLY_FOR_PDFTOIMAGE
DocumentOutList is only supported for PDF To Image workflows.


400
DOCUMENTOUT_NOT_SUPPORTED_WITH_LIST_OUTPUT
DocumentOut is not supported with listOfPageImages.


400
DOCUMENTOUTLIST_NOT_SUPPORTED_WITH_ZIP_OUTPUT
DocumentOutList is not supported with zipOfPageImages.


500
INTERNAL_SERVER_ERROR
An Internal Server Error has occurred.


500
REQUEST_TIMEOUT
The operation has timed out, please try after some time.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Parameter to specify output document target format

cpf:inline
(object, required)

targetFormat
(string, required)
Target exported File Format

enum: doc, docx, jpeg, png, pptx, xlsx, rtf
outputType
(string, optional)
Applicable only in case of PDF to Image conversions. If it is set to zipOfPageImages then the response will be provided as a zip response in documentOut, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat in documentOutList.

enum: listOfPageImages, zipOfPageImages

required: ["targetFormat"]


required: ["cpf:inline"]


required: ["documentIn","params"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

ONE OF
documentOut
(object, optional)
Contains the information about the file content part name and format of the output expected.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/msword
application/vnd.openxmlformats-officedocument.wordprocessingml.document
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/zip
text/rtf


required: ["dc:format","cpf:location"]

documentOutList
(object, optional)
List of resultant output PDF documents.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file. In case of list output multiple files are expected so the part name for files will be like  <output_file_content_part_name>index, here index can be 0,1,2... depending on the no. of files.

dc:format
(string, required)
The expected format of the output: image/jpeg
image/png


required: ["dc:format","cpf:location"]


oneOf: [
  {"required":["documentOut"]},
  {"required":["documentOutList"]}
]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "targetFormat": "docx"
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888"
  },
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200,
    "report": ""
  },
  "cpf:outputs": {
    "documentOut": {
      "cpf:location": "multipartLabelOut",
      "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
    }
  }
}

<output_file_content_part>

The file part containing output file content. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOut.cpf:location field.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Parameter to specify output document target format

cpf:inline
(object, required)

targetFormat
(string, required)
Target exported File Format

enum: doc, docx, jpeg, png, pptx, xlsx, rtf
outputType
(string, optional)
Applicable only in case of PDF to Image conversions. If it is set to zipOfPageImages then the response will be provided as a zip response in documentOut, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat in documentOutList.

enum: listOfPageImages, zipOfPageImages

required: ["targetFormat"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Parameter to specify output document target format

cpf:inline
(object, required)

targetFormat
(string, required)
Target exported File Format

enum: doc, docx, jpeg, png, pptx, xlsx, rtf
outputType
(string, optional)
Applicable only in case of PDF to Image conversions. If it is set to zipOfPageImages then the response will be provided as a zip response in documentOut, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat in documentOutList.

enum: listOfPageImages, zipOfPageImages

required: ["targetFormat"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Parameter to specify output document target format

cpf:inline
(object, required)

targetFormat
(string, required)
Target exported File Format

enum: doc, docx, jpeg, png, pptx, xlsx, rtf
outputType
(string, optional)
Applicable only in case of PDF to Image conversions. If it is set to zipOfPageImages then the response will be provided as a zip response in documentOut, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat in documentOutList.

enum: listOfPageImages, zipOfPageImages

required: ["targetFormat"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Parameter to specify output document target format

cpf:inline
(object, required)

targetFormat
(string, required)
Target exported File Format

enum: doc, docx, jpeg, png, pptx, xlsx, rtf
outputType
(string, optional)
Applicable only in case of PDF to Image conversions. If it is set to zipOfPageImages then the response will be provided as a zip response in documentOut, otherwise if set as listOfPageImages the response will be provided as list of images as specified in the targetFormat in documentOutList.

enum: listOfPageImages, zipOfPageImages

required: ["targetFormat"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

--Boundary_55947_757547533_1612189970577 Content-Type: application/json Content-Disposition: form-data; name="contentAnalyzerResponse"

{ "cpf:inputs": { "params": { "cpf:inline": { "targetFormat": "docx" } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-26c7fda2890b44ad9a82714682e35888" }, "cpf:status": { "completed": true, "type": "", "status": 200, "report": "" }, "cpf:outputs": { "documentOut": { "cpf:location": "multipartLabelOut", "dc:format": "application/vnd.openxmlformats-officedocument.wordprocessingml.document" } } } --Boundary_55947_757547533_1612189970577 Content-Type: application/octet-stream Content-Disposition: form-data; name="multipartLabelOut"

PK�sAR��p�$Rtword/document.xmlUT --Boundary_55947_757547533_1612189970577

Linearize :

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

Download Postman collection

Try Out With SDK

post linearizePDF

Submit a Linearize PDF Job

Linearize a PDF Document to create a web-optimized PDF Document which supports incremental access in network environments.

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27 required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/pdf required: ["dc:format","cpf:location"] required: ["documentIn"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call documentOut (object, required) Contains the information about the file content part name and format of the output expected. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/pdf required: ["dc:format","cpf:location"] required: ["documentOut"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27" }, "cpf:inputs": { "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } }, "cpf:outputs": { "documentOut": { "dc:format": "application/pdf", "cpf:location": "multipartLabelOut" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": false,
    "type": "",
    "title": "In Progress",
    "status": 202,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27"
  },
  "cpf:inputs": {
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  }
}

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "I/O Validation error.",
    "title": "Required multipart field multipartLabelll not found in the request.",
    "status": 400,
    "report": "{\"error_code\":\"MULTIPART_FIELD_MISSING\"}"
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27"
  },
  "cpf:inputs": {
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabelll"
    }
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentIn"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests={
    \"cpf:inputs\": {
        \"documentIn\": {
            \"cpf:location\": \"InputFile0\",
            \"dc:format\": \"application/pdf\"
        }
    },
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27\"
    },
    \"cpf:outputs\": {
        \"documentOut\": {
            \"cpf:location\": \"multipartLabelOut\",
            \"dc:format\": \"application/pdf\"
        }
    }
}' \
--form 'InputFile0=@"{{Placeholder for input file (absolute path)}}"'

get linearizePDF.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
SOURCE_EMPTY
The input file is a zero length file.


400
REQUEST_TOO_LARGE
The input file is too large.


400
CORRUPT_DOCUMENT
For application/pdf mime-type The input file appears to be corrupted and cannot be processed.


400
PASSWORD_PROTECTED
Source file is protected and cannot be processed.


400
PDF_XFA_FORM
Source PDF is a XFA Form and cannot be processed..


400
PDF_CERTIFIED
Source PDF is certified and cannot be processed.


400
PDF_CERTIFICATE_ENCRYPTED
Source file is certificate encrypted and cannot be processed.


400
PDF_HAS_ATTACHMENTS
PDF document containing file attachments is not supported.


500
INTERNAL_SERVER_ERROR
An Internal Server Error has occurred.


500
REQUEST_TIMEOUT
The operation has timed out, please try after some time.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentIn"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

documentOut
(object, required)
Contains the information about the file content part name and format of the output expected.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentOut"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:inputs": {
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27"
  },
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200,
    "report": ""
  },
  "cpf:outputs": {
    "documentOut": {
      "cpf:location": "multipartLabelOut",
      "dc:format": "application/pdf"
    }
  }
}

<output_file_content_part>

The file part containing output file content. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOut.cpf:location field.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentIn"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentIn"]

Example:

--Boundary_56132_371931165_1612191628229
Content-Type: application/json
Content-Disposition: form-data; name="contentAnalyzerResponse"
{
    "cpf:inputs": {
        "documentIn": {
            "dc:format": "application/pdf",
            "cpf:location": "multipartLabel"
        }
    },
    "cpf:engine": {
        "repo:assetId": "urn:aaid:cpf:Service-e4d5f0b75e5d43ea9eaa187860772d27"
    },
    "cpf:status": {
        "completed": true,
        "type": "",
        "status": 200,
        "report": ""
    },
    "cpf:outputs": {
        "documentOut": {
            "cpf:location": "multipartLabelOut",
            "dc:format": "application/pdf"
        }
    }
}
--Boundary_56132_371931165_1612191628229
Content-Type: application/octet-stream
Content-Disposition: form-data; name="multipartLabelOut"
%PDF-1.7
%����
230 0 obj
<</Linearized 1/L 161410/O 232/E 152324/N 1/T 161072/H [
    546 204
]>>
endobj
--Boundary_56132_371931165_1612191628229

OCR :

Perform OCR on a PDF File

Download Postman collection

Try Out With SDK

post ocr

Submit an OCR Job

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

There are two types which produce a different result:

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

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/pdf required: ["dc:format","cpf:location"] params (object, optional) Parameters for converting PDF to a searchable PDF. cpf:inline (object, required) ocrLang (string, optional) Specifies the input language to be used for OCR. 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 ocrType (string, optional) Specifies OCR Type. default: searchable_image enum: searchable_image, searchable_image_exact additionalProperties: false required: ["cpf:inline"] required: ["documentIn"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call documentOut (object, required) Contains the information about the file content part name and format of the output expected. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/pdf required: ["dc:format","cpf:location"] required: ["documentOut"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b" }, "cpf:inputs": { "params": { "cpf:inline": { "ocrType": "searchable_image_exact", "ocrLang": "en-US" } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } }, "cpf:outputs": { "documentOut": { "dc:format": "application/pdf", "cpf:location": "multipartLabelOut" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Parameters for converting PDF to a searchable PDF.

cpf:inline
(object, required)

ocrLang
(string, optional)
Specifies the input language to be used for OCR.

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
ocrType
(string, optional)
Specifies OCR Type.

default: searchable_image
enum: searchable_image, searchable_image_exact

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": false,
    "type": "",
    "title": "In Progress",
    "status": 202,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "ocrType": "searchable_image_exact",
        "ocrLang": "en-US"
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  }
}

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Parameters for converting PDF to a searchable PDF.

cpf:inline
(object, required)

ocrLang
(string, optional)
Specifies the input language to be used for OCR.

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
ocrType
(string, optional)
Specifies OCR Type.

default: searchable_image
enum: searchable_image, searchable_image_exact

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{ "cpf:status": { "completed": true, "type": "I/O Validation Error.", "title": "Value for I/O object params does not match the required schema {\"default\":{},\"type\":\"object\",\"properties\":{\"ocrLang\":{\"description\":\"Specifies the input language to be used for OCR.\",\"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\"],\"type\":\"string\"},\"ocrType\":{\"description\":\"Specifies OCR Type.\",\"default\":\"searchable_image\",\"enum\":[\"searchable_image\",\"searchable_image_exact\"],\"type\":\"string\"}},\"additionalProperties\":false}.", "status": 400, "report": "{\"error_code\":\"IO_SCHEMA_MISMATCH\"}" }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b" }, "cpf:inputs": { "params": { "cpf:inline": { "ocrType": "searchable_image", "ocrLang": "en-xx" } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } } }

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Parameters for converting PDF to a searchable PDF.

cpf:inline
(object, required)

ocrLang
(string, optional)
Specifies the input language to be used for OCR.

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
ocrType
(string, optional)
Specifies OCR Type.

default: searchable_image
enum: searchable_image, searchable_image_exact

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Parameters for converting PDF to a searchable PDF.

cpf:inline
(object, required)

ocrLang
(string, optional)
Specifies the input language to be used for OCR.

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
ocrType
(string, optional)
Specifies OCR Type.

default: searchable_image
enum: searchable_image, searchable_image_exact

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Parameters for converting PDF to a searchable PDF.

cpf:inline
(object, required)

ocrLang
(string, optional)
Specifies the input language to be used for OCR.

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
ocrType
(string, optional)
Specifies OCR Type.

default: searchable_image
enum: searchable_image, searchable_image_exact

required: ["cpf:inline"]


required: ["documentIn"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests={
    \"cpf:inputs\": {
        \"params\": {
            \"cpf:inline\": {
                \"ocrLang\": \"en-US\",
                \"ocrType\": \"searchable_image\"
            }
        },
        \"documentIn\": {
            \"cpf:location\": \"InputFile0\",
            \"dc:format\": \"application/pdf\"
        }
    },
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b\"
    },
    \"cpf:outputs\": {
        \"documentOut\": {
            \"cpf:location\": \"multipartLabelOut\",
            \"dc:format\": \"application/pdf\"
        }
    }
}' \
--form 'InputFile0=@"{{Placeholder for input file (absolute path)}}"'

get ocr.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
SOURCE_EMPTY
The input file is a zero length file.


400
REQUEST_TOO_LARGE
The input file is too large.


400
CORRUPT_DOCUMENT
The input file appears to be corrupted and cannot be processed.


400
PASSWORD_PROTECTED
Source file is protected and cannot be processed.


400
PAGE_LIMIT_EXCEEDED
The number of pages allowed in a document for conversion exceeded.


400
PDF_ENCRYPTED
Source file is encrypted and cannot be processed.


500
INTERNAL_SERVER_ERROR
An Internal Server Error has occurred.


500
REQUEST_TIMEOUT
The operation has timed out, please try after some time.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Parameters for converting PDF to a searchable PDF.

cpf:inline
(object, required)

ocrLang
(string, optional)
Specifies the input language to be used for OCR.

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
ocrType
(string, optional)
Specifies OCR Type.

default: searchable_image
enum: searchable_image, searchable_image_exact

required: ["cpf:inline"]


required: ["documentIn"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

documentOut
(object, required)
Contains the information about the file content part name and format of the output expected.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentOut"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "ocrType": "searchable_image_exact",
        "ocrLang": "en-US"
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b"
  },
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200,
    "report": ""
  },
  "cpf:outputs": {
    "documentOut": {
      "cpf:location": "multipartLabelOut",
      "dc:format": "application/pdf"
    }
  }
}

<output_file_content_part>

The file part containing output file content. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOut.cpf:location field.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Parameters for converting PDF to a searchable PDF.

cpf:inline
(object, required)

ocrLang
(string, optional)
Specifies the input language to be used for OCR.

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
ocrType
(string, optional)
Specifies OCR Type.

default: searchable_image
enum: searchable_image, searchable_image_exact

required: ["cpf:inline"]


required: ["documentIn"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Parameters for converting PDF to a searchable PDF.

cpf:inline
(object, required)

ocrLang
(string, optional)
Specifies the input language to be used for OCR.

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
ocrType
(string, optional)
Specifies OCR Type.

default: searchable_image
enum: searchable_image, searchable_image_exact

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Parameters for converting PDF to a searchable PDF.

cpf:inline
(object, required)

ocrLang
(string, optional)
Specifies the input language to be used for OCR.

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
ocrType
(string, optional)
Specifies OCR Type.

default: searchable_image
enum: searchable_image, searchable_image_exact

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Parameters for converting PDF to a searchable PDF.

cpf:inline
(object, required)

ocrLang
(string, optional)
Specifies the input language to be used for OCR.

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
ocrType
(string, optional)
Specifies OCR Type.

default: searchable_image
enum: searchable_image, searchable_image_exact

required: ["cpf:inline"]


required: ["documentIn"]

Example:

--Boundary_17041_1849944425_1611579786624
Content-Type: application/json
Content-Disposition: form-data; name="contentAnalyzerResponse"
{
    "cpf:inputs": {
        "params": {
            "cpf:inline": {
                "ocrType": "searchable_image_exact",
                "ocrLang": "en-US"
            }
        },
        "documentIn": {
            "dc:format": "application/pdf",
            "cpf:location": "multipartLabel"
        }
    },
    "cpf:engine": {
        "repo:assetId": "urn:aaid:cpf:Service-7e6a5d2b6bb141d7832398076914a07b"
    },
    "cpf:status": {
        "completed": true,
        "type": "",
        "status": 200,
        "report": ""
    },
    "cpf:outputs": {
        "documentOut": {
            "cpf:location": "multipartLabelOut",
            "dc:format": "application/pdf"
        }
    }
}
--Boundary_17041_1849944425_1611579786624
Content-Type: application/octet-stream
Content-Disposition: form-data; name="multipartLabelOut"
%PDF-1.6
%����
57 0 obj
<</Linearized 1/L 612046/O 59/E 181534/N 4/T 611669/H [
    483 221
]>>
endobj
--Boundary_17041_1849944425_1611579786624

Page Manipulation :

Rotate and delete pages of a PDF File

Download Postman collection

Try Out With SDK

post pageManipulation

Submit a Page Manipulation Job

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.

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4 required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/pdf required: ["dc:format","cpf:location"] params (object, required) parameters to specify page actions. cpf:inline (object, required) pageActions (array, optional) A list of page actions to be performed on an input PDF document in a given order. [{ pageAction (object, required) An action to perform on pdf pages ONE OF delete (object, optional) pageRanges (array, required) Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document [{ ANY OF end (number, optional) End page index of this page range start (number, optional) Start page index of this page range additionalProperties: false anyOf: [ {"required":["start"]}, {"required":["end"]} ] }] required: ["pageRanges"] additionalProperties: false rotate (object, optional) angle (number, required) Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees. The valid rotation angles are: 90, 180, 270. enum: 90, 180, 270 pageRanges (array, required) Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document [{ ANY OF end (number, optional) End page index of this page range start (number, optional) Start page index of this page range additionalProperties: false anyOf: [ {"required":["start"]}, {"required":["end"]} ] }] required: ["angle","pageRanges"] additionalProperties: false additionalProperties: false oneOf: [ {"required":["rotate"]}, {"required":["delete"]} ] required: ["pageAction"] }] required: ["cpf:inline"] required: ["documentIn","params"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call documentOut (object, required) Contains the information about the file content part name and format of the output expected. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/pdf required: ["dc:format","cpf:location"] required: ["documentOut"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4" }, "cpf:inputs": { "params": { "cpf:inline": { "pageActions": [ { "pageAction": { "delete": { "pageRanges": [ { "start": 1, "end": 1 } ] } } }, { "pageAction": { "rotate": { "angle": 90, "pageRanges": [ { "start": 1 } ] } } } ] } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } }, "cpf:outputs": { "documentOut": { "dc:format": "application/pdf", "cpf:location": "multipartLabelOut" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
parameters to specify page actions.

cpf:inline
(object, required)

pageActions
(array, optional)
A list of page actions to be performed on an input PDF document in a given order.

[{
pageAction
(object, required)
An action to perform on pdf pages

ONE OF
delete
(object, optional)

pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["pageRanges"]

rotate
(object, optional)

angle
(number, required)
Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees.  The valid rotation angles are: 90, 180, 270.

enum: 90, 180, 270
pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["angle","pageRanges"]


oneOf: [
  {"required":["rotate"]},
  {"required":["delete"]}
]


required: ["pageAction"]
}]

required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": false,
    "type": "",
    "title": "In Progress",
    "status": 202,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "pageActions": [
          {
            "pageAction": {
              "delete": {
                "pageRanges": [
                  {
                    "start": 1,
                    "end": 1
                  }
                ]
              }
            }
          },
          {
            "pageAction": {
              "rotate": {
                "angle": 90,
                "pageRanges": [
                  {
                    "start": 1
                  }
                ]
              }
            }
          }
        ]
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  }
}

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
parameters to specify page actions.

cpf:inline
(object, required)

pageActions
(array, optional)
A list of page actions to be performed on an input PDF document in a given order.

[{
pageAction
(object, required)
An action to perform on pdf pages

ONE OF
delete
(object, optional)

pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["pageRanges"]

rotate
(object, optional)

angle
(number, required)
Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees.  The valid rotation angles are: 90, 180, 270.

enum: 90, 180, 270
pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["angle","pageRanges"]


oneOf: [
  {"required":["rotate"]},
  {"required":["delete"]}
]


required: ["pageAction"]
}]

required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "I/O Validation Error.",
    "title": "Value for I/O object params does not match the required schema {\"type\":\"object\",\"properties\":{\"pageActions\":{\"description\":\"A list of page actions to be performed on an input PDF document in a given order.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"pageAction\":{\"description\":\"An action to perform on pdf pages\",\"properties\":{\"rotate\":{\"type\":\"object\",\"properties\":{\"pageRanges\":{\"description\":\"Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document\",\"type\":\"array\",\"items\":{\"anyOf\":[{\"required\":[\"start\"]},{\"required\":[\"end\"]}],\"type\":\"object\",\"properties\":{\"start\":{\"description\":\"Start page index of this page range\",\"type\":\"number\"},\"end\":{\"description\":\"End page index of this page range\",\"type\":\"number\"}},\"additionalProperties\":false}},\"angle\":{\"description\":\"Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees.  The valid rotation angles are: 90, 180, 270.\",\"type\":\"number\",\"enum\":[90,180,270]}},\"required\":[\"angle\",\"pageRanges\"],\"additionalProperties\":false},\"delete\":{\"type\":\"object\",\"properties\":{\"pageRanges\":{\"description\":\"Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document\",\"type\":\"array\",\"items\":{\"anyOf\":[{\"required\":[\"start\"]},{\"required\":[\"end\"]}],\"type\":\"object\",\"properties\":{\"start\":{\"description\":\"Start page index of this page range\",\"type\":\"number\"},\"end\":{\"description\":\"End page index of this page range\",\"type\":\"number\"}},\"additionalProperties\":false}}},\"required\":[\"pageRanges\"],\"additionalProperties\":false}},\"additionalProperties\":false,\"oneOf\":[{\"required\":[\"rotate\"]},{\"required\":[\"delete\"]}]}},\"required\":[\"pageAction\"]},\"additionalProperties\":false}}}.",
    "status": 400,
    "report": "{\"error_code\":\"IO_SCHEMA_MISMATCH\"}"
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "pageActions": [
          {
            "pageAaction": {
              "delete": {
                "pageRanges": [
                  {
                    "start": 1,
                    "end": 1
                  }
                ]
              }
            }
          },
          {
            "pageAction": {
              "rotate": {
                "angle": 90,
                "pageRanges": [
                  {
                    "start": 1
                  }
                ]
              }
            }
          }
        ]
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
parameters to specify page actions.

cpf:inline
(object, required)

pageActions
(array, optional)
A list of page actions to be performed on an input PDF document in a given order.

[{
pageAction
(object, required)
An action to perform on pdf pages

ONE OF
delete
(object, optional)

pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["pageRanges"]

rotate
(object, optional)

angle
(number, required)
Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees.  The valid rotation angles are: 90, 180, 270.

enum: 90, 180, 270
pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["angle","pageRanges"]


oneOf: [
  {"required":["rotate"]},
  {"required":["delete"]}
]


required: ["pageAction"]
}]

required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
parameters to specify page actions.

cpf:inline
(object, required)

pageActions
(array, optional)
A list of page actions to be performed on an input PDF document in a given order.

[{
pageAction
(object, required)
An action to perform on pdf pages

ONE OF
delete
(object, optional)

pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["pageRanges"]

rotate
(object, optional)

angle
(number, required)
Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees.  The valid rotation angles are: 90, 180, 270.

enum: 90, 180, 270
pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["angle","pageRanges"]


oneOf: [
  {"required":["rotate"]},
  {"required":["delete"]}
]


required: ["pageAction"]
}]

required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
parameters to specify page actions.

cpf:inline
(object, required)

pageActions
(array, optional)
A list of page actions to be performed on an input PDF document in a given order.

[{
pageAction
(object, required)
An action to perform on pdf pages

ONE OF
delete
(object, optional)

pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["pageRanges"]

rotate
(object, optional)

angle
(number, required)
Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees.  The valid rotation angles are: 90, 180, 270.

enum: 90, 180, 270
pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["angle","pageRanges"]


oneOf: [
  {"required":["rotate"]},
  {"required":["delete"]}
]


required: ["pageAction"]
}]

required: ["cpf:inline"]


required: ["documentIn","params"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests={
    \"cpf:inputs\": {
        \"params\": {
            \"cpf:inline\": {
                \"pageActions\": [{
                    \"pageAction\": {
                        \"rotate\": {
                            \"pageRanges\": [{
                                \"start\": 1,
                                \"end\": 1
                            }],
                            \"angle\": 90
                        }
                    }
                }]
            }
        },
        \"documentIn\": {
            \"cpf:location\": \"InputFile0\",
            \"dc:format\": \"application/pdf\"
        }
    },
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4\"
    },
    \"cpf:outputs\": {
        \"documentOut\": {
            \"cpf:location\": \"cid:multipartLabelOut\",
            \"dc:format\": \"application/pdf\"
        }
    }
}' \
--form 'InputFile0=@"{{Placeholder for input file (absolute path)}}"'

get pageManipulation.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
SOURCE_EMPTY
The input file is a zero length file.


400
REQUEST_TOO_LARGE
The input file is too large.


400
CORRUPT_DOCUMENT
The input file appears to be corrupted and cannot be processed.


400
PASSWORD_PROTECTED
Source file is protected and cannot be processed.


400
PDF_XFA_FORM
Source PDF is a XFA Form and cannot be processed..


400
PDF_CERTIFIED
Source PDF is certified and cannot be processed.


400
PDF_HAS_ATTACHMENTS
PDF document containing file attachments is not supported.


400
DELETE_ALL_PAGES
Deleting all pages in an input document is not allowed.


400
INVALID_PAGE_ACTION
The page action specified is either invalid or missing.


400
INVALID_PAGE_RANGE
The page range specified is invalid. Either invalid range syntax, bad page references, or results in a PDF with too many pages relative to the input PDF(s).


500
INTERNAL_SERVER_ERROR
An Internal Server Error has occurred.


500
REQUEST_TIMEOUT
The operation has timed out, please try after some time.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
parameters to specify page actions.

cpf:inline
(object, required)

pageActions
(array, optional)
A list of page actions to be performed on an input PDF document in a given order.

[{
pageAction
(object, required)
An action to perform on pdf pages

ONE OF
delete
(object, optional)

pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["pageRanges"]

rotate
(object, optional)

angle
(number, required)
Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees.  The valid rotation angles are: 90, 180, 270.

enum: 90, 180, 270
pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["angle","pageRanges"]


oneOf: [
  {"required":["rotate"]},
  {"required":["delete"]}
]


required: ["pageAction"]
}]

required: ["cpf:inline"]


required: ["documentIn","params"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

documentOut
(object, required)
Contains the information about the file content part name and format of the output expected.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentOut"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "pageActions": [
          {
            "pageAction": {
              "delete": {
                "pageRanges": [
                  {
                    "start": 1,
                    "end": 1
                  }
                ]
              }
            }
          },
          {
            "pageAction": {
              "rotate": {
                "angle": 90,
                "pageRanges": [
                  {
                    "start": 1
                  }
                ]
              }
            }
          }
        ]
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  },
  "cpf:outputs": {
    "documentOut": {
      "cpf:location": "multipartLabelOut",
      "dc:format": "application/pdf"
    }
  }
}

<output_file_content_part>

The file part containing output file content. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOut.cpf:location field.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
parameters to specify page actions.

cpf:inline
(object, required)

pageActions
(array, optional)
A list of page actions to be performed on an input PDF document in a given order.

[{
pageAction
(object, required)
An action to perform on pdf pages

ONE OF
delete
(object, optional)

pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["pageRanges"]

rotate
(object, optional)

angle
(number, required)
Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees.  The valid rotation angles are: 90, 180, 270.

enum: 90, 180, 270
pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["angle","pageRanges"]


oneOf: [
  {"required":["rotate"]},
  {"required":["delete"]}
]


required: ["pageAction"]
}]

required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
parameters to specify page actions.

cpf:inline
(object, required)

pageActions
(array, optional)
A list of page actions to be performed on an input PDF document in a given order.

[{
pageAction
(object, required)
An action to perform on pdf pages

ONE OF
delete
(object, optional)

pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["pageRanges"]

rotate
(object, optional)

angle
(number, required)
Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees.  The valid rotation angles are: 90, 180, 270.

enum: 90, 180, 270
pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["angle","pageRanges"]


oneOf: [
  {"required":["rotate"]},
  {"required":["delete"]}
]


required: ["pageAction"]
}]

required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
parameters to specify page actions.

cpf:inline
(object, required)

pageActions
(array, optional)
A list of page actions to be performed on an input PDF document in a given order.

[{
pageAction
(object, required)
An action to perform on pdf pages

ONE OF
delete
(object, optional)

pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["pageRanges"]

rotate
(object, optional)

angle
(number, required)
Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees.  The valid rotation angles are: 90, 180, 270.

enum: 90, 180, 270
pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["angle","pageRanges"]


oneOf: [
  {"required":["rotate"]},
  {"required":["delete"]}
]


required: ["pageAction"]
}]

required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
parameters to specify page actions.

cpf:inline
(object, required)

pageActions
(array, optional)
A list of page actions to be performed on an input PDF document in a given order.

[{
pageAction
(object, required)
An action to perform on pdf pages

ONE OF
delete
(object, optional)

pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["pageRanges"]

rotate
(object, optional)

angle
(number, required)
Required for 'rotate' cmd. It specifies the clockwise rotation angle relative to the starting orientation of the page. e.g. if a page is already rotated 90 degrees (landscape), specifying a rotation of 90 degrees will rotate it a further 90 degrees.  The valid rotation angles are: 90, 180, 270.

enum: 90, 180, 270
pageRanges
(array, required)
Page ranges of a PDF file. Pages in a document can be can be referred in any order, either from the start or end. For e.g.: For a file containing 10 pages, page number 1 can be referred using 1 or -10, page number 10 can be referred using 10 or -1. For performing an operation on the last page, we can provide a range as -1:-1. A page range provided is relative to the input document

[{
ANY OF
end
(number, optional)
End page index of this page range

start
(number, optional)
Start page index of this page range


anyOf: [
  {"required":["start"]},
  {"required":["end"]}
]
}]

required: ["angle","pageRanges"]


oneOf: [
  {"required":["rotate"]},
  {"required":["delete"]}
]


required: ["pageAction"]
}]

required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

--Boundary_55448_1966704134_1612184524899
Content-Type: application/json
Content-Disposition: form-data; name="contentAnalyzerResponse"
{
    "cpf:inputs": {
        "params": {
            "cpf:inline": {
                "pageActions": [
                    {
                        "pageAction": {
                            "delete": {
                                "pageRanges": [
                                    {
                                        "start": 1,
                                        "end": 1
                                    }
                                ]
                            }
                        }
                    },
                    {
                        "pageAction": {
                            "rotate": {
                                "angle": 90,
                                "pageRanges": [
                                    {
                                        "start": 1
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        },
        "documentIn": {
            "dc:format": "application/pdf",
            "cpf:location": "multipartLabel"
        }
    },
    "cpf:engine": {
        "repo:assetId": "urn:aaid:cpf:Service-4735fcf3cf924b25879e6fcf7aa84ad4"
    },
    "cpf:status": {
        "completed": true,
        "type": "",
        "status": 200,
        "report": ""
    },
    "cpf:outputs": {
        "documentOut": {
            "cpf:location": "multipartLabelOut",
            "dc:format": "application/pdf"
        }
    }
}
--Boundary_55448_1966704134_1612184524899
Content-Type: application/octet-stream
Content-Disposition: form-data; name="multipartLabelOut"
%PDF-1.7
%����
92 0 obj
<</Linearized 1/L 41554/O 94/E 34155/N 1/T 41240/H [
    486 187
]>>
endobj
--Boundary_55448_1966704134_1612184524899

PDF Properties :

Extract basic information about a PDF document.

Download Postman collection

Try Out With SDK

post pdfProperties

Submit a PDF Properties Job

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.

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:fd9b06fe2f164df7975254581d6ab00e required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/pdf required: ["dc:format","cpf:location"] params (object, optional) Params for fetching properties of a PDF cpf:inline (object, required) pageLevel (boolean, optional) To get page level properties of the PDF default: false required: ["cpf:inline"] required: ["documentIn"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call metadata (object, required) Contains the information about the file content part name and format of the extracted PDF Elements Info cpf:location (string, required) The expected <json_output_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/json required: ["dc:format","cpf:location"] required: ["metadata"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-fd9b06fe2f164df7975254581d6ab00e" }, "cpf:inputs": { "params": { "cpf:inline": { "pageLevel": true } }, "documentIn": { "cpf:location": "InputFile0", "dc:format": "application/pdf" } }, "cpf:outputs": { "metadata": { "dc:format": "application/json", "cpf:location": "jsonoutput" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:fd9b06fe2f164df7975254581d6ab00e 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for fetching properties of a PDF

cpf:inline
(object, required)

pageLevel
(boolean, optional)
To get page level properties of the PDF

default: false

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": false,
    "type": "",
    "title": "In Progress",
    "status": 202
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-fd9b06fe2f164df7975254581d6ab00e"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "pageLevel": true
      }
    },
    "documentIn": {
      "cpf:location": "InputFile0",
      "dc:format": "application/pdf"
    }
  }
}

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:fd9b06fe2f164df7975254581d6ab00e 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for fetching properties of a PDF

cpf:inline
(object, required)

pageLevel
(boolean, optional)
To get page level properties of the PDF

default: false

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "I/O Validation Error.",
    "title": "Value for I/O object params does not match the required schema {\"default\":{},\"type\":\"object\",\"properties\":{\"pageLevel\":{\"description\":\"To get page level metadata of the PDF\",\"default\":false,\"type\":\"boolean\"}}}.",
    "status": 400,
    "report": "{\"error_code\":\"IO_SCHEMA_MISMATCH\"}"
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-fd9b06fe2f164df7975254581d6ab00e"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "pageLevel": ""
      }
    },
    "documentIn": {
      "cpf:location": "InputFile0",
      "dc:format": "application/pdf"
    }
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:fd9b06fe2f164df7975254581d6ab00e 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for fetching properties of a PDF

cpf:inline
(object, required)

pageLevel
(boolean, optional)
To get page level properties of the PDF

default: false

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:fd9b06fe2f164df7975254581d6ab00e 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for fetching properties of a PDF

cpf:inline
(object, required)

pageLevel
(boolean, optional)
To get page level properties of the PDF

default: false

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:fd9b06fe2f164df7975254581d6ab00e 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for fetching properties of a PDF

cpf:inline
(object, required)

pageLevel
(boolean, optional)
To get page level properties of the PDF

default: false

required: ["cpf:inline"]


required: ["documentIn"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'Accept: application/json, text/plain, /' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests="{
  \"cpf:inputs\": {
    \"params\": {
      \"cpf:inline\": {
        \"pageLevel\": true
      }
    },
    \"documentIn\": {
      \"cpf:location\": \"InputFile0\",
      \"dc:format\": \"application/pdf\"
    }
  },
  \"cpf:engine\": {
    \"repo:assetId\": \"urn:aaid:cpf:Service-fd9b06fe2f164df7975254581d6ab00e\"
  },
  \"cpf:outputs\": {
    \"metadata\": {
      \"dc:format\": \"application/json\",
      \"cpf:location\": \"jsonoutput\"
    }
  }
}"' \
--form 'InputFile0=@"{{Placeholder for input file (absolute path)}}"'

get pdfProperties.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:fd9b06fe2f164df7975254581d6ab00e 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The object containing the error_code field. error_code is the Mnemoic returned by service in case of any failure


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for fetching properties of a PDF

cpf:inline
(object, required)

pageLevel
(boolean, optional)
To get page level properties of the PDF

default: false

required: ["cpf:inline"]


required: ["documentIn"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

metadata
(object, required)
Contains the information about the file content part name and format of the extracted PDF Elements Info

cpf:location
(string, required)
The expected <json_output_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/json


required: ["dc:format","cpf:location"]


required: ["metadata"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-fd9b06fe2f164df7975254581d6ab00e"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "pageLevel": true
      }
    },
    "documentIn": {
      "cpf:location": "InputFile0",
      "dc:format": "application/pdf"
    }
  },
  "cpf:outputs": {
    "metadata": {
      "cpf:location": "jsonoutput",
      "dc:format": "application/json"
    }
  }
}

<json_output_part>

Extracted text elements info with styling info and Bounding boxes if requested.

See the JSON schema for a description of the default output. (Please refer the Styling JSON schema for a description of the output when the styling option is enabled.).

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:fd9b06fe2f164df7975254581d6ab00e 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for fetching properties of a PDF

cpf:inline
(object, required)

pageLevel
(boolean, optional)
To get page level properties of the PDF

default: false

required: ["cpf:inline"]


required: ["documentIn"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:fd9b06fe2f164df7975254581d6ab00e 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for fetching properties of a PDF

cpf:inline
(object, required)

pageLevel
(boolean, optional)
To get page level properties of the PDF

default: false

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:fd9b06fe2f164df7975254581d6ab00e 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for fetching properties of a PDF

cpf:inline
(object, required)

pageLevel
(boolean, optional)
To get page level properties of the PDF

default: false

required: ["cpf:inline"]


required: ["documentIn"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:fd9b06fe2f164df7975254581d6ab00e 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, optional)
Params for fetching properties of a PDF

cpf:inline
(object, required)

pageLevel
(boolean, optional)
To get page level properties of the PDF

default: false

required: ["cpf:inline"]


required: ["documentIn"]

Example:

--Boundary_3278_1105148963_1631020312527 Content-Type: application/json Content-Disposition: form-data; name="contentAnalyzerResponse" { "cpf:inputs": { "params": { "cpf:inline": { "pageLevel": true } }, "documentIn": { "cpf:location": "InputFile0", "dc:format": "application/pdf" } }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-fd9b06fe2f164df7975254581d6ab00e" }, "cpf:status": { "completed": true, "type": "", "status": 200 }, "cpf:outputs": { "metadata": { "cpf:location": "file", "dc:format": "application/json" } } } --Boundary_3278_1105148963_1631020312527 Content-Type: application/json Content-Disposition: form-data; name="jsonoutput" { "pages": [ { "page_number": 0, "is_scanned": false, "width": 612, "has_structure": false, "content": { "number_of_images": 0, "only_images": false, "has_text": true, "has_images": false, "is_empty": false }, "height": 792 } ], "document": { "is_linearized": false, "pdfe_compliance_level": "", "is_tagged": false, "is_portfolio": false, "is_certified": false, "is_encrypted": false, "info_dict": { "CreationDate": "D:19980204171401Z", "Producer": "Acrobat Distiller 3.0 for Windows" }, "is_FTPDF": false, "pdf_version": "1.2", "has_acroform": false, "file_size": "4.2 KB", "is_signed": false, "incremental_save_count": 0, "has_embedded_files": false, "is_XFA": false, "fonts": [ { "name": "Times-Roman", "font_type": "Type1", "family_name": "Titlingmes" }, { "name": "Courier", "font_type": "Type1", "family_name": "Courier" }, { "name": "Courier-Bold", "font_type": "Type1", "family_name": "Courier" } ], "pdfa_compliance_level": "", "pdfvt_compliance_level": "", "pdfx_compliance_level": "", "pdfua_compliance_level": "", "XMP": "", "page_count": 1 } } --Boundary_3278_1105148963_1631020312527--

Protect :

Add encryption and/or restrict permissions on a PDF File

Download Postman collection

Try Out With SDK

post protectPDF

Submit a Protect PDF Job

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.

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5 required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/pdf required: ["dc:format","cpf:location"] params (object, required) Params for encrypting a PDF document. cpf:inline (object, required) passwordProtection (object, required) 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. ANY OF userPassword (string, optional) Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers. ownerPassword (string, optional) Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document. anyOf: [ {"required":["userPassword"]}, {"required":["ownerPassword"]} ] encryptionAlgorithm (string, required) 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. enum: AES_128, AES_256 contentToEncrypt (string, optional) Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective. enum: ALL_CONTENT, ALL_CONTENT_EXCEPT_METADATA, ONLY_EMBEDDED_FILES default: ALL_CONTENT permissions (array, optional) 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. [ string : enum: PRINT_LOW_QUALITY, PRINT_HIGH_QUALITY, EDIT_CONTENT, EDIT_FILL_AND_SIGN_FORM_FIELDS, EDIT_ANNOTATIONS, EDIT_DOCUMENT_ASSEMBLY, COPY_CONTENT ] required: [ "passwordProtection", "encryptionAlgorithm" ] required: ["cpf:inline"] required: ["documentIn","params"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call documentOut (object, required) Contains the information about the file content part name and format of the output expected. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/pdf required: ["dc:format","cpf:location"] required: ["documentOut"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5" }, "cpf:inputs": { "params": { "cpf:inline": { "passwordProtection": { "userPassword": "123", "ownerPassword": "321" }, "contentToEncrypt": "ALL_CONTENT_EXCEPT_METADATA", "encryptionAlgorithm": "AES_128", "permissions": [ "PRINT_LOW_QUALITY", "PRINT_HIGH_QUALITY", "EDIT_CONTENT", "EDIT_FILL_AND_SIGN_FORM_FIELDS", "EDIT_ANNOTATIONS", "EDIT_DOCUMENT_ASSEMBLY", "COPY_CONTENT" ] } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } }, "cpf:outputs": { "documentOut": { "dc:format": "application/pdf", "cpf:location": "multipartLabelOut" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for encrypting a PDF document.

cpf:inline
(object, required)

passwordProtection
(object, required)
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.

ANY OF
userPassword
(string, optional)
Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.

ownerPassword
(string, optional)
Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.


anyOf: [
  {"required":["userPassword"]},
  {"required":["ownerPassword"]}
]

encryptionAlgorithm
(string, required)
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.

enum: AES_128, AES_256
contentToEncrypt
(string, optional)
Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.

enum: ALL_CONTENT, ALL_CONTENT_EXCEPT_METADATA, ONLY_EMBEDDED_FILES
default: ALL_CONTENT
permissions
(array, optional)
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.

[
string
: 
enum: PRINT_LOW_QUALITY, PRINT_HIGH_QUALITY, EDIT_CONTENT, EDIT_FILL_AND_SIGN_FORM_FIELDS, EDIT_ANNOTATIONS, EDIT_DOCUMENT_ASSEMBLY, COPY_CONTENT
]

required: [
  "passwordProtection",
  "encryptionAlgorithm"
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{ "cpf:status": { "completed": false, "type": "", "title": "In Progress", "status": 202, "report": "" }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5" }, "cpf:inputs": { "params": { "cpf:inline": { "passwordProtection": { "userPassword": "123", "ownerPassword": "321" }, "contentToEncrypt": "ALL_CONTENT_EXCEPT_METADATA", "encryptionAlgorithm": "AES_128", "permissions": [ "PRINT_LOW_QUALITY", "PRINT_HIGH_QUALITY", "EDIT_CONTENT", "EDIT_FILL_AND_SIGN_FORM_FIELDS", "EDIT_ANNOTATIONS", "EDIT_DOCUMENT_ASSEMBLY", "COPY_CONTENT" ] } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } } }

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for encrypting a PDF document.

cpf:inline
(object, required)

passwordProtection
(object, required)
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.

ANY OF
userPassword
(string, optional)
Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.

ownerPassword
(string, optional)
Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.


anyOf: [
  {"required":["userPassword"]},
  {"required":["ownerPassword"]}
]

encryptionAlgorithm
(string, required)
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.

enum: AES_128, AES_256
contentToEncrypt
(string, optional)
Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.

enum: ALL_CONTENT, ALL_CONTENT_EXCEPT_METADATA, ONLY_EMBEDDED_FILES
default: ALL_CONTENT
permissions
(array, optional)
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.

[
string
: 
enum: PRINT_LOW_QUALITY, PRINT_HIGH_QUALITY, EDIT_CONTENT, EDIT_FILL_AND_SIGN_FORM_FIELDS, EDIT_ANNOTATIONS, EDIT_DOCUMENT_ASSEMBLY, COPY_CONTENT
]

required: [
  "passwordProtection",
  "encryptionAlgorithm"
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{ "cpf:status": { "completed": true, "type": "I/O Validation Error.", "title": "Value for I/O object params does not match the required schema {\"type\":\"object\",\"properties\":{\"passwordProtection\":{\"description\":\"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.\",\"anyOf\":[{\"required\":[\"userPassword\"]},{\"required\":[\"ownerPassword\"]}],\"type\":\"object\",\"properties\":{\"ownerPassword\":{\"description\":\"Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.\",\"type\":\"string\"},\"userPassword\":{\"description\":\"Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.\",\"type\":\"string\"}}},\"permissions\":{\"description\":\"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.\",\"type\":\"array\",\"items\":{\"enum\":[\"PRINT_LOW_QUALITY\",\"PRINT_HIGH_QUALITY\",\"EDIT_CONTENT\",\"EDIT_FILL_AND_SIGN_FORM_FIELDS\",\"EDIT_ANNOTATIONS\",\"EDIT_DOCUMENT_ASSEMBLY\",\"COPY_CONTENT\"],\"type\":\"string\"}},\"contentToEncrypt\":{\"description\":\"Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.\",\"default\":\"ALL_CONTENT\",\"enum\":[\"ALL_CONTENT\",\"ALL_CONTENT_EXCEPT_METADATA\",\"ONLY_EMBEDDED_FILES\"],\"type\":\"string\"},\"encryptionAlgorithm\":{\"description\":\"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.\",\"type\":\"string\",\"enum\":[\"AES_128\",\"AES_256\"]}},\"required\":[\"passwordProtection\",\"encryptionAlgorithm\"]}.", "status": 400, "report": "{\"error_code\":\"IO_SCHEMA_MISMATCH\"}" }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5" }, "cpf:inputs": { "params": { "cpf:inline": { "passwordProtection": { "userPassword": "123", "ownerPassword": "321" }, "contentToEncrypt": "ALL_CONTENT_EXCEPT_METADATAA", "encryptionAlgorithm": "AES_128", "permissions": [ "PRINT_LOW_QUALITY", "PRINT_HIGH_QUALITY", "EDIT_CONTENT", "EDIT_FILL_AND_SIGN_FORM_FIELDS", "EDIT_ANNOTATIONS", "EDIT_DOCUMENT_ASSEMBLY", "COPY_CONTENT" ] } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } } }

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for encrypting a PDF document.

cpf:inline
(object, required)

passwordProtection
(object, required)
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.

ANY OF
userPassword
(string, optional)
Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.

ownerPassword
(string, optional)
Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.


anyOf: [
  {"required":["userPassword"]},
  {"required":["ownerPassword"]}
]

encryptionAlgorithm
(string, required)
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.

enum: AES_128, AES_256
contentToEncrypt
(string, optional)
Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.

enum: ALL_CONTENT, ALL_CONTENT_EXCEPT_METADATA, ONLY_EMBEDDED_FILES
default: ALL_CONTENT
permissions
(array, optional)
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.

[
string
: 
enum: PRINT_LOW_QUALITY, PRINT_HIGH_QUALITY, EDIT_CONTENT, EDIT_FILL_AND_SIGN_FORM_FIELDS, EDIT_ANNOTATIONS, EDIT_DOCUMENT_ASSEMBLY, COPY_CONTENT
]

required: [
  "passwordProtection",
  "encryptionAlgorithm"
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for encrypting a PDF document.

cpf:inline
(object, required)

passwordProtection
(object, required)
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.

ANY OF
userPassword
(string, optional)
Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.

ownerPassword
(string, optional)
Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.


anyOf: [
  {"required":["userPassword"]},
  {"required":["ownerPassword"]}
]

encryptionAlgorithm
(string, required)
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.

enum: AES_128, AES_256
contentToEncrypt
(string, optional)
Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.

enum: ALL_CONTENT, ALL_CONTENT_EXCEPT_METADATA, ONLY_EMBEDDED_FILES
default: ALL_CONTENT
permissions
(array, optional)
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.

[
string
: 
enum: PRINT_LOW_QUALITY, PRINT_HIGH_QUALITY, EDIT_CONTENT, EDIT_FILL_AND_SIGN_FORM_FIELDS, EDIT_ANNOTATIONS, EDIT_DOCUMENT_ASSEMBLY, COPY_CONTENT
]

required: [
  "passwordProtection",
  "encryptionAlgorithm"
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for encrypting a PDF document.

cpf:inline
(object, required)

passwordProtection
(object, required)
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.

ANY OF
userPassword
(string, optional)
Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.

ownerPassword
(string, optional)
Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.


anyOf: [
  {"required":["userPassword"]},
  {"required":["ownerPassword"]}
]

encryptionAlgorithm
(string, required)
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.

enum: AES_128, AES_256
contentToEncrypt
(string, optional)
Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.

enum: ALL_CONTENT, ALL_CONTENT_EXCEPT_METADATA, ONLY_EMBEDDED_FILES
default: ALL_CONTENT
permissions
(array, optional)
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.

[
string
: 
enum: PRINT_LOW_QUALITY, PRINT_HIGH_QUALITY, EDIT_CONTENT, EDIT_FILL_AND_SIGN_FORM_FIELDS, EDIT_ANNOTATIONS, EDIT_DOCUMENT_ASSEMBLY, COPY_CONTENT
]

required: [
  "passwordProtection",
  "encryptionAlgorithm"
]


required: ["cpf:inline"]


required: ["documentIn","params"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests={
    \"cpf:inputs\": {
        \"params\": {
            \"cpf:inline\": {
                \"passwordProtection\": {
                    \"userPassword\": \"user_password\",
                    \"ownerPassword\": \"owner_password\"
                },
                \"permissions\": [\"PRINT_LOW_QUALITY\", \"PRINT_HIGH_QUALITY\", \"EDIT_CONTENT\", \"EDIT_FILL_AND_SIGN_FORM_FIELDS\", \"EDIT_ANNOTATIONS\", \"EDIT_DOCUMENT_ASSEMBLY\", \"COPY_CONTENT\"],
                \"contentToEncrypt\": \"ALL_CONTENT_EXCEPT_METADATA\",
                \"encryptionAlgorithm\": \"AES_128\"
            }
        },
        \"documentIn\": {
            \"cpf:location\": \"InputFile0\",
            \"dc:format\": \"application/pdf\"
        }
    },
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5\"
    },
    \"cpf:outputs\": {
        \"documentOut\": {
            \"cpf:location\": \"multipartLabelOut\",
            \"dc:format\": \"application/pdf\"
        }
    }
}' \
--form 'InputFile0=@"{{Placeholder for input file (absolute path)}}"'

get protectPDF.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
SOURCE_EMPTY
The input file is a zero length file.


400
REQUEST_TOO_LARGE
The input file is too large.


400
CORRUPT_DOCUMENT
The input file appears to be corrupted and cannot be processed.


400
PASSWORD_PROTECTED
Source file is protected and cannot be processed.


400
PDF_XFA_FORM
Source PDF is a XFA Form and cannot be processed..


400
PDF_CERTIFIED
Source PDF is certified and cannot be processed.


400
PDF_CERTIFICATE_ENCRYPTED
Source file is certificate encrypted and cannot be processed.


400
PDF_HAS_ATTACHMENTS
PDF document containing file attachments is not supported.


400
PDF_SIGNED
Source PDF is signed and cannot be processed.


400
OWNER_PASSWORD_NULL_OR_EMPTY
Owner Password cannot be null or empty.


400
USER_PASSWORD_NULL_OR_EMPTY
User Password cannot be null or empty.


400
INVALID_PASSWORD_ENCODING
Owner Password supports LATIN-1 characters only.


400
INVALID_CONTENT_TO_ENCRYPT
Provided content type to encrypt is not supported.


400
OWNER_PASSWORD_REQUIRED
Owner password is required for setting access permissions on the input document.


400
OWNER_PASSWORD_LENGTH_EXCEEDED
Owner password too long.


400
USER_PASSWORD_LENGTH_EXCEEDED
User password too long.


400
SAME_USER_OWNER_PASSWORD
User and owner password can not be same.


500
INTERNAL_SERVER_ERROR
An Internal Server Error has occurred.


500
REQUEST_TIMEOUT
The operation has timed out, please try after some time.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for encrypting a PDF document.

cpf:inline
(object, required)

passwordProtection
(object, required)
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.

ANY OF
userPassword
(string, optional)
Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.

ownerPassword
(string, optional)
Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.


anyOf: [
  {"required":["userPassword"]},
  {"required":["ownerPassword"]}
]

encryptionAlgorithm
(string, required)
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.

enum: AES_128, AES_256
contentToEncrypt
(string, optional)
Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.

enum: ALL_CONTENT, ALL_CONTENT_EXCEPT_METADATA, ONLY_EMBEDDED_FILES
default: ALL_CONTENT
permissions
(array, optional)
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.

[
string
: 
enum: PRINT_LOW_QUALITY, PRINT_HIGH_QUALITY, EDIT_CONTENT, EDIT_FILL_AND_SIGN_FORM_FIELDS, EDIT_ANNOTATIONS, EDIT_DOCUMENT_ASSEMBLY, COPY_CONTENT
]

required: [
  "passwordProtection",
  "encryptionAlgorithm"
]


required: ["cpf:inline"]


required: ["documentIn","params"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

documentOut
(object, required)
Contains the information about the file content part name and format of the output expected.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentOut"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{ "cpf:status": { "completed": true, "type": "", "status": 200, "report": "" }, "cpf:inputs": { "params": { "cpf:inline": { "passwordProtection": { "userPassword": "123", "ownerPassword": "321" }, "contentToEncrypt": "ALL_CONTENT_EXCEPT_METADATA", "encryptionAlgorithm": "AES_128", "permissions": [ "PRINT_LOW_QUALITY", "PRINT_HIGH_QUALITY", "EDIT_CONTENT", "EDIT_FILL_AND_SIGN_FORM_FIELDS", "EDIT_ANNOTATIONS", "EDIT_DOCUMENT_ASSEMBLY", "COPY_CONTENT" ] } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5" }, "cpf:outputs": { "documentOut": { "cpf:location": "multipartLabelOut", "dc:format": "application/pdf" } } }

<output_file_content_part>

The file part containing output file content. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOut.cpf:location field.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for encrypting a PDF document.

cpf:inline
(object, required)

passwordProtection
(object, required)
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.

ANY OF
userPassword
(string, optional)
Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.

ownerPassword
(string, optional)
Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.


anyOf: [
  {"required":["userPassword"]},
  {"required":["ownerPassword"]}
]

encryptionAlgorithm
(string, required)
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.

enum: AES_128, AES_256
contentToEncrypt
(string, optional)
Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.

enum: ALL_CONTENT, ALL_CONTENT_EXCEPT_METADATA, ONLY_EMBEDDED_FILES
default: ALL_CONTENT
permissions
(array, optional)
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.

[
string
: 
enum: PRINT_LOW_QUALITY, PRINT_HIGH_QUALITY, EDIT_CONTENT, EDIT_FILL_AND_SIGN_FORM_FIELDS, EDIT_ANNOTATIONS, EDIT_DOCUMENT_ASSEMBLY, COPY_CONTENT
]

required: [
  "passwordProtection",
  "encryptionAlgorithm"
]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for encrypting a PDF document.

cpf:inline
(object, required)

passwordProtection
(object, required)
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.

ANY OF
userPassword
(string, optional)
Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.

ownerPassword
(string, optional)
Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.


anyOf: [
  {"required":["userPassword"]},
  {"required":["ownerPassword"]}
]

encryptionAlgorithm
(string, required)
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.

enum: AES_128, AES_256
contentToEncrypt
(string, optional)
Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.

enum: ALL_CONTENT, ALL_CONTENT_EXCEPT_METADATA, ONLY_EMBEDDED_FILES
default: ALL_CONTENT
permissions
(array, optional)
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.

[
string
: 
enum: PRINT_LOW_QUALITY, PRINT_HIGH_QUALITY, EDIT_CONTENT, EDIT_FILL_AND_SIGN_FORM_FIELDS, EDIT_ANNOTATIONS, EDIT_DOCUMENT_ASSEMBLY, COPY_CONTENT
]

required: [
  "passwordProtection",
  "encryptionAlgorithm"
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for encrypting a PDF document.

cpf:inline
(object, required)

passwordProtection
(object, required)
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.

ANY OF
userPassword
(string, optional)
Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.

ownerPassword
(string, optional)
Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.


anyOf: [
  {"required":["userPassword"]},
  {"required":["ownerPassword"]}
]

encryptionAlgorithm
(string, required)
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.

enum: AES_128, AES_256
contentToEncrypt
(string, optional)
Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.

enum: ALL_CONTENT, ALL_CONTENT_EXCEPT_METADATA, ONLY_EMBEDDED_FILES
default: ALL_CONTENT
permissions
(array, optional)
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.

[
string
: 
enum: PRINT_LOW_QUALITY, PRINT_HIGH_QUALITY, EDIT_CONTENT, EDIT_FILL_AND_SIGN_FORM_FIELDS, EDIT_ANNOTATIONS, EDIT_DOCUMENT_ASSEMBLY, COPY_CONTENT
]

required: [
  "passwordProtection",
  "encryptionAlgorithm"
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for encrypting a PDF document.

cpf:inline
(object, required)

passwordProtection
(object, required)
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.

ANY OF
userPassword
(string, optional)
Password used to control opening of an encrypted PDF document. When this property is included and non-empty, the use of a password (either this one or, if specified, the owner password) is necessary to open/view the document. If this password is empty or omitted the document can be opened automatically by conforming PDF viewers.

ownerPassword
(string, optional)
Password used to control permissions in a PDF document. Conforming PDF viewers require this password to change the permissions. This password can also be used to open/view the PDF document.


anyOf: [
  {"required":["userPassword"]},
  {"required":["ownerPassword"]}
]

encryptionAlgorithm
(string, required)
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.

enum: AES_128, AES_256
contentToEncrypt
(string, optional)
Sets the type of content to be encrypted. If ONLY_EMBEDDED_FILES option is set, it will render any provided access permissions as ineffective.

enum: ALL_CONTENT, ALL_CONTENT_EXCEPT_METADATA, ONLY_EMBEDDED_FILES
default: ALL_CONTENT
permissions
(array, optional)
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.

[
string
: 
enum: PRINT_LOW_QUALITY, PRINT_HIGH_QUALITY, EDIT_CONTENT, EDIT_FILL_AND_SIGN_FORM_FIELDS, EDIT_ANNOTATIONS, EDIT_DOCUMENT_ASSEMBLY, COPY_CONTENT
]

required: [
  "passwordProtection",
  "encryptionAlgorithm"
]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

--Boundary_2011_1320772175_1611229313456 Content-Type: application/json Content-Disposition: form-data; name="contentAnalyzerResponse"

{ "cpf:inputs": { "params": { "cpf:inline": { "passwordProtection": { "userPassword": "123", "ownerPassword": "321" }, "contentToEncrypt": "ALL_CONTENT_EXCEPT_METADATA", "encryptionAlgorithm": "AES_128", "permissions": [ "PRINT_LOW_QUALITY", "PRINT_HIGH_QUALITY", "EDIT_CONTENT", "EDIT_FILL_AND_SIGN_FORM_FIELDS", "EDIT_ANNOTATIONS", "EDIT_DOCUMENT_ASSEMBLY", "COPY_CONTENT" ] } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-627aa455ac5d4c338ad49ca882e0fce5" }, "cpf:status": { "completed": true, "type": "", "status": 200, "report": "" }, "cpf:outputs": { "documentOut": { "cpf:location": "multipartLabelOut", "dc:format": "application/pdf" } } } --Boundary_2011_1320772175_1611229313456 Content-Type: application/octet-stream Content-Disposition: form-data; name="multipartLabelOut"

%PDF-1.6 %�� 16 0 obj <</Linearized 1/L 618534/O 19/E 613053/N 1/T 618209/H [ 508 220 ]>> endobj --Boundary_2011_1320772175_1611229313456

Remove Protection :

Remove password protection from a PDF File

Download Postman collection

Try Out With SDK

post removeProtection

Submit a Remove Protection Job

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

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7 required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/pdf required: ["dc:format","cpf:location"] params (object, required) Params for specifying password (applied on the PDF document) to remove all security/restrictions such as either opening or editing a PDF document. cpf:inline (object, required) password (string, required) Password required for removing security/permissions from the PDF document. required: ["password"] additionalProperties: false required: ["cpf:inline"] required: ["documentIn","params"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call documentOut (object, required) Contains the information about the file content part name and format of the output expected. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. dc:format (string, required) The expected format of the output file: application/pdf required: ["dc:format","cpf:location"] required: ["documentOut"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7" }, "cpf:inputs": { "params": { "cpf:inline": { "password": "password" } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } }, "cpf:outputs": { "documentOut": { "dc:format": "application/pdf", "cpf:location": "multipartLabelOut" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying password (applied on the PDF document) to remove all security/restrictions such as either opening or editing a PDF document.

cpf:inline
(object, required)

password
(string, required)
Password required for removing security/permissions from the PDF document.


required: ["password"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": false,
    "type": "",
    "title": "In Progress",
    "status": 202,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "password": "password"
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  }
}

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying password (applied on the PDF document) to remove all security/restrictions such as either opening or editing a PDF document.

cpf:inline
(object, required)

password
(string, required)
Password required for removing security/permissions from the PDF document.


required: ["password"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "I/O Validation Error.",
    "title": "Value for I/O object params does not match the required schema {\"type\":\"object\",\"properties\":{\"password\":{\"description\":\"Password required for removing security/permissions from the PDF document.\",\"type\":\"string\"}},\"required\":[\"password\"],\"additionalProperties\":false}.",
    "status": 400,
    "report": "{\"error_code\":\"IO_SCHEMA_MISMATCH\"}"
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "passwordd": "password"
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying password (applied on the PDF document) to remove all security/restrictions such as either opening or editing a PDF document.

cpf:inline
(object, required)

password
(string, required)
Password required for removing security/permissions from the PDF document.


required: ["password"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying password (applied on the PDF document) to remove all security/restrictions such as either opening or editing a PDF document.

cpf:inline
(object, required)

password
(string, required)
Password required for removing security/permissions from the PDF document.


required: ["password"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying password (applied on the PDF document) to remove all security/restrictions such as either opening or editing a PDF document.

cpf:inline
(object, required)

password
(string, required)
Password required for removing security/permissions from the PDF document.


required: ["password"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests={
    \"cpf:inputs\": {
        \"params\": {
            \"cpf:inline\": {
                \"password\": \"password\"
            }
        },
        \"documentIn\": {
            \"cpf:location\": \"InputFile0\",
            \"dc:format\": \"application/pdf\"
        }
    },
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7\"
    },
    \"cpf:outputs\": {
        \"documentOut\": {
            \"cpf:location\": \"multipartLabelOut\",
            \"dc:format\": \"application/pdf\"
        }
    }
}' \
--form 'InputFile0=@"{{Placeholder for input file (absolute path)}}"'

get removeProtection.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
SOURCE_EMPTY
The input file is a zero length file.


400
REQUEST_TOO_LARGE
The input file is too large.


400
CORRUPT_DOCUMENT
The input file appears to be corrupted and cannot be processed.


400
PDF_XFA_FORM
Source PDF is a XFA Form and cannot be processed..


400
PDF_CERTIFIED
Source PDF is certified and cannot be processed.


400
PDF_CERTIFICATE_ENCRYPTED
Source file is certificate encrypted and cannot be processed.


400
INVALID_PASSWORD
The password is not authorized to remove the security.


400
PDF_NOT_PROTECTED
Source PDF file is not password protected.


400
PDF_SIGNED
Source PDF is signed and cannot be processed.


400
PASSWORD_NULL_OR_EMPTY
Password cannot be null or empty.


400
PASSWORD_LENGTH_EXCEEDED
Password length cannot exceed the maximum allowed characters.


500
INTERNAL_SERVER_ERROR
An Internal Server Error has occurred.


500
REQUEST_TIMEOUT
The operation has timed out, please try after some time.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying password (applied on the PDF document) to remove all security/restrictions such as either opening or editing a PDF document.

cpf:inline
(object, required)

password
(string, required)
Password required for removing security/permissions from the PDF document.


required: ["password"]


required: ["cpf:inline"]


required: ["documentIn","params"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

documentOut
(object, required)
Contains the information about the file content part name and format of the output expected.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file.

dc:format
(string, required)
The expected format of the output file: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentOut"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "password": "password"
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  },
  "cpf:outputs": {
    "documentOut": {
      "cpf:location": "multipartLabelOut",
      "dc:format": "application/pdf"
    }
  }
}

<output_file_content_part>

The file part containing output file content. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOut.cpf:location field.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying password (applied on the PDF document) to remove all security/restrictions such as either opening or editing a PDF document.

cpf:inline
(object, required)

password
(string, required)
Password required for removing security/permissions from the PDF document.


required: ["password"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying password (applied on the PDF document) to remove all security/restrictions such as either opening or editing a PDF document.

cpf:inline
(object, required)

password
(string, required)
Password required for removing security/permissions from the PDF document.


required: ["password"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying password (applied on the PDF document) to remove all security/restrictions such as either opening or editing a PDF document.

cpf:inline
(object, required)

password
(string, required)
Password required for removing security/permissions from the PDF document.


required: ["password"]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying password (applied on the PDF document) to remove all security/restrictions such as either opening or editing a PDF document.

cpf:inline
(object, required)

password
(string, required)
Password required for removing security/permissions from the PDF document.


required: ["password"]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

--Boundary_459_1085663309_1611227788814
Content-Type: application/json
Content-Disposition: form-data; name="contentAnalyzerResponse"
{
    "cpf:inputs": {
        "params": {
            "cpf:inline": {
                "password": "password"
            }
        },
        "documentIn": {
            "dc:format": "application/pdf",
            "cpf:location": "multipartLabel"
        }
    },
    "cpf:engine": {
        "repo:assetId": "urn:aaid:cpf:Service-d80dc37d3aee44a8839e3429360db9a7"
    },
    "cpf:status": {
        "completed": true,
        "type": "",
        "status": 200,
        "report": ""
    },
    "cpf:outputs": {
        "documentOut": {
            "cpf:location": "multipartLabelOut",
            "dc:format": "application/pdf"
        }
    }
}
--Boundary_459_1085663309_1611227788814
Content-Type: application/octet-stream
Content-Disposition: form-data; name="multipartLabelOut"
%PDF-1.7
%����
2080 0 obj
<</Linearized 1/L 376659/O 2082/E 86236/N 53/T 375889/H [
    520 673
]>>
endobj
--Boundary_459_1085663309_1611227788814

Split :

Split a PDF File into multiple PDF Files

Download Postman collection

Try Out With SDK

post splitPDF

Submit a Split PDF Job

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)

Use the page count to specify the maximum number of pages in each of the output file(s).
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.
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).

API endpoint

https://cpf-ue1.adobe.io/ops/:create

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Form Parameters

Parameter	Required	Description
contentAnalyserRequests	true	The JSON part containing the information about the input, parameters and the output.
application/json cpf:engine (object, required) The service that processes the operation request. repo:assetId (string, required) The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f required: ["repo:assetId"] cpf:inputs (object, required) The details about the file provided as a input to this operation documentIn (object, required) cpf:location (string, required) The <file_content_part_name> containing the input file in the multipart/form-data request. dc:format (string, required) The format of the file taken as input: application/pdf required: ["dc:format","cpf:location"] params (object, required) Params for specifying how to split a PDF document into multiple documents. Different options for splitting PDF document are mutually exclusive. cpf:inline (object, required) ONE OF fileCount (number, optional) The number of documents to split the input PDF file into. pageCount (number, optional) The maximum number of pages each of the output files can have. pageRanges (array, optional) Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap. [{ start (number, required) Start page of this page range.Page numbers are indexed from 1 to N. end (number, optional) End page of this page range.Page numbers are indexed from 1 to N. required: ["start"] additionalProperties: false }] oneOf: [ {"required":["fileCount"]}, {"required":["pageCount"]}, {"required":["pageRanges"]} ] required: ["cpf:inline"] required: ["documentIn","params"] cpf:outputs (object, required) The details about the file expected in the output response of the GET API status call documentOutList (object, required) List of resultant output PDF documents. cpf:location (string, required) The expected <output_file_content_part_name> that will contain the contents of generated output file. In case of list output multiple files are expected so the part name for files will be like <output_file_content_part_name>index, here index can be 0,1,2... depending on the no. of files. dc:format (string, required) The expected format of the output: application/pdf required: ["dc:format","cpf:location"] required: ["documentOutList"] required: [ "cpf:engine", "cpf:inputs", "cpf:outputs" ]
Example: { "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f" }, "cpf:inputs": { "params": { "cpf:inline": { "fileCount": 4 } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } }, "cpf:outputs": { "documentOutList": { "dc:format": "text/directory", "cpf:location": "multipartLabelOut" } } }
<file_content_part_name>	true	The input file content. The part name should be same as what mentioned inside `contentAnalyzerRequests.cpf:inputs.documentIn.cpf:location` field.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.
Prefer	false	The time in seconds, to wait for the operation to complete so as to get the multipart/mixed data containing the Output file contents in the Submit (POST) call itself. Different Behaviours as per the wait time provided: `respond-async,wait=0` - The POST call will return HTTP status of 202 on successful job creation with a `location` header in response which can be polled for the final output content. `respond-async,wait=<Integer>`- 201 HTTP status code will be returned (with `location` response header and multipart/mixed response output content) if the operation processing completes successfully before the specified wait time, otherwise 202 HTTP status code will be returned with `location` header in response which can be polled for the final output content. 200 HTTP status code can also be returned when there is some problem processing the request (a status field inside the response body will have the details regarding the failure). By default, the wait time is 59 seconds. respond-async,wait=0 respond-async,wait=<Integer>

Query Parameters

Parameter	Required	Description
respondWith	true	Url-encoded value of {"reltype": "http://ns.adobe.com/rel/primary"}

Responses

HTTP Status	Reason

200

The operation has failed due to some reason before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default), for detailed error refer cpf:status field inside the response body. Expect 200 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

201

The operation is completed successfully before the wait time provided in the Prefer header specified in the request (if Prefer header was not specified then the wait time is 59s by default). Expect 201 HTTP status code only when respond-async,wait=0 is NOT specified in the Prefer Header value while creating the request. Refer the response body structure from GET call 200 response.

Response Headers:

Header Name	Description
location	The URL to re-fetch output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

202

Request creation for the operation and status uri generated, which can be found in the 'location' header.

Response Headers:

Header Name	Description
location	The URL to poll for final output content. Use this as the endpoint for the GET API call
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f 


required: ["repo:assetId"]

cpf:status
(object, optional)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)
The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure


required: ["completed","type","status","title"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying how to split a PDF document into multiple documents. Different options for splitting PDF document are mutually exclusive.

cpf:inline
(object, required)

ONE OF
fileCount
(number, optional)
The number of documents to split the input PDF file into.

pageCount
(number, optional)
The maximum number of pages each of the output files can have.

pageRanges
(array, optional)
Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.

[{
start
(number, required)
Start page of this page range.Page numbers are indexed from 1 to N.

end
(number, optional)
End page of this page range.Page numbers are indexed from 1 to N.


required: ["start"]
}]

oneOf: [
  {"required":["fileCount"]},
  {"required":["pageCount"]},
  {"required":["pageRanges"]}
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": false,
    "type": "",
    "title": "In Progress",
    "status": 202,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "fileCount": 4
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  }
}

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying how to split a PDF document into multiple documents. Different options for splitting PDF document are mutually exclusive.

cpf:inline
(object, required)

ONE OF
fileCount
(number, optional)
The number of documents to split the input PDF file into.

pageCount
(number, optional)
The maximum number of pages each of the output files can have.

pageRanges
(array, optional)
Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.

[{
start
(number, required)
Start page of this page range.Page numbers are indexed from 1 to N.

end
(number, optional)
End page of this page range.Page numbers are indexed from 1 to N.


required: ["start"]
}]

oneOf: [
  {"required":["fileCount"]},
  {"required":["pageCount"]},
  {"required":["pageRanges"]}
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "I/O Validation Error.",
    "title": "Value for I/O object params does not match the required schema {\"type\":\"object\",\"properties\":{\"pageRanges\":{\"description\":\"Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"start\":{\"description\":\"Start page of this page range.Page numbers are indexed from 1 to N.\",\"type\":\"number\"},\"end\":{\"description\":\"End page of this page range.Page numbers are indexed from 1 to N.\",\"type\":\"number\"}},\"required\":[\"start\"],\"additionalProperties\":false}},\"pageCount\":{\"description\":\"The maximum number of pages each of the output files can have.\",\"type\":\"number\"},\"fileCount\":{\"description\":\"The number of documents to split the input PDF file into.\",\"type\":\"number\"}},\"oneOf\":[{\"required\":[\"fileCount\"]},{\"required\":[\"pageCount\"]},{\"required\":[\"pageRanges\"]}]}.",
    "status": 400,
    "report": "{\"error_code\":\"IO_SCHEMA_MISMATCH\"}"
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "fileCountt": 4
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying how to split a PDF document into multiple documents. Different options for splitting PDF document are mutually exclusive.

cpf:inline
(object, required)

ONE OF
fileCount
(number, optional)
The number of documents to split the input PDF file into.

pageCount
(number, optional)
The maximum number of pages each of the output files can have.

pageRanges
(array, optional)
Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.

[{
start
(number, required)
Start page of this page range.Page numbers are indexed from 1 to N.

end
(number, optional)
End page of this page range.Page numbers are indexed from 1 to N.


required: ["start"]
}]

oneOf: [
  {"required":["fileCount"]},
  {"required":["pageCount"]},
  {"required":["pageRanges"]}
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying how to split a PDF document into multiple documents. Different options for splitting PDF document are mutually exclusive.

cpf:inline
(object, required)

ONE OF
fileCount
(number, optional)
The number of documents to split the input PDF file into.

pageCount
(number, optional)
The maximum number of pages each of the output files can have.

pageRanges
(array, optional)
Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.

[{
start
(number, required)
Start page of this page range.Page numbers are indexed from 1 to N.

end
(number, optional)
End page of this page range.Page numbers are indexed from 1 to N.


required: ["start"]
}]

oneOf: [
  {"required":["fileCount"]},
  {"required":["pageCount"]},
  {"required":["pageRanges"]}
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying how to split a PDF document into multiple documents. Different options for splitting PDF document are mutually exclusive.

cpf:inline
(object, required)

ONE OF
fileCount
(number, optional)
The number of documents to split the input PDF file into.

pageCount
(number, optional)
The maximum number of pages each of the output files can have.

pageRanges
(array, optional)
Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.

[{
start
(number, required)
Start page of this page range.Page numbers are indexed from 1 to N.

end
(number, optional)
End page of this page range.Page numbers are indexed from 1 to N.


required: ["start"]
}]

oneOf: [
  {"required":["fileCount"]},
  {"required":["pageCount"]},
  {"required":["pageRanges"]}
]


required: ["cpf:inline"]


required: ["documentIn","params"]

Curl

curl --location --request POST 'https://cpf-ue1.adobe.io/ops/:create?respondWith=%7B%22reltype%22%3A%20%22http%3A%2F%2Fns.adobe.com%2Frel%2Fprimary%22%7D' \
--header 'Authorization: Bearer {{Placeholder for token}}' \
--header 'x-api-key: {{Placeholder for client_id}}' \
--header 'Prefer: respond-async,wait=0' \
--form 'contentAnalyzerRequests={
    \"cpf:inputs\": {
        \"params\": {
            \"cpf:inline\": {
                \"pageRanges\": [{
                    \"start\": 2,
                    \"end\": 4
                }, {
                    \"start\": 7,
                    \"end\": 9
                }]
            }
        },
        \"documentIn\": {
            \"cpf:location\": \"InputFile0\",
            \"dc:format\": \"application/pdf\"
        }
    },
    \"cpf:engine\": {
        \"repo:assetId\": \"urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f\"
    },
    \"cpf:outputs\": {
        \"documentOutList\": {
            \"cpf:location\": \"multipartLabelOut\",
            \"dc:format\": \"text/directory\"
        }
    }
}' \
--form 'InputFile0=@"{{Placeholder for input file (absolute path)}}"'

get splitPDF.status

Poll Status of Job Execution

Poll the location URL returned in the response header of POST call to get the generated output file.

API endpoint

https://cpf-ue1.adobe.io/ops/id/<x-request-id>

Authentication Scheme(s)

Provide an Authentication header with a primary access Bearer token. For generating access token please refer to How to get started section in the Introduction.

Request Headers

Parameter	Required	Description
x-api-key	true	The clientId from the generated credentials.

Responses

HTTP Status	Reason

200

Response of content-type: Multipart/Mixed, containing JSON object named as contentAnalyzerResponse and file part containing output file content only if the cpf:status.status = 200, Otherwise Response of content-type: application/json is returned containing the response body json structure same as contentAnalyzerResponse.

Response Headers:

Header Name	Description
Content-Type	The content type of the status call response. multipart/mixed; boundary=some_boundary;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

multipart/mixed; boundary=some_boundary;charset=UTF-8

Part Name	Description
contentAnalyserResponse	The JSON part containing the information about the input, status, parameters and the output.

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f 


required: ["repo:assetId"]

cpf:status
(object, required)
The object containing the information about the request status

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, optional)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion

report
(string, optional)



status
report.error_code
title (The message can change) 




400
SOURCE_EMPTY
The input file is a zero length file.


400
REQUEST_TOO_LARGE
The input file is too large.


400
CORRUPT_DOCUMENT
The input file appears to be corrupted and cannot be processed.


400
PASSWORD_PROTECTED
Source file is protected and cannot be processed.


400
PDF_XFA_FORM
Source PDF is a XFA Form and cannot be processed..


400
PDF_CERTIFIED
Source PDF is certified and cannot be processed.


400
PDF_CERTIFICATE_ENCRYPTED
Source file is certificate encrypted and cannot be processed.


400
INVALID_PAGE_RANGE
The page range specified is invalid. Either invalid range syntax, bad page references, or results in a PDF with too many pages relative to the input PDF(s).


400
INVALID_PAGE_COUNT
The maximum number of pages specified  per output file cannot be less than 0  or greater than the number of pages in the input PDF.


400
INVALID_FILE_COUNT
The number of documents (to split the input PDF file into) specified cannot be less than 0 or greater than the number of pages in the input PDF.


400
OUTPUT_FILES_LIMIT_EXCEEDED
The input PDF cannot be split into more than 20 output PDFs.


500
INTERNAL_SERVER_ERROR
An Internal Server Error has occurred.


500
REQUEST_TIMEOUT
The operation has timed out, please try after some time.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.


required: ["completed","type","status"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying how to split a PDF document into multiple documents. Different options for splitting PDF document are mutually exclusive.

cpf:inline
(object, required)

ONE OF
fileCount
(number, optional)
The number of documents to split the input PDF file into.

pageCount
(number, optional)
The maximum number of pages each of the output files can have.

pageRanges
(array, optional)
Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.

[{
start
(number, required)
Start page of this page range.Page numbers are indexed from 1 to N.

end
(number, optional)
End page of this page range.Page numbers are indexed from 1 to N.


required: ["start"]
}]

oneOf: [
  {"required":["fileCount"]},
  {"required":["pageCount"]},
  {"required":["pageRanges"]}
]


required: ["cpf:inline"]


required: ["documentIn","params"]

cpf:outputs
(object, required)
The details about the file expected in the output response of the GET API status call

documentOutList
(object, required)
List of resultant output PDF documents.

cpf:location
(string, required)
The expected <output_file_content_part_name> that will contain the contents of generated output file. In case of list output multiple files are expected so the part name for files will be like  <output_file_content_part_name>index, here index can be 0,1,2... depending on the no. of files.

dc:format
(string, required)
The expected format of the output: application/pdf


required: ["dc:format","cpf:location"]


required: ["documentOutList"]


required: [
  "cpf:engine",
  "cpf:inputs",
  "cpf:status",
  "cpf:outputs"
]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "",
    "status": 200,
    "report": ""
  },
  "cpf:engine": {
    "repo:assetId": "urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f"
  },
  "cpf:inputs": {
    "params": {
      "cpf:inline": {
        "fileCount": 4
      }
    },
    "documentIn": {
      "dc:format": "application/pdf",
      "cpf:location": "multipartLabel"
    }
  },
  "cpf:outputs": {
    "documentOutList": {
      "dc:format": "text/directory",
      "cpf:location": "multipartLabelOut"
    }
  }
}

<output_file_content_part>index

The file parts containing output file contents. The part name is same as what mentioned inside contentAnalyzerRequests.cpf:outputs.documentOutList.cpf:location field followed by index.

400

Bad Request. The request was invalid or cannot be otherwise served.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




400
MULTIPART_FIELD_MISSING
Required multipart field cid:multipartLabel not found in the request.


400
ENGINE_NOT_FOUND
Unable to find engine corresponding to the engine path given null


400
REQUIRED_INPUTS_MISSING
Required input documentIn not found.


400
IO_SCHEMA_MISMATCH
Invalid I/O in the request. I/O name: ....


400
INVALID_ENGINE_REQUEST
Required output documentOut not found.


400
MEDIA_TYPE_UNSUPPORTED
Invalid I/O in the request. I/O name:....


400
REQUEST_TOO_LARGE
Total size of inline inputs exceeds permitted size: 100000000 bytes.


400
WAIT_TIME_NOT_ALLOWED
Invalid value of wait seconds provided. 


400
INVALID_REQUEST_PARAMS
Invalid parameters in request. Required parameter %param missing.


400
INVALID_REQUEST
Invalid Request Schema.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure.
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying how to split a PDF document into multiple documents. Different options for splitting PDF document are mutually exclusive.

cpf:inline
(object, required)

ONE OF
fileCount
(number, optional)
The number of documents to split the input PDF file into.

pageCount
(number, optional)
The maximum number of pages each of the output files can have.

pageRanges
(array, optional)
Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.

[{
start
(number, required)
Start page of this page range.Page numbers are indexed from 1 to N.

end
(number, optional)
End page of this page range.Page numbers are indexed from 1 to N.


required: ["start"]
}]

oneOf: [
  {"required":["fileCount"]},
  {"required":["pageCount"]},
  {"required":["pageRanges"]}
]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

{
  "cpf:status": {
    "completed": true,
    "type": "Bad Request Error.",
    "title": "Internal exception occur while fetching response error",
    "status": 400,
    "report": "{\"error_code\":\"INVALID_REQUEST\"}"
  }
}

401

Unauthorized. Authentication credentials were missing or incorrect.

Response Headers:

Header Name	Description
Content-Type	The content type of the error JSON response. application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"
x-server	The name and version of the server.
x-request-id	A unique value identifying this request. If x-request-id was specified in the request, this value is the same as the input.

Response Body:

application/vnd.adobe.dc+json;profile="https://dc-api.adobe.io/schemas/error_v1.json"

error
(object, required)

code
(string, required)
Unauthorized

message
(string, required)
An English language string that contains more information about the error. This is not intended as information to be presented to an end user, is instead be helpful for logging and debugging.

details
(object, optional)
A JSON object that contains information specific to the error. The schema and semantics are specified with the individual method. This allows machine readable extra information.



required: ["code","message"]


required: ["error"]

408

Request Timed Out. Some operation has timed out due to client issue.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




408
REQUEST_TIMEOUT
Request processing took more than %s seconds.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying how to split a PDF document into multiple documents. Different options for splitting PDF document are mutually exclusive.

cpf:inline
(object, required)

ONE OF
fileCount
(number, optional)
The number of documents to split the input PDF file into.

pageCount
(number, optional)
The maximum number of pages each of the output files can have.

pageRanges
(array, optional)
Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.

[{
start
(number, required)
Start page of this page range.Page numbers are indexed from 1 to N.

end
(number, optional)
End page of this page range.Page numbers are indexed from 1 to N.


required: ["start"]
}]

oneOf: [
  {"required":["fileCount"]},
  {"required":["pageCount"]},
  {"required":["pageRanges"]}
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

429

Caller doesn't have sufficient quota for this operation.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




429
INSUFFICIENT_QUOTA
Client exhausted the Quota.


429
INSUFFICIENT_QUOTA
Client did not purchase a policy to call this engine.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, required)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f 


required: ["repo:assetId"]

cpf:inputs
(object, required)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying how to split a PDF document into multiple documents. Different options for splitting PDF document are mutually exclusive.

cpf:inline
(object, required)

ONE OF
fileCount
(number, optional)
The number of documents to split the input PDF file into.

pageCount
(number, optional)
The maximum number of pages each of the output files can have.

pageRanges
(array, optional)
Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.

[{
start
(number, required)
Start page of this page range.Page numbers are indexed from 1 to N.

end
(number, optional)
End page of this page range.Page numbers are indexed from 1 to N.


required: ["start"]
}]

oneOf: [
  {"required":["fileCount"]},
  {"required":["pageCount"]},
  {"required":["pageRanges"]}
]


required: ["cpf:inline"]


required: ["documentIn","params"]


required: ["cpf:engine","cpf:inputs"]

500

Internal Server Error. The server has encountered an error and is unable to process your request at this time.

Response Headers:

Header Name	Description
Content-Type	The content type of the POST API call response application/json;charset=UTF-8
x-request-id	A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.

Response Body:

application/json;charset=UTF-8

cpf:status
(object, optional)
The object containing the information about the request status

report
(string, optional)



status
report.error_code
title (The message can change) 




500
INTERNAL_SERVER_ERROR
There was an error processing your request.


500
REQUEST_SAVING_FAILED
Error while ingesting input stream.


500
RESPONSE_TOO_LARGE
Size of predict response exceeds permitted limit: %s.


500
INVALID_ENGINE_SETUP
Queue not found for predict service.


500
INVALID_ENGINE_RESPONSE
output message payload is null.


500
CONTENT_TRANSFER_ERROR
Unknown Error.



The json object string containing the error_code field. error_code is the Mnemonic returned by service in case of any failure
The above list is extendable and going forward the error codes can become more specific.

type
(string, required)
Internal Field

status
(integer, required)
Http status code returned by the service

title
(string, required)
the state of the request for e.g. In Progress, Completed. In case of Failure, a descriptive error message will be returned

completed
(string, required)
Will be true or false based on the status of the request completion


required: ["completed","type","status","title"]

cpf:engine
(object, optional)
The service that processes the operation request.

repo:assetId
(string, required)
The unique assetID of the service that provides the functionality of this operation, the value should be urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f 


required: ["repo:assetId"]

cpf:inputs
(object, optional)
The details about the file provided as a input to this operation

documentIn
(object, required)

cpf:location
(string, required)
The <file_content_part_name> containing the input file in the multipart/form-data request.

dc:format
(string, required)
The format of the file taken as input: application/pdf


required: ["dc:format","cpf:location"]

params
(object, required)
Params for specifying how to split a PDF document into multiple documents. Different options for splitting PDF document are mutually exclusive.

cpf:inline
(object, required)

ONE OF
fileCount
(number, optional)
The number of documents to split the input PDF file into.

pageCount
(number, optional)
The maximum number of pages each of the output files can have.

pageRanges
(array, optional)
Page ranges on the basis of which to split the input PDF file. Each page range corresponds to a single output file having the pages specified in the page range. The page ranges may not overlap.

[{
start
(number, required)
Start page of this page range.Page numbers are indexed from 1 to N.

end
(number, optional)
End page of this page range.Page numbers are indexed from 1 to N.


required: ["start"]
}]

oneOf: [
  {"required":["fileCount"]},
  {"required":["pageCount"]},
  {"required":["pageRanges"]}
]


required: ["cpf:inline"]


required: ["documentIn","params"]

Example:

--Boundary_57481_407432268_1612197912964 Content-Type: application/json Content-Disposition: form-data; name="contentAnalyzerResponse"

{ "cpf:inputs": { "params": { "cpf:inline": { "fileCount": 4 } }, "documentIn": { "dc:format": "application/pdf", "cpf:location": "multipartLabel" } }, "cpf:engine": { "repo:assetId": "urn:aaid:cpf:Service-d99c7660cba14e5c98f9023221dab40f" }, "cpf:status": { "completed": true, "type": "", "status": 200, "report": "" }, "cpf:outputs": { "documentOutList": [ { "cpf:location": "multipartLabelOut0", "dc:format": "application/pdf" }, { "cpf:location": "multipartLabelOut1", "dc:format": "application/pdf" }, { "cpf:location": "multipartLabelOut2", "dc:format": "application/pdf" }, { "cpf:location": "multipartLabelOut3", "dc:format": "application/pdf" } ] } } --Boundary_57481_407432268_1612197912964 Content-Type: application/octet-stream Content-Disposition: form-data; name="multipartLabelOut3"

%PDF-1.6 %�� 1 0 obj <</MarkInfo<>/Metadata 2 0 R/Outlines 5 0 R/Pages 3 0 R/StructTreeRoot 6 0 R/Type/Catalog>> endobj --Boundary_57481_407432268_1612197912964

Introduction

How to get started?

How to Use our APIs?

Postman Collection Usage

End Of Life Policy

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

post documentGeneration

API endpoint

Authentication Scheme(s)

Form Parameters

Request Headers

Query Parameters

Responses

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Curl

get documentGeneration.status

API endpoint

Authentication Scheme(s)

Request Headers

Responses

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

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

post extractPDF

API endpoint

Authentication Scheme(s)

Form Parameters

Request Headers

Query Parameters

Responses

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Response Headers:

Response Body:

Curl

get extractPDF.status

API endpoint

Authentication Scheme(s)

Request Headers

Responses

Response Headers:

Response Body:

Response Headers:

Document Generation :

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

Extract :

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

Create :

Convert a non-PDF File to a PDF File

HTML To PDF :

Convert HTML Resources to a PDF File