PDF Attachments
PDF attachments functions and attachments extraction.
Available Methods
[POST] /pdf/attachments/extract
Extracts PDF attachments from source pdf file.
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 gettingToo Many Requests
orAccess Denied
error for your input url, please try to addcache:
to enable built-in url caching.
You can also encrypt data for output files and decrypt data input files with user-controlled data encryption (uses strongAES
encryption with your own keys). Click here to learn more.httpusername
optional - http auth user name if required to access sourceurl
.httppassword
optional - http auth password if required to access sourceurl
.inline
optional.false
by default. Inasync
mode makes to returnbody
with the content of the output json (with the links to the output). To check the status of async job you should usejob/check
endpoint to check status of a job by itsjobId
. Seeexpiration
optional. Output link expiration in minutes. Default is60
(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. ReturnsJobId
that you may use with/job/check
to check state of the background job (possible states:working
,failed
,aborted
andsuccess
). Must be one of:true
,false
.profiles
optional. Must be a String. Use this parameter to set additional configuration for fine tuning and extra options. Explore PDF.co knowledgebase for profile examples.- Method: POST
- URL: /v1/pdf/attachments/extract
Query parameters
No query parameters accepted.
Body payload
{
"url": "https://bytescout-com.s3.us-west-2.amazonaws.com/files/demo-files/cloud-api/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://bytescout-com.s3.us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-attachments/attachments.pdf",
"inline": true,
"async": false
}'
Copyright © 2016 - 2023 PDF.co