Link Search Menu Expand Document
PDF.co API

PDF Attachments

PDF attachments functions and attachments extraction.

Available Methods

[POST] /pdf/attachments/extract

Extracts PDF attachments from source pdf file.

Attributes
url required
URL to the source file. Supports links from Google Drive, Dropbox and from built-in PDF.co files storage.

For uploading files via API please check Files Upload section.

If you are randomly getting a Too Many Requests or Access Denied error for your input URL, Please try to add cache: to enable built-in URL caching.

You can also encrypt data for output files and decrypt data input files with user-controlled data encryption to learn more.
httpusername optional
HTTP auth user name if required to access source URL.
httppassword optional
HTTP auth password if required to access source URL.
inline optional false by default.
In async mode makes to return body with the content of the output JSON (with the links to the output). To check the status of async job you should use the job/check endpoint to check the status of a job by its jobId.
expiration optional
The output link expiration time limit in minutes, The default is 60 (i.e. 60 minutes or 1 hour) after this delay generated output file(s) (if any) will be auto-removed from PDF.co temporary files storage. Max allowed expiration period depends on your current subscription plan. To store permanent input files (e.g. re-usable images, pdf, documents), please use PDF.co built-in Files Storage instead.
async optional
Runs processing asynchronously and returns JobId that you may use with /job/check to check the state of the background job (possible states: working, failed, aborted and success). Must be one of: true or false.
profiles optional
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase for profile examples, The input must be in string format.
  • Method: POST
  • URL: /v1/pdf/attachments/extract

Query parameters

No query parameters accepted.

Body payload

{
    "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-attachments/attachments.pdf",
    "inline": true,
    "async": false
}

Example responses

/pdf/attachments/extract
{
    "urls": [
        "https://pdf-temp-files.s3.amazonaws.com/DO1TAIHEZR5P9QLI7ICYM9DI0AAH57HY/sample.png",
        "https://pdf-temp-files.s3.amazonaws.com/EOINIMD7X48JSOB1G8ETLVPOFZLM1NJ2/SampleMetafile.emf",
        "https://pdf-temp-files.s3.amazonaws.com/3LW4BXNSPAE0WQTG5DPMXX498OCPNU4Q/ab.tif"
    ],
    "pageCount": 3,
    "error": false,
    "status": 200,
    "name": "attachments.json",
    "credits": 24,
    "duration": 1211,
    "remainingCredits": 98003902
}

Code Snippet

CURL
curl --location --request POST 'https://api.pdf.co/v1/pdf/attachments/extract' \
--header 'Content-Type: application/json' \
--header 'x-api-key: ' \
--data-raw '{
    "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-attachments/attachments.pdf",
    "inline": true,
    "async": false
}'