PdfcoClient
Classes
dataclass
HtmlToPdfInput(html: str, *, name: Optional[str] = None, margins: Optional[str] = None, paper_size: Optional[str] = None, orientation: Optional[str] = None, print_background: Optional[bool] = None, header: Optional[str] = None, footer: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
HTML to PDF
Attributes
class-attribute
instance-attribute
Base file name for new PDF files.
class-attribute
instance-attribute
Override default margins with custom values (the order is top right bottom
left). You can als set all margins: 10px, 5mm, 5in for all sides.
class-attribute
instance-attribute
paper_size: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'paperSize'})
Select PDF paper size. Can be Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6 or a custom size. Custom size can be set in px (pixels), mm or in (inches) with width and height separated by space like this: 200 300, 200px 300px, 200mm 300mm, 20cm 30cm or 6in 8in.
class-attribute
instance-attribute
PDF page orientation.
class-attribute
instance-attribute
print_background: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'printBackground'})
Enable or disable printing of document background
class-attribute
instance-attribute
Set to HTML for header to be applied on every page at the header.
class-attribute
instance-attribute
Set to HTML for footer to be applied on every page at the bottom.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
HtmlToPdfResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, duration: Optional[int] = None, remaining_credits: Optional[int] = None)
Response for HTML to PDF
Attributes
class-attribute
instance-attribute
Output document URL.
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
Number of pages in the output document.
class-attribute
instance-attribute
Indicates whether the operation is successful or not.
class-attribute
instance-attribute
Status code for HTTP response
class-attribute
instance-attribute
Output document name
class-attribute
instance-attribute
PDF.co credits used for this request
class-attribute
instance-attribute
Request execution duration
dataclass
UrlToPdfInput(url: str, *, margins: Optional[str] = None, paper_size: Optional[str] = None, orientation: Optional[str] = None, print_background: Optional[bool] = None, header: Optional[str] = None, footer: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
URL to PDF
Attributes
instance-attribute
Link to input HTML file or website page to be converted. You can pass link to file from Google Drive, Dropbox or another online file service that can generate shareable links.
class-attribute
instance-attribute
Margins to be used in output document. Set to css style margins like 10px, 5mm, 5in for all sides or 5px 5px 5px 5px (the order of margins is top, right, bottom, left).
class-attribute
instance-attribute
paper_size: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'paperSize'})
Letter is set by default. Can be Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6 or a custom size. Custom size can be set in px (pixels), mm or in (inches) with width and height separated by space like this: 200 300, 200px 300px, 200mm 300mm, 20cm 30cm or 6in 8in.
class-attribute
instance-attribute
Output page orientation
class-attribute
instance-attribute
print_background: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'printBackground'})
Enable or disable printing of document background
class-attribute
instance-attribute
Set to HTML for header to be applied on every page at the header.
class-attribute
instance-attribute
Set to HTML for footer to be applied on every page at the bottom.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
UrlToPdfResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, duration: Optional[int] = None, remaining_credits: Optional[int] = None)
Response for URL to PDF
Attributes
class-attribute
instance-attribute
Output document URL.
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
Number of pages in the output document.
class-attribute
instance-attribute
Indicates whether the operation is successful or not.
class-attribute
instance-attribute
Status code for HTTP response
class-attribute
instance-attribute
Output document name
class-attribute
instance-attribute
PDF.co credits used for this request
class-attribute
instance-attribute
Request execution duration
dataclass
PdfFillerInput(url: str, *, annotations_string: Optional[str] = None, images_string: Optional[str] = None, fields_string: Optional[str] = None, name: Optional[str] = None, inline: Optional[bool] = None, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
Add Text, Images, Form Fields to PDF
Attributes
class-attribute
instance-attribute
annotations_string: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'annotationsString'})
Annotation strings to be added to the PDF document. Format should be like "x;y;page;text". Refer to PDF.co documentations for more advanced formats and examples.
class-attribute
instance-attribute
images_string: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imagesString'})
Images to be added to the PDF document. Format should be like "x;y;page;urltoimage;link;width;height". Refer to PDF.co documentations for more advanced formats and examples.
class-attribute
instance-attribute
fields_string: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fieldsString'})
Fill PDF form fields. Format should be like "page;fieldName;value". Refer to PDF.co documentations for more advanced formats and examples.
class-attribute
instance-attribute
Output PDF Name
class-attribute
instance-attribute
Determines whether to return output in response or link to output file.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
PdfFillerResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, duration: Optional[int] = None, remaining_credits: Optional[int] = None)
Response for Add Text, Images, Form Fields to PDF
Attributes
class-attribute
instance-attribute
Output document URL.
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
Number of pages in the output document.
class-attribute
instance-attribute
Indicates whether the operation is successful or not.
class-attribute
instance-attribute
Status code for HTTP response
class-attribute
instance-attribute
Output document name
class-attribute
instance-attribute
PDF.co credits used for this request
class-attribute
instance-attribute
Request execution duration
dataclass
MergePdfSimplifiedInput(url: str, *, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
Merge PDF
Attributes
instance-attribute
The comma-separated list of links to PDFs files. Supports links to external
sites, filetoken://.. from PDF.co Files storage and links to G Drive,
Dropbox and other services. Links should be accessible without password.
For password protected PDF files, use PDF Security module first to unlock
input pdf.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
MergePdfSimplifiedResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, duration: Optional[int] = None, remaining_credits: Optional[int] = None)
Response for Merge PDF
Attributes
class-attribute
instance-attribute
Output document URL.
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
Number of pages in the output document.
class-attribute
instance-attribute
Indicates whether the operation is successful or not.
class-attribute
instance-attribute
Status code for HTTP response
class-attribute
instance-attribute
Output document name
class-attribute
instance-attribute
PDF.co credits used for this request
class-attribute
instance-attribute
Request execution duration
dataclass
MergePdfInput(url: str, *, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
Merge PDF (Advanced)
Attributes
instance-attribute
The comma-separated list of links to PDFs, documents, spreadsheets, images.
Supports links to external sites, filetoken://.. from PDF.co Files
storage and links to G Drive, Dropbox and other services. Links should be
accessible without password. For password protected PDF files, use PDF
Security module first to unlock input pdf.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
MergePdfResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, duration: Optional[int] = None, remaining_credits: Optional[int] = None)
Response for Merge PDF (Advanced)
Attributes
class-attribute
instance-attribute
Output document URL.
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
Number of pages in the output document.
class-attribute
instance-attribute
Indicates whether the operation is successful or not.
class-attribute
instance-attribute
Status code for HTTP response
class-attribute
instance-attribute
Output document name
class-attribute
instance-attribute
PDF.co credits used for this request
class-attribute
instance-attribute
Request execution duration
dataclass
SplitPdfInput(url: str, pages: str, *, inline: Optional[bool] = None, name: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
Split PDF
Attributes
instance-attribute
Comma-separated list of page indices (or ranges) to split into. First page
is 1 (one). Example: "1,2-5,7-". Special cases: to extract each page into
separate PDF use to *.
class-attribute
instance-attribute
Determines whether to return output in response or link to output file.
class-attribute
instance-attribute
Base file name for new PDF files
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
SplitPdfResponse(*, urls: Optional[List[str]] = None, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, duration: Optional[int] = None, remaining_credits: Optional[int] = None)
Response for Split PDF
Attributes
class-attribute
instance-attribute
urls
class-attribute
instance-attribute
Output document URL.
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
Number of pages in the output document.
class-attribute
instance-attribute
Indicates whether the operation is successful or not.
class-attribute
instance-attribute
Status code for HTTP response
class-attribute
instance-attribute
Output document name
class-attribute
instance-attribute
PDF.co credits used for this request
class-attribute
instance-attribute
Request execution duration
dataclass
SplitPdf2Input(url: str, search_string: str, *, exclude_key_pages: Optional[bool] = None, regex_search: Optional[bool] = None, case_sensitive: Optional[bool] = None, lang: Optional[str] = None, inline: Optional[bool] = None, name: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
Split PDF (Advanced)
Attributes
class-attribute
instance-attribute
Text to search for on pages. Can also search by barcode, for more info visit https://developer.pdf.co/api/pdf-split/index.html?utm_source=api-docs#post-tag-pdf-split2
class-attribute
instance-attribute
exclude_key_pages: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'excludeKeyPages'})
Set to true if you want to exclude pages where text was found
class-attribute
instance-attribute
regex_search: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'regexSearch'})
Set to true to enable regular expressions for the search string
class-attribute
instance-attribute
case_sensitive: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'caseSensitive'})
Set to true to enable case-sensitive search.
class-attribute
instance-attribute
the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is "eng". Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
class-attribute
instance-attribute
Determines whether to return output in response or link to output file.
class-attribute
instance-attribute
Base file name for new PDF files
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
SplitPdf2Response(*, urls: Optional[List[str]] = None, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, duration: Optional[int] = None, remaining_credits: Optional[int] = None)
Response for Split PDF (Advanced)
Attributes
class-attribute
instance-attribute
urls
class-attribute
instance-attribute
Output document URL.
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
Number of pages in the output document.
class-attribute
instance-attribute
Indicates whether the operation is successful or not.
class-attribute
instance-attribute
Status code for HTTP response
class-attribute
instance-attribute
Output document name
class-attribute
instance-attribute
PDF.co credits used for this request
class-attribute
instance-attribute
Request execution duration
dataclass
PDFSearchTextInput(url: str, search_string: str, *, regex_search: Optional[bool] = None, name: Optional[str] = None, pages: Optional[str] = None, inline: Optional[bool] = None, word_matching_mode: Optional[str] = None, password: Optional[str] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF Search Text
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Text to search can support regular expressions if you set the "Regex Search" parameter to true.
class-attribute
instance-attribute
name
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document) for ALL pages just leave this param empty. Example: 0,2-5,7- means the first page, then the 3rd page to the 6th page, and then the range from the 8th (index = 7) page till the end of the document, The input must be in string format.
class-attribute
instance-attribute
word_matching_mode: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'wordMatchingMode'})
Values can be either 'SmartMatch', 'ExactMatch', or 'None'.
class-attribute
instance-attribute
Password of the PDF file
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFSearchTextResponse(*, body: Optional[List[Dict[str, Any]]] = None, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF Search Text
Attributes
class-attribute
instance-attribute
body
class-attribute
instance-attribute
url
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
DocumentParserInput(url: str, output_format: str, *, template_id: Optional[str] = None, inline: Optional[bool] = None, password: Optional[str] = None, profiles: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None)
Document Parser
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage. To upload files via API, Check out the Files Upload section at https://developer.pdf.co/api/file-upload/index.html
class-attribute
instance-attribute
template_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'templateId'})
Set ID of document parser template to be used. View and manage your templates at https://app.pdf.co/document-parser
class-attribute
instance-attribute
Default is JSON. You can override the default output format to CSV or XML to generate CSV or XML output accordingly.
class-attribute
instance-attribute
Set to true to return results inside the response. Otherwise, the endpoint will return a link to the output file generated
class-attribute
instance-attribute
Password of PDF file
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase https://developer.pdf.co/api/profiles/index.html for profile examples,
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with "Job Check" to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
DocumentParserResponse(*, url: Optional[str] = None, body: Optional[Dict[str, Any]] = None, page_count: Optional[int] = None, error: Optional[bool] = None, job_id: Optional[str] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None, message: Optional[str] = None)
dataclass
dataclass
JobCheckResponse(*, status: Optional[str] = None, message: Optional[str] = None, page_count: Optional[int] = None, url: Optional[str] = None, job_id: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, job_duration: Optional[int] = None, duration: Optional[int] = None, error: Optional[bool] = None, error_code: Optional[int] = None)
Response for Background Jobs Check
Attributes
class-attribute
instance-attribute
status
class-attribute
instance-attribute
message
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
credits
class-attribute
instance-attribute
remaining_credits: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'remainingCredits'})
remainingCredits
class-attribute
instance-attribute
job_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobDuration'})
jobDuration
class-attribute
instance-attribute
duration
class-attribute
instance-attribute
error
dataclass
BarcodeGeneratorInput(value: str, type_: str, *, name: Optional[str] = None, decoration_image: Optional[str] = None, async_: Optional[bool] = None, expiration: Optional[int] = None, profiles: Optional[str] = None)
Barcode Generator
Attributes
class-attribute
instance-attribute
Set async to true for long processes to run in the background, API will then return a jobId which you can use with /job/check endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
Set the barcode type, QRCode By default.
class-attribute
instance-attribute
decoration_image: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'decorationImage'})
Set this to the image that you want to be inserted the logo inside the QR-Code barcode.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck Module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
dataclass
BarcodeGeneratorResponse(*, job_id: Optional[str] = None, url: Optional[str] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Barcode Generator
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
url
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
BarcodeReaderInput(url: str, types: str, *, pages: Optional[str] = None, encrypt: Optional[bool] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
Barcode Reader
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
instance-attribute
Set the barcode type, QRCode is default. You can also combine types by comma, example "QRCode,Code128,Code39,Interleaved2of5,EAN13". All supported barcode types are AustralianPostCode, Aztec, BorderedTable, Checkbox, Circle, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, DPMDataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, HorizontalLine, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, Oval, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, Rectangle, RoyalMail, RoyalMailKIX, Segment, Trioptic, UnderlinedField, UPCA, UPCE, UPU, VerticalLine.
class-attribute
instance-attribute
Comma-Separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the end of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means the first page, then the 3rd page to the 6th page, and then the range from the 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
encrypt
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
BarcodeReaderResponse(*, job_id: Optional[str] = None, url: Optional[str] = None, barcodes: Optional[List[Dict[str, Any]]] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Barcode Reader
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
url
class-attribute
instance-attribute
barcodes
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
credits
dataclass
PDFInfoReaderInput(url: str, *, async_: Optional[bool] = None, password: Optional[str] = None, profiles: Optional[str] = None)
PDF Info Reader
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
Password of the PDF file
class-attribute
instance-attribute
Use this parameter to set additional configuration for fine-tuning and extra options, Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFInfoReaderResponse(*, job_id: Optional[str] = None, url: Optional[str] = None, info: Optional[Dict[str, Any]] = None, error: Optional[bool] = None, status: Optional[int] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF Info Reader
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
url
class-attribute
instance-attribute
info
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
credits
dataclass
PDFFormsInfoReaderInput(url: str, *, async_: Optional[bool] = None, password: Optional[str] = None, profiles: Optional[str] = None)
PDF Forms Info Reader
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
Password of the PDF file
class-attribute
instance-attribute
Use this parameter to set additional configuration for fine-tuning and extra options, Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFFormsInfoReaderResponse(*, job_id: Optional[str] = None, url: Optional[str] = None, info: Optional[Dict[str, Any]] = None, error: Optional[bool] = None, status: Optional[int] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF Forms Info Reader
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
url
class-attribute
instance-attribute
info
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
credits
dataclass
PDFFindTableInput(url: str, *, pages: Optional[str] = None, inline: Optional[bool] = None, password: Optional[str] = None, profiles: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None)
PDF Find Table
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Password of PDF file
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with /job/check endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
PDFFindTableResponse(*, job_id: Optional[str] = None, url: Optional[str] = None, body: Optional[Dict[str, Any]] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF Find Table
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
url
class-attribute
instance-attribute
body
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
Credits
dataclass
SearchAndReplaceInput(url: str, search_strings: List[str], *, replace_strings: Optional[List[str]] = None, case_sensitive: Optional[bool] = None, replacement_limit: Optional[int] = None, regex: Optional[bool] = None, pages: Optional[str] = None, password: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None)
PDF Search and Replace Text
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Search Strings
class-attribute
instance-attribute
replace_strings: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'replaceStrings'})
Replacement Strings
class-attribute
instance-attribute
replacement_limit: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'replacementLimit'})
Limit the number of searches & replacements for every item. The default value is 0 which means unlimited searches and replacements so every found occurrence will be replaced.
class-attribute
instance-attribute
Set to true to use regular expression for a search string(s).
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
The password of the PDF file
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
SearchAndReplaceResponse(*, url: Optional[str] = None, page_count: Optional[int] = None, job_id: Optional[str] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF Search and Replace Text
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
SearchAndReplaceWithImageInput(url: str, search_string: str, replace_image: str, *, case_sensitive: Optional[bool] = None, pages: Optional[str] = None, async_: Optional[bool] = None, regex: Optional[bool] = None, replacement_limit: Optional[int] = None, expiration: Optional[int] = None, password: Optional[str] = None)
PDF Search and Replace Text with Image
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Single text replacement. Word or phrase to be replaced
class-attribute
instance-attribute
Image URL to be inserted in the doc.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with Job Check module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish..
class-attribute
instance-attribute
replacement_limit: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'replacementLimit'})
Limit the number of searches & replacements for every item. The default value is 0 which means unlimited searches and replacements so every found occurrence will be replaced.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
dataclass
SearchAndReplaceWithImageResponse(*, job_id: Optional[str] = None, url: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF Search and Replace Text with Image
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
url
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
SearchAndDeleteTextInput(url: str, search_strings: List[str], *, case_sensitive: Optional[bool] = None, regex: Optional[bool] = None, replacement_limit: Optional[int] = None, expiration: Optional[int] = None, name: Optional[str] = None, password: Optional[str] = None, pages: Optional[str] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
PDF Search and Delete Text from PDF
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
searchStrings
class-attribute
instance-attribute
Set to true to use regular expression for a search string(s).
class-attribute
instance-attribute
replacement_limit: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'replacementLimit'})
Limit the number of searches & replacements for every item. The default value is 0 which means unlimited searches and replacements so every found occurrence will be replaced.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
Password of the PDF file
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
SearchAndDeleteTextResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF Search and Delete Text from PDF
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFSearchableInput(url: str, *, lang: Optional[str] = None, pages: Optional[str] = None, password: Optional[str] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
Make Scanned PDF to Text Searchable
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is "eng". Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Password of PDF file
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set Async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFSearchableResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Make Scanned PDF to Text Searchable
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFUnSearchableInput(url: str, *, pages: Optional[str] = None, password: Optional[str] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF to Scanned PDF
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Password of PDF file
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set Async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck module to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFUnSearchableResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF to Scanned PDF
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToCSVInput(url: str, *, lang: Optional[str] = None, inline: Optional[bool] = None, unwrap: Optional[str] = None, pages: Optional[str] = None, rect: Optional[str] = None, async_: Optional[bool] = None, name: Optional[str] = None, password: Optional[str] = None, line_grouping: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None)
PDF To CSV
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is "eng". Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
class-attribute
instance-attribute
Unwrap lines into a single line within table cells when lineGrouping is enabled.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
password
class-attribute
instance-attribute
line_grouping: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lineGrouping'})
Line grouping within table cells. Set to 1 to enable the grouping.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
dataclass
PDFToCSVResponse(*, body: Optional[str] = None, url: Optional[str] = None, job_id: Optional[str] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF To CSV
Attributes
class-attribute
instance-attribute
body
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToJSONInput(url: str, *, lang: Optional[str] = None, inline: Optional[bool] = None, unwrap: Optional[str] = None, pages: Optional[str] = None, rect: Optional[str] = None, async_: Optional[bool] = None, name: Optional[str] = None, password: Optional[str] = None, line_grouping: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None)
PDF To JSON
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is "eng". Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
class-attribute
instance-attribute
Unwrap lines into a single line within table cells when lineGrouping is enabled.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
password
class-attribute
instance-attribute
line_grouping: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lineGrouping'})
Line grouping within table cells. Set to 1 to enable the grouping.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
dataclass
PDFToJSONResponse(*, body: Optional[Dict[str, Any]] = None, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF To JSON
Attributes
class-attribute
instance-attribute
body
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToJSONMetaInput(url: str, *, lang: Optional[str] = None, inline: Optional[bool] = None, unwrap: Optional[str] = None, pages: Optional[str] = None, rect: Optional[str] = None, async_: Optional[bool] = None, name: Optional[str] = None, password: Optional[str] = None, line_grouping: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None)
PDF To JSON (AI Powered)
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is "eng". Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
class-attribute
instance-attribute
Unwrap lines into a single line within table cells when lineGrouping is enabled.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
password
class-attribute
instance-attribute
line_grouping: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lineGrouping'})
Line grouping within table cells. Set to 1 to enable the grouping.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
dataclass
PDFToJSONMetaResponse(*, body: Optional[Dict[str, Any]] = None, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF To JSON (AI Powered)
Attributes
class-attribute
instance-attribute
body
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToTextInput(url: str, *, lang: Optional[str] = None, inline: Optional[bool] = None, unwrap: Optional[str] = None, pages: Optional[str] = None, rect: Optional[str] = None, async_: Optional[bool] = None, name: Optional[str] = None, password: Optional[str] = None, line_grouping: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None)
PDF To Text (with layout and ocr)
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is "eng". Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
class-attribute
instance-attribute
Unwrap lines into a single line within table cells when lineGrouping is enabled.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
password
class-attribute
instance-attribute
line_grouping: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lineGrouping'})
Line grouping within table cells. Set to 1 to enable the grouping.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
dataclass
PDFToTextResponse(*, body: Optional[str] = None, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF To Text (with layout and ocr)
Attributes
class-attribute
instance-attribute
body
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToTextSimpleInput(url: str, *, inline: Optional[bool] = None, pages: Optional[str] = None, async_: Optional[bool] = None, name: Optional[str] = None, password: Optional[str] = None, expiration: Optional[int] = None)
PDF To Text (without layout and ocr)
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
password
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
dataclass
PDFToTextSimpleResponse(*, body: Optional[str] = None, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF To Text (without layout and ocr)
Attributes
class-attribute
instance-attribute
body
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToXLSInput(url: str, *, lang: Optional[str] = None, unwrap: Optional[str] = None, pages: Optional[str] = None, rect: Optional[str] = None, async_: Optional[bool] = None, name: Optional[str] = None, password: Optional[str] = None, line_grouping: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None)
PDF To XLS
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is "eng". Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
class-attribute
instance-attribute
Unwrap lines into a single line within table cells when lineGrouping is enabled.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
password
class-attribute
instance-attribute
line_grouping: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lineGrouping'})
Line grouping within table cells. Set to 1 to enable the grouping.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
dataclass
PDFToXLSResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF To XLS
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToXLSXInput(url: str, *, lang: Optional[str] = None, unwrap: Optional[str] = None, pages: Optional[str] = None, rect: Optional[str] = None, async_: Optional[bool] = None, name: Optional[str] = None, password: Optional[str] = None, line_grouping: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None)
PDF To XLSX
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is "eng". Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
class-attribute
instance-attribute
Unwrap lines into a single line within table cells when lineGrouping is enabled.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
password
class-attribute
instance-attribute
line_grouping: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lineGrouping'})
Line grouping within table cells. Set to 1 to enable the grouping.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
dataclass
PDFToXLSXResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF To XLSX
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToXMLInput(url: str, *, inline: Optional[bool] = None, lang: Optional[str] = None, unwrap: Optional[str] = None, pages: Optional[str] = None, rect: Optional[str] = None, async_: Optional[bool] = None, name: Optional[str] = None, password: Optional[str] = None, line_grouping: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None)
PDF To XML
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is "eng". Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is here (https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
class-attribute
instance-attribute
Unwrap lines into a single line within table cells when lineGrouping is enabled.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
password
class-attribute
instance-attribute
line_grouping: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lineGrouping'})
Line grouping within table cells. Set to 1 to enable the grouping.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
This parameter can be used to set additional configurations for fine-tuning and to enable more options. Visit PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples and more.
dataclass
PDFToXMLResponse(*, url: Optional[str] = None, body: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF To XML
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
body
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToJPGInput(url: str, *, inline: Optional[bool] = None, pages: Optional[str] = None, rect: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF to JPG
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
inline
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFToJPGResponse(*, urls: Optional[List[str]] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF to JPG
Attributes
class-attribute
instance-attribute
urls
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToPNGInput(url: str, *, inline: Optional[bool] = None, pages: Optional[str] = None, rect: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF to PNG
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
inline
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFToPNGResponse(*, urls: Optional[List[str]] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF to PNG
Attributes
class-attribute
instance-attribute
urls
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToWEBPInput(url: str, *, inline: Optional[bool] = None, pages: Optional[str] = None, rect: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF to WEBP
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
inline
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFToWEBPResponse(*, urls: Optional[List[str]] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF to WEBP
Attributes
class-attribute
instance-attribute
urls
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFToTIFFInput(url: str, *, inline: Optional[bool] = None, pages: Optional[str] = None, rect: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF to TIFF
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
inline
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Defines coordinates for extraction, e.g. 51.8, 114.8, 235.5, 204.0. Use PDF.co PDF Edit Add Helper (https://app.pdf.co/pdf-edit-add-helper) to get or measure pdf coordinates.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFToTIFFResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF to TIFF
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFFromCSVInput(url: str, *, pages: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF from CSV
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFFromCSVResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF from CSV
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFFromDocInput(url: str, *, pages: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF from Document (Doc, DocX, RTF, TXT, XPS)
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFFromDocResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF from Document (Doc, DocX, RTF, TXT, XPS)
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFFromImagesInput(url: str, *, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF from Image
Attributes
instance-attribute
URL to the source file. Provide multiple URLS in comma separated format. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFFromImagesResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF from Image
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFFromEmailInput(url: str, *, embed_attachments: Optional[bool] = None, convert_attachments: Optional[bool] = None, margins: Optional[str] = None, paper_size: Optional[str] = None, orientation: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF from Email
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
embed_attachments: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'embedAttachments'})
Set to true to automatically embeds all attachments from original input email MSG or EML files into the final output PDF. Set it to false if you don't want to embed attachments so it will convert only the body of the input email.
class-attribute
instance-attribute
convert_attachments: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'convertAttachments'})
Set to false if you don't want to convert attachments from the original email and want to embed them as original files (as embedded pdf attachments). Converts attachments that are supported by API (DOC, DOCx, HTML, PNG, JPG .etc) into PDF and merges into output final PDF. Non-supported file types are added as PDF attachments (Adobe Reader or another viewer may be required to view PDF attachments).
class-attribute
instance-attribute
set to CSS style margins like 10px, 5mm, 5in for all sides or 5px 5px 5px 5px (the order of margins is top, right, bottom, left).
class-attribute
instance-attribute
paper_size: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'paperSize'})
Letter is set by default. Can be Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6 or a custom size. Custom size can be set in px (pixels), mm or in (inches) with width and height separated by space like this: 200 300, 200px 300px, 200mm 300mm, 20cm 30cm or 6in 8in.
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFFromEmailResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF from Email
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFAddSecurityInput(url: str, owner_password: str, *, user_password: Optional[str] = None, encryption_algorithm: Optional[str] = None, allow_accessibility_support: Optional[bool] = None, allow_assembly_document: Optional[bool] = None, allow_print_document: Optional[bool] = None, allow_fill_forms: Optional[bool] = None, allow_modify_document: Optional[bool] = None, allow_content_extraction: Optional[bool] = None, allow_modify_annotations: Optional[bool] = None, print_quality: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF Add Security
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
The main owner password that is used for document encryption and for setting/removing restrictions.
class-attribute
instance-attribute
user_password: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'userPassword'})
The optional user password will be asked for viewing and printing document.
class-attribute
instance-attribute
encryption_algorithm: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'encryptionAlgorithm'})
Encryption algorithm. Valid values: RC4_40bit, RC4_128bit, AES_128bit, AES_256bit. AES_128bit or higher is recommended
class-attribute
instance-attribute
allow_accessibility_support: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowAccessibilitySupport'})
Allow or prohibit content extraction for accessibility needs. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
class-attribute
instance-attribute
allow_assembly_document: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowAssemblyDocument'})
Allow or prohibit assembling the document. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
class-attribute
instance-attribute
allow_print_document: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowPrintDocument'})
Allow or prohibit printing PDF document. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
class-attribute
instance-attribute
allow_fill_forms: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowFillForms'})
Allow or prohibit the filling of interactive form fields (including signature fields) in the PDF documents. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
class-attribute
instance-attribute
allow_modify_document: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowModifyDocument'})
Allow or prohibit modification of PDF document. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
class-attribute
instance-attribute
allow_content_extraction: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowContentExtraction'})
Allow or prohibit copying content from PDF document. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
class-attribute
instance-attribute
allow_modify_annotations: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'allowModifyAnnotations'})
Allow or prohibit interacting with text annotations and forms in PDF document. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
class-attribute
instance-attribute
print_quality: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'printQuality'})
Allowed printing quality. Valid values: HighResolution, LowResolution. Note: this restriction applies when userPassword (if any) is entered. This restriction does not apply if the user enters Owner Password.
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFAddSecurityResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF Add Security
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFSecurityRemoveInput(url: str, password: str, *, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF Remove Security
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
instance-attribute
The owner/user password to open files and remove security features.
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFSecurityRemoveResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF Remove Security
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFFromXLSXLSXInput(url: str, *, worksheet_index: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
PDF From Spreadsheet
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
worksheet_index: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'worksheetIndex'})
Set the WorkSheet index (Default is 0).
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFFromXLSXLSXResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF From Spreadsheet
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
XLStoCSVInput(url: str, *, worksheet_index: Optional[str] = None, quotation_symbol: Optional[str] = None, separator_symbol: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
Spreadsheet to CSV
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
worksheet_index: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'worksheetIndex'})
Set the WorkSheet index (Default is 0).
class-attribute
instance-attribute
quotation_symbol: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'quotationSymbol'})
Set the CSV Quotation Symbol
class-attribute
instance-attribute
separator_symbol: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'separatorSymbol'})
Set the CSV Separator Symbol
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
XLStoCSVResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Spreadsheet to CSV
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
XLStoJSONInput(url: str, *, worksheet_index: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
Spreadsheet to JSON
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
worksheet_index: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'worksheetIndex'})
Set the WorkSheet index (Default is 0).
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
XLStoJSONResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Spreadsheet to JSON
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
XLStoHTMLInput(url: str, *, worksheet_index: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
Spreadsheet to HTML
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
worksheet_index: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'worksheetIndex'})
Set the WorkSheet index (Default is 0).
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
XLStoHTMLResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Spreadsheet to HTML
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
XLStoTXTInput(url: str, *, worksheet_index: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
Spreadsheet to TXT
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
worksheet_index: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'worksheetIndex'})
Set the WorkSheet index (Default is 0).
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
XLStoTXTResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Spreadsheet to TXT
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
XLStoXMLInput(url: str, *, worksheet_index: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)
Spreadsheet to XML
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
worksheet_index: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'worksheetIndex'})
Set the WorkSheet index (Default is 0).
class-attribute
instance-attribute
File name for the generated output.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
class-attribute
instance-attribute
You can set additional and extra options using this parameter that allows you to set custom configuration. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
XLStoXMLResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Spreadsheet to XML
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFRotatePagesInput(url: str, *, angle: Optional[int] = None, pages: Optional[str] = None, expiration: Optional[int] = None, password: Optional[str] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
Rotate PDF Pages
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Angle in degrees. Supported values 90, 180, and 270.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
Password of the PDF file
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
PDFRotatePagesResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Rotate PDF Pages
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFAutoRotatePagesInput(url: str, *, lang: Optional[str] = None, expiration: Optional[int] = None, password: Optional[str] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
Rotate PDF Pages (Auto)
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. The default is "eng". Other languages are also supported: deu, spa, chi_sim, jpn, and many others (full list of supported OCR languages is at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#language-support). You can also use 2 languages simultaneously like this: eng+deu or jpn+kor (any combination).
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
Password of the PDF file
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
PDFAutoRotatePagesResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Rotate PDF Pages (Auto)
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFDeletePagesInput(url: str, *, pages: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
PDF Delete Pages
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Comma-separated list of page indices (or ranges) to process. The very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from the index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document.
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
PDFDeletePagesResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF Delete Pages
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFCompressInput(url: str, *, name: Optional[str] = None, expiration: Optional[int] = None, password: Optional[str] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
PDF Compress and Optimize
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
File name for the generated output
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
Password of the PDF file
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
PDFCompressResponse(*, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for PDF Compress and Optimize
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFClassifierInput(url: str, *, rulescsv: Optional[str] = None, rulescsvurl: Optional[str] = None, case_sensitive: Optional[bool] = None, inline: Optional[bool] = None, expiration: Optional[int] = None, password: Optional[str] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
Document Classifier
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Define custom classification rules in CSV format. Rules are in CSV format where each row contains: "class name, logic (AND or OR (default)), and keywords" separated by a comma. Each row is separated by the \n symbol.
class-attribute
instance-attribute
Instead of inline CSV you can use this parameter and set the URL to a CSV file with classification rules. This is useful if you have a separate developer working on CSV rules.
class-attribute
instance-attribute
case_sensitive: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'caseSensitive'})
Defines if keywords in rules are case-sensitive or not.
class-attribute
instance-attribute
Set to true to return results inside the response. Otherwise, the endpoint will return a link to the output file generated.
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
Password of the PDF file
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
PDFClassifierResponse(*, url: Optional[str] = None, body: Optional[Dict[str, Any]] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Document Classifier
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
body
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
pageCount
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
EmailSendInput(url: str, from_: str, to: str, subject: str, smtpserver: str, smtpport: str, smtpusername: str, smtppassword: str, *, bodytext: Optional[str] = None, bodyhtml: Optional[str] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
Send Email with Attachments
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
The "From" field with sender name and email. Example: John Doe john@example.com
instance-attribute
The "To" field with receiver name and email. Example: Partner partner@example.com
class-attribute
instance-attribute
Plain text version of the outgoing email message.
class-attribute
instance-attribute
HTML version of the outgoing email message.
instance-attribute
SMTP server password, If you use Gmail then you need to generate an app-specific password as instructed at https://support.google.com/accounts/answer/185833.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
EmailSendResponse(*, job_id: Optional[str] = None, error: Optional[bool] = None, status: Optional[int] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Send Email with Attachments
Attributes
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
credits
dataclass
Email Information
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
EmailDecodeResponse(*, url: Optional[str] = None, body: Optional[Dict[str, Any]] = None, job_id: Optional[str] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Email Information
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
body
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
EmailAttachmentExtractionInput(url: str, *, profiles: Optional[str] = None, async_: Optional[bool] = None)
Email Attachment Extraction
Attributes
instance-attribute
URL to the source file. Supports links from Google Drive, Dropbox, and PDF.co built-in files storage.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
class-attribute
instance-attribute
async_: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'async'})
Set async to true for long processes to run in the background, API will then return a jobId which you can use with JobCheck endpoint to check the status of the process and retrieve the output while you can proceed with other tasks without waiting for this process to finish.
dataclass
EmailAttachmentExtractionResponse(*, url: Optional[str] = None, body: Optional[Dict[str, Any]] = None, job_id: Optional[str] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, remaining_credits: Optional[int] = None, duration: Optional[int] = None)
Response for Email Attachment Extraction
Attributes
class-attribute
instance-attribute
url
class-attribute
instance-attribute
body
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
error
class-attribute
instance-attribute
status
class-attribute
instance-attribute
name
class-attribute
instance-attribute
credits
dataclass
PDFAttachmentExtractionInput(url: str, *, inline: Optional[bool] = None, name: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)
PDF Attachment Extraction
Attributes
class-attribute
instance-attribute
Determines whether to return output in response or link to output file.
class-attribute
instance-attribute
Base file name for new PDF files
class-attribute
instance-attribute
Set the expiration time for the output link in minutes (default is 60 i.e 60 minutes or 1 hour), After this specified duration, any generated output file(s) will be automatically deleted from PDF.co temporary files storage. The maximum duration for link expiration varies based on your current subscription plan.
class-attribute
instance-attribute
Use this parameter to set additional configurations for fine-tuning and extra options. Explore PDF.co knowledgebase (https://developer.pdf.co/api/profiles/index.html) for profile examples.
dataclass
PDFAttachmentExtractionResponse(*, urls: Optional[List[str]] = None, url: Optional[str] = None, job_id: Optional[str] = None, page_count: Optional[int] = None, error: Optional[bool] = None, status: Optional[int] = None, name: Optional[str] = None, credits: Optional[int] = None, duration: Optional[int] = None, remaining_credits: Optional[int] = None)
Response for PDF Attachment Extraction
Attributes
class-attribute
instance-attribute
urls
class-attribute
instance-attribute
Output document URL.
class-attribute
instance-attribute
job_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobId'})
jobId
class-attribute
instance-attribute
page_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pageCount'})
Number of pages in the output document.
class-attribute
instance-attribute
Indicates whether the operation is successful or not.
class-attribute
instance-attribute
Status code for HTTP response
class-attribute
instance-attribute
Output document name
class-attribute
instance-attribute
PDF.co credits used for this request
class-attribute
instance-attribute
Request execution duration
PdfcoClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for pdfco connector.
Initialize a PdfcoClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
async
html_to_pdf(input: HtmlToPdfInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
HTML to PDF
Convert HTML code snippet into full featured PDF. Please see api documentation at https://developer.pdf.co/api/pdf-to-html/index.html for comprehensive guidelines.
Swagger operation ID: HtmlToPdf.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
HtmlToPdfInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
url_to_pdf(input: UrlToPdfInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
URL to PDF
Create PDF from URL. Please see api documentation at https://developer.pdf.co/api/pdf-from-url/index.html for comprehensive guidelines.
Swagger operation ID: UrlToPdf.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UrlToPdfInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_filler(input: PdfFillerInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Add Text, Images, Form Fields to PDF
Add text, images, signatures to pdf. Fill PDF form fields and create new pdf from templates. Please see api documentation at https://developer.pdf.co/api/pdf-add/index.html for comprehensive guidelines.
Swagger operation ID: PdfFiller.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PdfFillerInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
merge_pdf_simplified(input: MergePdfSimplifiedInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Merge PDF
Merge PDF from two or more PDF files into a new one. Please see api documentation at https://developer.pdf.co/api/pdf-merge/index.html for comprehensive guidelines.
Swagger operation ID: MergePdfSimplified.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
MergePdfSimplifiedInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
merge_pdf(input: MergePdfInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Merge PDF (Advanced)
Merge PDF from two or more pdf, doc, xls, images, even zip with documents and images into a new PDF. Supports zip, doc, docx, xls, xlsx, rtf, txt, png, jpg. Please see api documentation at https://developer.pdf.co/api/pdf-merge/index.html#post-tag-pdf-merge2 for comprehensive guidelines.
Swagger operation ID: MergePdf.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
MergePdfInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
split_pdf(input: SplitPdfInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Split PDF
Splits pages from PDF document into multiple new PDF files using page numbers and page ranges. Please see api documentation at https://developer.pdf.co/api/pdf-split/index.html for comprehensive guidelines.
Swagger operation ID: SplitPdf.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SplitPdfInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
split_pdf2(input: SplitPdf2Input | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Split PDF (Advanced)
Split PDF into multiple PDF files by text search (support regular expressions) or barcode. Please see api documentation at https://developer.pdf.co/api/pdf-split/index.html#post-tag-pdf-split2 for comprehensive guidelines.
Swagger operation ID: SplitPdf2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SplitPdf2Input | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_search_text(input: PDFSearchTextInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Search Text
Search text in PDF and get coordinates. Supports regular expressions. Please see api documentation at https://developer.pdf.co/api/pdf-find/index.html for comprehensive guidelines.
Swagger operation ID: PDFSearchText.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFSearchTextInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
document_parser(input: DocumentParserInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Document Parser
Document Parser can automatically parse PDF, JPG, and PNG documents to extract fields, tables, values, and barcodes from invoices, statements, orders, and other PDF and scanned documents. Please see api documentation at https://developer.pdf.co/api/document-parser/index.html for comprehensive guidelines.
Swagger operation ID: DocumentParser.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DocumentParserInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
job_check(input: JobCheckInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Background Jobs Check
Checks status of background job that was previously created with PDF.co API. Please see api documentation at https://developer.pdf.co/api/background-job-check/index.html for comprehensive guidelines.
Swagger operation ID: JobCheck.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
JobCheckInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
barcode_generator(input: BarcodeGeneratorInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Barcode Generator
Generate high quality barcode images. Supports QR Code, Datamatrix, Code 39, Code 128, PDF417 and many other barcode types. Please see api documentation at https://developer.pdf.co/api/barcode-generator/index.html for comprehensive guidelines.
Swagger operation ID: BarcodeGenerator.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
BarcodeGeneratorInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
barcode_reader(input: BarcodeReaderInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Barcode Reader
Read barcodes from images and PDF. Can read all popular barcode types from QR Code and Code 128, EAN to Datamatrix, PDF417, GS1 and many other barcodes. Please see api documentation at https://developer.pdf.co/api/barcode-reader/index.html for comprehensive guidelines.
Swagger operation ID: BarcodeReader.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
BarcodeReaderInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_info_reader(input: PDFInfoReaderInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Info Reader
Get detailed information about the PDF document, it's properties and security permissions. Please see api documentation at https://developer.pdf.co/api/pdf-info-reader/index.html for comprehensive guidelines.
Swagger operation ID: PDFInfoReader.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFInfoReaderInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_forms_info_reader(input: PDFFormsInfoReaderInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Forms Info Reader
Get information about fillable fields inside PDF form file. Please see api documentation at https://developer.pdf.co/api/pdf-forms-info-reader/index.html for comprehensive guidelines.
Swagger operation ID: PDFFormsInfoReader.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFFormsInfoReaderInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_find_table(input: PDFFindTableInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Find Table
AI powered document analysis can scan your document for tables and return the array of tables on pages with coordinates and information about columns detected in these tables. Please see api documentation at https://developer.pdf.co/api/pdf-find/index.html#post-tag-pdf-find-table for comprehensive guidelines.
Swagger operation ID: PDFFindTable.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFFindTableInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
search_and_replace(input: SearchAndReplaceInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Search and Replace Text
Modify a PDF file by searching for specific text and replacing it with new text. Please see api documentation at https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text for comprehensive guidelines.
Swagger operation ID: SearchAndReplace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SearchAndReplaceInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
search_and_replace_with_image(input: SearchAndReplaceWithImageInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Search and Replace Text with Image
Replace specific text in a PDF document with an image. Please see api documentation at https://developer.pdf.co/api/pdf-search-and-replace-text/index.html#post-tag-pdf-edit-replace-text-with-image for comprehensive guidelines.
Swagger operation ID: SearchAndReplaceWithImage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SearchAndReplaceWithImageInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
search_and_delete_text(input: SearchAndDeleteTextInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Search and Delete Text from PDF
Search text in PDF and remove found text from PDF. Please see api documentation at https://developer.pdf.co/api/pdf-search-and-delete-text/index.html for comprehensive guidelines.
Swagger operation ID: SearchAndDeleteText.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SearchAndDeleteTextInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_searchable(input: PDFSearchableInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Make Scanned PDF to Text Searchable
Turn PDF and scanned JPG, PNG images into text-searchable PDF. Please see api documentation at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makesearchable for comprehensive guidelines.
Swagger operation ID: PDFSearchable.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFSearchableInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_unsearchable(input: PDFUnSearchableInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF to Scanned PDF
Convert PDF to Scanned PDF. Result PDF is same as if you printed and then scanned your PDF. Please see api documentation at https://developer.pdf.co/api/pdf-make-text-searchable-or-unsearchable/index.html#post-tag-pdf-makeunsearchable for comprehensive guidelines.
Swagger operation ID: PDFUnSearchable.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFUnSearchableInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_csv(input: PDFToCSVInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF To CSV
Convert PDF and scanned images into CSV representation with layout, columns, rows, and tables. Please see api documentation at https://developer.pdf.co/api/pdf-to-csv/index.html for comprehensive guidelines.
Swagger operation ID: PDFToCSV.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToCSVInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_json(input: PDFToJSONInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF To JSON
Convert PDF and scanned images into JSON representation with text, fonts, images, vectors, and formatting preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-json/index.html for comprehensive guidelines.
Swagger operation ID: PDFToJSON.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToJSONInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_json_meta(input: PDFToJSONMetaInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF To JSON (AI Powered)
Convert PDF and scanned images into JSON representation with text, fonts, images, vectors, and formatting preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-json/index.html#post-tag-pdf-convert-to-json-meta for comprehensive guidelines.
Swagger operation ID: PDFToJSONMeta.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToJSONMetaInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_text(input: PDFToTextInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF To Text (with layout and ocr)
Convert PDF and scanned images to Text with layout preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-text/index.html for comprehensive guidelines.
Swagger operation ID: PDFToText.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToTextInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_text_simple(input: PDFToTextSimpleInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF To Text (without layout and ocr)
Convert PDF to plain text without layout preserved and OCR support. Please see api documentation at https://developer.pdf.co/api/pdf-to-text/index.html#post-tag-pdf-convert-to-text-simple for comprehensive guidelines.
Swagger operation ID: PDFToTextSimple.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToTextSimpleInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_xls(input: PDFToXLSInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF To XLS
Convert PDF and scanned images to spreadsheet with layout and fonts preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xls for comprehensive guidelines.
Swagger operation ID: PDFToXLS.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToXLSInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_xlsx(input: PDFToXLSXInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF To XLSX
Convert PDF and scanned images to spreadsheet with layout and fonts preserved. Please see api documentation at https://developer.pdf.co/api/pdf-to-excel/index.html#post-tag-pdf-convert-to-xlsx for comprehensive guidelines.
Swagger operation ID: PDFToXLSX.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToXLSXInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_xml(input: PDFToXMLInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF To XML
Convert PDF to XML with information about text value, tables, fonts, images, objects positions. Please see api documentation at https://developer.pdf.co/api/pdf-to-xml/index.html for comprehensive guidelines.
Swagger operation ID: PDFToXML.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToXMLInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_jpg(input: PDFToJPGInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF to JPG
PDF to JPG conversion. High-quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-jpg for comprehensive guidelines.
Swagger operation ID: PDFToJPG.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToJPGInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_png(input: PDFToPNGInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF to PNG
PDF to PNG conversion. High-quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-png for comprehensive guidelines.
Swagger operation ID: PDFToPNG.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToPNGInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_webp(input: PDFToWEBPInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF to WEBP
PDF to WEBP conversion. High-quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-webp for comprehensive guidelines.
Swagger operation ID: PDFToWEBP.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToWEBPInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_to_tiff(input: PDFToTIFFInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF to TIFF
PDF to high quality TIFF images conversion. High quality rendering. Also works great for thumbnail generation and previews. Please see api documentation at https://developer.pdf.co/api/pdf-to-image/index.html#post-tag-pdf-convert-to-tiff for comprehensive guidelines.
Swagger operation ID: PDFToTIFF.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFToTIFFInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_from_csv(input: PDFFromCSVInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF from CSV
Convert CSV document to PDF. Works also with XLS or XLSX input. Please see api documentation at https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-csv for comprehensive guidelines.
Swagger operation ID: PDFFromCSV.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFFromCSVInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_from_doc(input: PDFFromDocInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF from Document (Doc, DocX, RTF, TXT, XPS)
Convert DOC, DOCX, RTF, TXT, XPS files into PDF. Please see api documentation at https://developer.pdf.co/api/pdf-from-document/index.html#post-tag-pdf-convert-from-doc for comprehensive guidelines.
Swagger operation ID: PDFFromDoc.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFFromDocInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_from_images(input: PDFFromImagesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF from Image
Create a PDF file from one or more JPG, PNG, TIFF images. Please see api documentation at https://developer.pdf.co/api/pdf-from-image/index.html for comprehensive guidelines.
Swagger operation ID: PDFFromImages.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFFromImagesInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_from_email(input: PDFFromEmailInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF from Email
Convert email files (MSG or EML) code into PDF. Extracts attachments (if any) from input email and embeds into PDF as pdf attachments. Please see api documentation at https://developer.pdf.co/api/pdf-from-email/index.html for comprehensive guidelines.
Swagger operation ID: PDFFromEmail.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFFromEmailInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_add_security(input: PDFAddSecurityInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Add Security
Add password and security limitations to existing PDF. Please see api documentation at https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-add for comprehensive guidelines.
Swagger operation ID: PDFAddSecurity.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFAddSecurityInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_security_remove(input: PDFSecurityRemoveInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Remove Security
Remove password and security from existing PDF files. Please see api documentation at https://developer.pdf.co/api/password-and-security/index.html#post-tag-pdf-security-remove for comprehensive guidelines.
Swagger operation ID: PDFSecurityRemove.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFSecurityRemoveInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_from_xls_xlsx(input: PDFFromXLSXLSXInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF From Spreadsheet
Create PDF from XLS, XLSX spreadsheet. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-pdf for comprehensive guidelines.
Swagger operation ID: PDFFromXLSXLSX.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFFromXLSXLSXInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
xls_to_csv(input: XLStoCSVInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Spreadsheet to CSV
Convert XLS/XLSX into CSV comma separated values file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-csv for comprehensive guidelines.
Swagger operation ID: XLStoCSV.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
XLStoCSVInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
xls_to_json(input: XLStoJSONInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Spreadsheet to JSON
Convert XLS/XLSX into JSON file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-json for comprehensive guidelines.
Swagger operation ID: XLStoJSON.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
XLStoJSONInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
xls_to_html(input: XLStoHTMLInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Spreadsheet to HTML
Convert XLS/XLSX into HTML file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-html for comprehensive guidelines.
Swagger operation ID: XLStoHTML.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
XLStoHTMLInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
xls_to_txt(input: XLStoTXTInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Spreadsheet to TXT
Convert XLS/XLSX or CSV into Text file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-txt for comprehensive guidelines.
Swagger operation ID: XLStoTXT.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
XLStoTXTInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
xls_to_xml(input: XLStoXMLInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Spreadsheet to XML
Convert XLS/XLSX or CSV into XML file. Please see api documentation at https://developer.pdf.co/api/convert-excel/index.html#post-tag-xls-convert-to-xml for comprehensive guidelines.
Swagger operation ID: XLStoXML.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
XLStoXMLInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_rotate_pages(input: PDFRotatePagesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Rotate PDF Pages
Rotate PDF Pages. Please see api documentation at https://developer.pdf.co/api/pdf-rotate-pages/index.html for comprehensive guidelines.
Swagger operation ID: PDFRotatePages.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFRotatePagesInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_auto_rotate_pages(input: PDFAutoRotatePagesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Rotate PDF Pages (Auto)
Uses AI to automatically fix the rotation of pages inside scanned PDF based on text analysis. Please see api documentation at https://developer.pdf.co/api/pdf-rotate-pages/index.html#post-tag-pdf-edit-rotate-auto for comprehensive guidelines.
Swagger operation ID: PDFAutoRotatePages.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFAutoRotatePagesInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_delete_pages(input: PDFDeletePagesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Delete Pages
Delete pages in PDF. Please see api documentation at https://developer.pdf.co/api/pdf-delete-pages/index.html for comprehensive guidelines.
Swagger operation ID: PDFDeletePages.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFDeletePagesInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_compress(input: PDFCompressInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Compress and Optimize
Optimize PDF document to reduce its size. Please see api documentation at https://developer.pdf.co/api/pdf-optimize/index.html for comprehensive guidelines.
Swagger operation ID: PDFCompress.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFCompressInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_classifier(input: PDFClassifierInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Document Classifier
Auto classification Of Incoming Documents based on keywords-based rules. For example, you can define rules to find which vendor provided the document to find which template to apply accordingly. Please see api documentation at https://developer.pdf.co/api/document-classifier/index.html for comprehensive guidelines.
Swagger operation ID: PDFClassifier.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFClassifierInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
email_send(input: EmailSendInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Send Email with Attachments
Send Email with Attachments. Please see api documentation at https://developer.pdf.co/api/email-send-and-decode/index.html for comprehensive guidelines.
Swagger operation ID: EmailSend.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
EmailSendInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
email_decode(input: EmailDecodeInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Email Information
Get Email Information such as sender/recipient, subject, body, etc. Please see api documentation at https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-decode for comprehensive guidelines.
Swagger operation ID: EmailDecode.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
EmailDecodeInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
email_attachment_extraction(input: EmailAttachmentExtractionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Email Attachment Extraction
Extract Email attachments with basic email information. Please see api documentation at https://developer.pdf.co/api/email-send-and-decode/index.html#post-tag-email-extract-attachments for comprehensive guidelines.
Swagger operation ID: EmailAttachmentExtraction.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
EmailAttachmentExtractionInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
pdf_attachment_extraction(input: PDFAttachmentExtractionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
PDF Attachment Extraction
Extract attachments from input PDF document. Please see api documentation at https://developer.pdf.co/api/extract-attachments/index.html for comprehensive guidelines.
Swagger operation ID: PDFAttachmentExtraction.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PDFAttachmentExtractionInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |