PdfcoClient

Classes

HtmlToPdfInput dataclass

HtmlToPdfInput(html: Optional[str] = None, 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

html class-attribute instance-attribute

html: Optional[str] = None

Input HTML code to be converted.

name class-attribute instance-attribute

name: Optional[str] = None

Base file name for new PDF files.

margins class-attribute instance-attribute

margins: Optional[str] = None

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.

paper_size class-attribute instance-attribute

paper_size: Optional[str] = field(default=None, 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.

orientation class-attribute instance-attribute

orientation: Optional[str] = None

PDF page orientation.

print_background class-attribute instance-attribute

print_background: Optional[bool] = field(default=None, metadata={'wire_name': 'printBackground'})

Enable or disable printing of document background

header class-attribute instance-attribute

header: Optional[str] = None

Set to HTML for header to be applied on every page at the header.

footer class-attribute instance-attribute

footer: Optional[str] = None

Set to HTML for footer to be applied on every page at the bottom.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

HtmlToPdfResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

Output document URL.

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

Number of pages in the output document.

error class-attribute instance-attribute

error: Optional[bool] = None

Indicates whether the operation is successful or not.

status class-attribute instance-attribute

status: Optional[int] = None

Status code for HTTP response

name class-attribute instance-attribute

name: Optional[str] = None

Output document name

credits class-attribute instance-attribute

credits: Optional[int] = None

PDF.co credits used for this request

duration class-attribute instance-attribute

duration: Optional[int] = None

Request execution duration

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

PDF.co account remaining credits

UrlToPdfInput dataclass

UrlToPdfInput(url: 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)

URL to PDF

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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.

margins class-attribute instance-attribute

margins: Optional[str] = None

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).

paper_size class-attribute instance-attribute

paper_size: Optional[str] = field(default=None, 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.

orientation class-attribute instance-attribute

orientation: Optional[str] = None

Output page orientation

print_background class-attribute instance-attribute

print_background: Optional[bool] = field(default=None, metadata={'wire_name': 'printBackground'})

Enable or disable printing of document background

header class-attribute instance-attribute

header: Optional[str] = None

Set to HTML for header to be applied on every page at the header.

footer class-attribute instance-attribute

footer: Optional[str] = None

Set to HTML for footer to be applied on every page at the bottom.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

UrlToPdfResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

Output document URL.

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

Number of pages in the output document.

error class-attribute instance-attribute

error: Optional[bool] = None

Indicates whether the operation is successful or not.

status class-attribute instance-attribute

status: Optional[int] = None

Status code for HTTP response

name class-attribute instance-attribute

name: Optional[str] = None

Output document name

credits class-attribute instance-attribute

credits: Optional[int] = None

PDF.co credits used for this request

duration class-attribute instance-attribute

duration: Optional[int] = None

Request execution duration

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

PDF.co account remaining credits

PdfFillerInput dataclass

PdfFillerInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

Url to the input PDF document

annotations_string class-attribute instance-attribute

annotations_string: Optional[str] = field(default=None, 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.

images_string class-attribute instance-attribute

images_string: Optional[str] = field(default=None, 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.

fields_string class-attribute instance-attribute

fields_string: Optional[str] = field(default=None, 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.

name class-attribute instance-attribute

name: Optional[str] = None

Output PDF Name

inline class-attribute instance-attribute

inline: Optional[bool] = None

Determines whether to return output in response or link to output file.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

PdfFillerResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

Output document URL.

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

Number of pages in the output document.

error class-attribute instance-attribute

error: Optional[bool] = None

Indicates whether the operation is successful or not.

status class-attribute instance-attribute

status: Optional[int] = None

Status code for HTTP response

name class-attribute instance-attribute

name: Optional[str] = None

Output document name

credits class-attribute instance-attribute

credits: Optional[int] = None

PDF.co credits used for this request

duration class-attribute instance-attribute

duration: Optional[int] = None

Request execution duration

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

PDF.co account remaining credits

MergePdfSimplifiedInput dataclass

MergePdfSimplifiedInput(url: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)

Merge PDF

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

MergePdfSimplifiedResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

Output document URL.

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

Number of pages in the output document.

error class-attribute instance-attribute

error: Optional[bool] = None

Indicates whether the operation is successful or not.

status class-attribute instance-attribute

status: Optional[int] = None

Status code for HTTP response

name class-attribute instance-attribute

name: Optional[str] = None

Output document name

credits class-attribute instance-attribute

credits: Optional[int] = None

PDF.co credits used for this request

duration class-attribute instance-attribute

duration: Optional[int] = None

Request execution duration

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

PDF.co account remaining credits

MergePdfInput dataclass

MergePdfInput(url: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)

Merge PDF (Advanced)

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

MergePdfResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

Output document URL.

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

Number of pages in the output document.

error class-attribute instance-attribute

error: Optional[bool] = None

Indicates whether the operation is successful or not.

status class-attribute instance-attribute

status: Optional[int] = None

Status code for HTTP response

name class-attribute instance-attribute

name: Optional[str] = None

Output document name

credits class-attribute instance-attribute

credits: Optional[int] = None

PDF.co credits used for this request

duration class-attribute instance-attribute

duration: Optional[int] = None

Request execution duration

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

PDF.co account remaining credits

SplitPdfInput dataclass

SplitPdfInput(url: Optional[str] = None, pages: 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

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

Url to the source PDF document

pages class-attribute instance-attribute

pages: Optional[str] = None

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 *.

inline class-attribute instance-attribute

inline: Optional[bool] = None

Determines whether to return output in response or link to output file.

name class-attribute instance-attribute

name: Optional[str] = None

Base file name for new PDF files

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, metadata={'wire_name': 'async'})

Creates a background processing job.

SplitPdfResponse 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

urls class-attribute instance-attribute

urls: Optional[List[str]] = None

urls

url class-attribute instance-attribute

url: Optional[str] = None

Output document URL.

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

Number of pages in the output document.

error class-attribute instance-attribute

error: Optional[bool] = None

Indicates whether the operation is successful or not.

status class-attribute instance-attribute

status: Optional[int] = None

Status code for HTTP response

name class-attribute instance-attribute

name: Optional[str] = None

Output document name

credits class-attribute instance-attribute

credits: Optional[int] = None

PDF.co credits used for this request

duration class-attribute instance-attribute

duration: Optional[int] = None

Request execution duration

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

PDF.co account remaining credits

SplitPdf2Input dataclass

SplitPdf2Input(url: Optional[str] = None, search_string: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

Url to the source PDF document

search_string class-attribute instance-attribute

search_string: Optional[str] = field(default=None, metadata={'wire_name': 'searchString'})

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

exclude_key_pages class-attribute instance-attribute

exclude_key_pages: Optional[bool] = field(default=None, metadata={'wire_name': 'excludeKeyPages'})

Set to true if you want to exclude pages where text was found

regex_search class-attribute instance-attribute

regex_search: Optional[bool] = field(default=None, metadata={'wire_name': 'regexSearch'})

Set to true to enable regular expressions for the search string

case_sensitive class-attribute instance-attribute

case_sensitive: Optional[bool] = field(default=None, metadata={'wire_name': 'caseSensitive'})

Set to true to enable case-sensitive search.

lang class-attribute instance-attribute

lang: Optional[str] = None

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).

inline class-attribute instance-attribute

inline: Optional[bool] = None

Determines whether to return output in response or link to output file.

name class-attribute instance-attribute

name: Optional[str] = None

Base file name for new PDF files

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, metadata={'wire_name': 'async'})

Creates a background processing job.

SplitPdf2Response 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

urls class-attribute instance-attribute

urls: Optional[List[str]] = None

urls

url class-attribute instance-attribute

url: Optional[str] = None

Output document URL.

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

Number of pages in the output document.

error class-attribute instance-attribute

error: Optional[bool] = None

Indicates whether the operation is successful or not.

status class-attribute instance-attribute

status: Optional[int] = None

Status code for HTTP response

name class-attribute instance-attribute

name: Optional[str] = None

Output document name

credits class-attribute instance-attribute

credits: Optional[int] = None

PDF.co credits used for this request

duration class-attribute instance-attribute

duration: Optional[int] = None

Request execution duration

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

PDF.co account remaining credits

PDFSearchTextInput dataclass

PDFSearchTextInput(url: Optional[str] = None, search_string: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

search_string class-attribute instance-attribute

search_string: Optional[str] = field(default=None, metadata={'wire_name': 'searchString'})

Text to search can support regular expressions if you set the "Regex Search" parameter to true.

name class-attribute instance-attribute

name: Optional[str] = None

name

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

word_matching_mode class-attribute instance-attribute

word_matching_mode: Optional[str] = field(default=None, metadata={'wire_name': 'wordMatchingMode'})

Values can be either 'SmartMatch', 'ExactMatch', or 'None'.

password class-attribute instance-attribute

password: Optional[str] = None

Password of the PDF file

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFSearchTextResponse 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

body class-attribute instance-attribute

body: Optional[List[Dict[str, Any]]] = None

body

url class-attribute instance-attribute

url: Optional[str] = None

url

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

DocumentParserInput dataclass

DocumentParserInput(url: Optional[str] = None, template_id: Optional[str] = None, output_format: 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

url class-attribute instance-attribute

url: Optional[str] = None

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

template_id class-attribute instance-attribute

template_id: Optional[str] = field(default=None, 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

output_format class-attribute instance-attribute

output_format: Optional[str] = field(default=None, metadata={'wire_name': 'outputFormat'})

Default is JSON. You can override the default output format to CSV or XML to generate CSV or XML output accordingly.

inline class-attribute instance-attribute

inline: Optional[bool] = None

Set to true to return results inside the response. Otherwise, the endpoint will return a link to the output file generated

password class-attribute instance-attribute

password: Optional[str] = None

Password of PDF file

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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,

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

DocumentParserResponse 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)

Response for Document Parser

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

Output URL

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = None

body

JobCheckInput dataclass

JobCheckInput(jobid: Optional[str] = None)

Background Jobs Check

Attributes

jobid class-attribute instance-attribute

jobid: Optional[str] = None

PDF.co background Job Id

JobCheckResponse 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

status class-attribute instance-attribute

status: Optional[str] = None

status

message class-attribute instance-attribute

message: Optional[str] = None

message

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

job_duration class-attribute instance-attribute

job_duration: Optional[int] = field(default=None, metadata={'wire_name': 'jobDuration'})

jobDuration

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

error class-attribute instance-attribute

error: Optional[bool] = None

error

error_code class-attribute instance-attribute

error_code: Optional[int] = field(default=None, metadata={'wire_name': 'errorCode'})

errorCode

BarcodeGeneratorInput dataclass

BarcodeGeneratorInput(name: Optional[str] = None, value: Optional[str] = None, type_: Optional[str] = None, decoration_image: Optional[str] = None, async_: Optional[bool] = None, expiration: Optional[int] = None, profiles: Optional[str] = None)

Barcode Generator

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

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.

value class-attribute instance-attribute

value: Optional[str] = None

Set the string value to encode inside the barcode.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Set the barcode type, QRCode By default.

decoration_image class-attribute instance-attribute

decoration_image: Optional[str] = field(default=None, metadata={'wire_name': 'decorationImage'})

Set this to the image that you want to be inserted the logo inside the QR-Code barcode.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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

BarcodeGeneratorResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

url class-attribute instance-attribute

url: Optional[str] = None

url

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

BarcodeReaderInput dataclass

BarcodeReaderInput(url: Optional[str] = None, types: Optional[str] = None, pages: Optional[str] = None, encrypt: Optional[bool] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)

Barcode Reader

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

types class-attribute instance-attribute

types: Optional[str] = None

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.

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

encrypt class-attribute instance-attribute

encrypt: Optional[bool] = None

encrypt

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

BarcodeReaderResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

url class-attribute instance-attribute

url: Optional[str] = None

url

barcodes class-attribute instance-attribute

barcodes: Optional[List[Dict[str, Any]]] = None

barcodes

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFInfoReaderInput dataclass

PDFInfoReaderInput(url: Optional[str] = None, async_: Optional[bool] = None, password: Optional[str] = None, profiles: Optional[str] = None)

PDF Info Reader

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

password class-attribute instance-attribute

password: Optional[str] = None

Password of the PDF file

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFInfoReaderResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

url class-attribute instance-attribute

url: Optional[str] = None

url

info class-attribute instance-attribute

info: Optional[Dict[str, Any]] = None

info

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFFormsInfoReaderInput dataclass

PDFFormsInfoReaderInput(url: Optional[str] = None, async_: Optional[bool] = None, password: Optional[str] = None, profiles: Optional[str] = None)

PDF Forms Info Reader

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

password class-attribute instance-attribute

password: Optional[str] = None

Password of the PDF file

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFFormsInfoReaderResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

url class-attribute instance-attribute

url: Optional[str] = None

url

info class-attribute instance-attribute

info: Optional[Dict[str, Any]] = None

info

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFFindTableInput dataclass

PDFFindTableInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

password class-attribute instance-attribute

password: Optional[str] = None

Password of PDF file

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

PDFFindTableResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

url class-attribute instance-attribute

url: Optional[str] = None

url

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = None

body

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

Credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

SearchAndReplaceInput dataclass

SearchAndReplaceInput(url: Optional[str] = None, search_strings: Optional[List[str]] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

search_strings class-attribute instance-attribute

search_strings: Optional[List[str]] = field(default=None, metadata={'wire_name': 'searchStrings'})

Search Strings

replace_strings class-attribute instance-attribute

replace_strings: Optional[List[str]] = field(default=None, metadata={'wire_name': 'replaceStrings'})

Replacement Strings

replacement_limit class-attribute instance-attribute

replacement_limit: Optional[int] = field(default=None, 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.

regex class-attribute instance-attribute

regex: Optional[bool] = None

Set to true to use regular expression for a search string(s).

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

password class-attribute instance-attribute

password: Optional[str] = None

The password of the PDF file

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

SearchAndReplaceResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

SearchAndReplaceWithImageInput dataclass

SearchAndReplaceWithImageInput(url: Optional[str] = None, case_sensitive: Optional[bool] = None, search_string: Optional[str] = None, replace_image: Optional[str] = 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

url class-attribute instance-attribute

url: Optional[str] = None

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

search_string class-attribute instance-attribute

search_string: Optional[str] = field(default=None, metadata={'wire_name': 'searchString'})

Single text replacement. Word or phrase to be replaced

replace_image class-attribute instance-attribute

replace_image: Optional[str] = field(default=None, metadata={'wire_name': 'replaceImage'})

Image URL to be inserted in the doc.

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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..

replacement_limit class-attribute instance-attribute

replacement_limit: Optional[int] = field(default=None, 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.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

password class-attribute instance-attribute

password: Optional[str] = None

Password of the PDF file

SearchAndReplaceWithImageResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

url class-attribute instance-attribute

url: Optional[str] = None

url

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

SearchAndDeleteTextInput dataclass

SearchAndDeleteTextInput(url: Optional[str] = None, search_strings: Optional[List[str]] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

search_strings class-attribute instance-attribute

search_strings: Optional[List[str]] = field(default=None, metadata={'wire_name': 'searchStrings'})

searchStrings

regex class-attribute instance-attribute

regex: Optional[bool] = None

Set to true to use regular expression for a search string(s).

replacement_limit class-attribute instance-attribute

replacement_limit: Optional[int] = field(default=None, 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.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

password class-attribute instance-attribute

password: Optional[str] = None

Password of the PDF file

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

SearchAndDeleteTextResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFSearchableInput dataclass

PDFSearchableInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

lang class-attribute instance-attribute

lang: Optional[str] = None

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).

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

password class-attribute instance-attribute

password: Optional[str] = None

Password of PDF file

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFSearchableResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFUnSearchableInput dataclass

PDFUnSearchableInput(url: Optional[str] = None, pages: Optional[str] = None, password: Optional[str] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)

PDF to Scanned PDF

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

password class-attribute instance-attribute

password: Optional[str] = None

Password of PDF file

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFUnSearchableResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToCSVInput dataclass

PDFToCSVInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

lang class-attribute instance-attribute

lang: Optional[str] = None

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).

unwrap class-attribute instance-attribute

unwrap: Optional[str] = None

Unwrap lines into a single line within table cells when lineGrouping is enabled.

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

rect class-attribute instance-attribute

rect: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

password class-attribute instance-attribute

password: Optional[str] = None

password

line_grouping class-attribute instance-attribute

line_grouping: Optional[str] = field(default=None, metadata={'wire_name': 'lineGrouping'})

Line grouping within table cells. Set to 1 to enable the grouping.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFToCSVResponse 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

body class-attribute instance-attribute

body: Optional[str] = None

body

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToJSONInput dataclass

PDFToJSONInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

lang class-attribute instance-attribute

lang: Optional[str] = None

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).

unwrap class-attribute instance-attribute

unwrap: Optional[str] = None

Unwrap lines into a single line within table cells when lineGrouping is enabled.

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

rect class-attribute instance-attribute

rect: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

password class-attribute instance-attribute

password: Optional[str] = None

password

line_grouping class-attribute instance-attribute

line_grouping: Optional[str] = field(default=None, metadata={'wire_name': 'lineGrouping'})

Line grouping within table cells. Set to 1 to enable the grouping.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFToJSONResponse 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

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = None

body

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToJSONMetaInput dataclass

PDFToJSONMetaInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

lang class-attribute instance-attribute

lang: Optional[str] = None

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).

unwrap class-attribute instance-attribute

unwrap: Optional[str] = None

Unwrap lines into a single line within table cells when lineGrouping is enabled.

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

rect class-attribute instance-attribute

rect: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

password class-attribute instance-attribute

password: Optional[str] = None

password

line_grouping class-attribute instance-attribute

line_grouping: Optional[str] = field(default=None, metadata={'wire_name': 'lineGrouping'})

Line grouping within table cells. Set to 1 to enable the grouping.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFToJSONMetaResponse 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

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = None

body

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToTextInput dataclass

PDFToTextInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

lang class-attribute instance-attribute

lang: Optional[str] = None

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).

unwrap class-attribute instance-attribute

unwrap: Optional[str] = None

Unwrap lines into a single line within table cells when lineGrouping is enabled.

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

rect class-attribute instance-attribute

rect: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

password class-attribute instance-attribute

password: Optional[str] = None

password

line_grouping class-attribute instance-attribute

line_grouping: Optional[str] = field(default=None, metadata={'wire_name': 'lineGrouping'})

Line grouping within table cells. Set to 1 to enable the grouping.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFToTextResponse 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

body class-attribute instance-attribute

body: Optional[str] = None

body

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToTextSimpleInput dataclass

PDFToTextSimpleInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

password class-attribute instance-attribute

password: Optional[str] = None

password

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

PDFToTextSimpleResponse 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

body class-attribute instance-attribute

body: Optional[str] = None

body

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToXLSInput dataclass

PDFToXLSInput(url: Optional[str] = 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 XLS

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

lang class-attribute instance-attribute

lang: Optional[str] = None

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).

unwrap class-attribute instance-attribute

unwrap: Optional[str] = None

Unwrap lines into a single line within table cells when lineGrouping is enabled.

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

rect class-attribute instance-attribute

rect: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

password class-attribute instance-attribute

password: Optional[str] = None

password

line_grouping class-attribute instance-attribute

line_grouping: Optional[str] = field(default=None, metadata={'wire_name': 'lineGrouping'})

Line grouping within table cells. Set to 1 to enable the grouping.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFToXLSResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToXLSXInput dataclass

PDFToXLSXInput(url: Optional[str] = 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 XLSX

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

lang class-attribute instance-attribute

lang: Optional[str] = None

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).

unwrap class-attribute instance-attribute

unwrap: Optional[str] = None

Unwrap lines into a single line within table cells when lineGrouping is enabled.

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

rect class-attribute instance-attribute

rect: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

password class-attribute instance-attribute

password: Optional[str] = None

password

line_grouping class-attribute instance-attribute

line_grouping: Optional[str] = field(default=None, metadata={'wire_name': 'lineGrouping'})

Line grouping within table cells. Set to 1 to enable the grouping.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFToXLSXResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToXMLInput dataclass

PDFToXMLInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

lang class-attribute instance-attribute

lang: Optional[str] = None

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).

unwrap class-attribute instance-attribute

unwrap: Optional[str] = None

Unwrap lines into a single line within table cells when lineGrouping is enabled.

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

rect class-attribute instance-attribute

rect: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

password class-attribute instance-attribute

password: Optional[str] = None

password

line_grouping class-attribute instance-attribute

line_grouping: Optional[str] = field(default=None, metadata={'wire_name': 'lineGrouping'})

Line grouping within table cells. Set to 1 to enable the grouping.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFToXMLResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

body class-attribute instance-attribute

body: Optional[str] = None

body

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToJPGInput dataclass

PDFToJPGInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

inline class-attribute instance-attribute

inline: Optional[bool] = None

inline

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

rect class-attribute instance-attribute

rect: Optional[str] = None

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.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFToJPGResponse 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

urls class-attribute instance-attribute

urls: Optional[List[str]] = None

urls

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToPNGInput dataclass

PDFToPNGInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

inline class-attribute instance-attribute

inline: Optional[bool] = None

inline

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

rect class-attribute instance-attribute

rect: Optional[str] = None

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.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFToPNGResponse 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

urls class-attribute instance-attribute

urls: Optional[List[str]] = None

urls

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToWEBPInput dataclass

PDFToWEBPInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

inline class-attribute instance-attribute

inline: Optional[bool] = None

inline

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

rect class-attribute instance-attribute

rect: Optional[str] = None

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.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFToWEBPResponse 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

urls class-attribute instance-attribute

urls: Optional[List[str]] = None

urls

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFToTIFFInput dataclass

PDFToTIFFInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

inline class-attribute instance-attribute

inline: Optional[bool] = None

inline

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

rect class-attribute instance-attribute

rect: Optional[str] = None

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.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFToTIFFResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFFromCSVInput dataclass

PDFFromCSVInput(url: Optional[str] = None, pages: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)

PDF from CSV

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFFromCSVResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFFromDocInput dataclass

PDFFromDocInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFFromDocResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFFromImagesInput dataclass

PDFFromImagesInput(url: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)

PDF from Image

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFFromImagesResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFFromEmailInput dataclass

PDFFromEmailInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

embed_attachments class-attribute instance-attribute

embed_attachments: Optional[bool] = field(default=None, 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.

convert_attachments class-attribute instance-attribute

convert_attachments: Optional[bool] = field(default=None, 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).

margins class-attribute instance-attribute

margins: Optional[str] = None

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).

paper_size class-attribute instance-attribute

paper_size: Optional[str] = field(default=None, 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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFFromEmailResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFAddSecurityInput dataclass

PDFAddSecurityInput(url: Optional[str] = None, owner_password: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

owner_password class-attribute instance-attribute

owner_password: Optional[str] = field(default=None, metadata={'wire_name': 'ownerPassword'})

The main owner password that is used for document encryption and for setting/removing restrictions.

user_password class-attribute instance-attribute

user_password: Optional[str] = field(default=None, metadata={'wire_name': 'userPassword'})

The optional user password will be asked for viewing and printing document.

encryption_algorithm class-attribute instance-attribute

encryption_algorithm: Optional[str] = field(default=None, metadata={'wire_name': 'encryptionAlgorithm'})

Encryption algorithm. Valid values: RC4_40bit, RC4_128bit, AES_128bit, AES_256bit. AES_128bit or higher is recommended

allow_accessibility_support class-attribute instance-attribute

allow_accessibility_support: Optional[bool] = field(default=None, 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.

allow_assembly_document class-attribute instance-attribute

allow_assembly_document: Optional[bool] = field(default=None, 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.

allow_print_document class-attribute instance-attribute

allow_print_document: Optional[bool] = field(default=None, 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.

allow_fill_forms class-attribute instance-attribute

allow_fill_forms: Optional[bool] = field(default=None, 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.

allow_modify_document class-attribute instance-attribute

allow_modify_document: Optional[bool] = field(default=None, 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.

allow_content_extraction class-attribute instance-attribute

allow_content_extraction: Optional[bool] = field(default=None, 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.

allow_modify_annotations class-attribute instance-attribute

allow_modify_annotations: Optional[bool] = field(default=None, 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.

print_quality class-attribute instance-attribute

print_quality: Optional[str] = field(default=None, 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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFAddSecurityResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFSecurityRemoveInput dataclass

PDFSecurityRemoveInput(url: Optional[str] = None, password: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, async_: Optional[bool] = None, profiles: Optional[str] = None)

PDF Remove Security

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

password class-attribute instance-attribute

password: Optional[str] = None

The owner/user password to open files and remove security features.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFSecurityRemoveResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFFromXLSXLSXInput dataclass

PDFFromXLSXLSXInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

worksheet_index class-attribute instance-attribute

worksheet_index: Optional[str] = field(default=None, metadata={'wire_name': 'worksheetIndex'})

Set the WorkSheet index (Default is 0).

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

PDFFromXLSXLSXResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

XLStoCSVInput dataclass

XLStoCSVInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

worksheet_index class-attribute instance-attribute

worksheet_index: Optional[str] = field(default=None, metadata={'wire_name': 'worksheetIndex'})

Set the WorkSheet index (Default is 0).

quotation_symbol class-attribute instance-attribute

quotation_symbol: Optional[str] = field(default=None, metadata={'wire_name': 'quotationSymbol'})

Set the CSV Quotation Symbol

separator_symbol class-attribute instance-attribute

separator_symbol: Optional[str] = field(default=None, metadata={'wire_name': 'separatorSymbol'})

Set the CSV Separator Symbol

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

XLStoCSVResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

XLStoJSONInput dataclass

XLStoJSONInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

worksheet_index class-attribute instance-attribute

worksheet_index: Optional[str] = field(default=None, metadata={'wire_name': 'worksheetIndex'})

Set the WorkSheet index (Default is 0).

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

XLStoJSONResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

XLStoHTMLInput dataclass

XLStoHTMLInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

worksheet_index class-attribute instance-attribute

worksheet_index: Optional[str] = field(default=None, metadata={'wire_name': 'worksheetIndex'})

Set the WorkSheet index (Default is 0).

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

XLStoHTMLResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

XLStoTXTInput dataclass

XLStoTXTInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

worksheet_index class-attribute instance-attribute

worksheet_index: Optional[str] = field(default=None, metadata={'wire_name': 'worksheetIndex'})

Set the WorkSheet index (Default is 0).

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

XLStoTXTResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

XLStoXMLInput dataclass

XLStoXMLInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

worksheet_index class-attribute instance-attribute

worksheet_index: Optional[str] = field(default=None, metadata={'wire_name': 'worksheetIndex'})

Set the WorkSheet index (Default is 0).

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

XLStoXMLResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFRotatePagesInput dataclass

PDFRotatePagesInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

angle class-attribute instance-attribute

angle: Optional[int] = None

Angle in degrees. Supported values 90, 180, and 270.

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

password class-attribute instance-attribute

password: Optional[str] = None

Password of the PDF file

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

PDFRotatePagesResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFAutoRotatePagesInput dataclass

PDFAutoRotatePagesInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

lang class-attribute instance-attribute

lang: Optional[str] = None

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).

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

password class-attribute instance-attribute

password: Optional[str] = None

Password of the PDF file

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

PDFAutoRotatePagesResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFDeletePagesInput dataclass

PDFDeletePagesInput(url: Optional[str] = None, pages: Optional[str] = None, name: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)

PDF Delete Pages

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

pages class-attribute instance-attribute

pages: Optional[str] = None

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.

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

PDFDeletePagesResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFCompressInput dataclass

PDFCompressInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

name class-attribute instance-attribute

name: Optional[str] = None

File name for the generated output

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

password class-attribute instance-attribute

password: Optional[str] = None

Password of the PDF file

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

PDFCompressResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFClassifierInput dataclass

PDFClassifierInput(url: Optional[str] = None, 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

url class-attribute instance-attribute

url: Optional[str] = None

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

rulescsv class-attribute instance-attribute

rulescsv: Optional[str] = None

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.

rulescsvurl class-attribute instance-attribute

rulescsvurl: Optional[str] = None

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.

case_sensitive class-attribute instance-attribute

case_sensitive: Optional[bool] = field(default=None, metadata={'wire_name': 'caseSensitive'})

Defines if keywords in rules are case-sensitive or not.

inline class-attribute instance-attribute

inline: Optional[bool] = None

Set to true to return results inside the response. Otherwise, the endpoint will return a link to the output file generated.

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

password class-attribute instance-attribute

password: Optional[str] = None

Password of the PDF file

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

PDFClassifierResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = None

body

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

pageCount

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

EmailSendInput dataclass

EmailSendInput(url: Optional[str] = None, from_: Optional[str] = None, to: Optional[str] = None, subject: Optional[str] = None, bodytext: Optional[str] = None, bodyhtml: Optional[str] = None, smtpserver: Optional[str] = None, smtpport: Optional[str] = None, smtpusername: Optional[str] = None, smtppassword: Optional[str] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)

Send Email with Attachments

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

from_ class-attribute instance-attribute

from_: Optional[str] = field(default=None, metadata={'wire_name': 'from'})

The "From" field with sender name and email. Example: John Doe john@example.com

to class-attribute instance-attribute

to: Optional[str] = None

The "To" field with receiver name and email. Example: Partner partner@example.com

subject class-attribute instance-attribute

subject: Optional[str] = None

The subject for the outgoing email

bodytext class-attribute instance-attribute

bodytext: Optional[str] = None

Plain text version of the outgoing email message.

bodyhtml class-attribute instance-attribute

bodyhtml: Optional[str] = None

HTML version of the outgoing email message.

smtpserver class-attribute instance-attribute

smtpserver: Optional[str] = None

SMTP server address

smtpport class-attribute instance-attribute

smtpport: Optional[str] = None

SMTP port

smtpusername class-attribute instance-attribute

smtpusername: Optional[str] = None

SMTP server username

smtppassword class-attribute instance-attribute

smtppassword: Optional[str] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

EmailSendResponse 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

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

EmailDecodeInput dataclass

EmailDecodeInput(url: Optional[str] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)

Email Information

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

EmailDecodeResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = None

body

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

EmailAttachmentExtractionInput dataclass

EmailAttachmentExtractionInput(url: Optional[str] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)

Email Attachment Extraction

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

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

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, 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.

EmailAttachmentExtractionResponse 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

url class-attribute instance-attribute

url: Optional[str] = None

url

body class-attribute instance-attribute

body: Optional[Dict[str, Any]] = None

body

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

error class-attribute instance-attribute

error: Optional[bool] = None

error

status class-attribute instance-attribute

status: Optional[int] = None

status

name class-attribute instance-attribute

name: Optional[str] = None

name

credits class-attribute instance-attribute

credits: Optional[int] = None

credits

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

remainingCredits

duration class-attribute instance-attribute

duration: Optional[int] = None

duration

PDFAttachmentExtractionInput dataclass

PDFAttachmentExtractionInput(url: Optional[str] = None, inline: Optional[bool] = None, name: Optional[str] = None, expiration: Optional[int] = None, profiles: Optional[str] = None, async_: Optional[bool] = None)

PDF Attachment Extraction

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

Url to the source PDF document

inline class-attribute instance-attribute

inline: Optional[bool] = None

Determines whether to return output in response or link to output file.

name class-attribute instance-attribute

name: Optional[str] = None

Base file name for new PDF files

expiration class-attribute instance-attribute

expiration: Optional[int] = None

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.

profiles class-attribute instance-attribute

profiles: Optional[str] = None

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.

async_ class-attribute instance-attribute

async_: Optional[bool] = field(default=None, metadata={'wire_name': 'async'})

Creates a background processing job.

PDFAttachmentExtractionResponse 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

urls class-attribute instance-attribute

urls: Optional[List[str]] = None

urls

url class-attribute instance-attribute

url: Optional[str] = None

Output document URL.

job_id class-attribute instance-attribute

job_id: Optional[str] = field(default=None, metadata={'wire_name': 'jobId'})

jobId

page_count class-attribute instance-attribute

page_count: Optional[int] = field(default=None, metadata={'wire_name': 'pageCount'})

Number of pages in the output document.

error class-attribute instance-attribute

error: Optional[bool] = None

Indicates whether the operation is successful or not.

status class-attribute instance-attribute

status: Optional[int] = None

Status code for HTTP response

name class-attribute instance-attribute

name: Optional[str] = None

Output document name

credits class-attribute instance-attribute

credits: Optional[int] = None

PDF.co credits used for this request

duration class-attribute instance-attribute

duration: Optional[int] = None

Request execution duration

remaining_credits class-attribute instance-attribute

remaining_credits: Optional[int] = field(default=None, metadata={'wire_name': 'remainingCredits'})

PDF.co account remaining credits

PdfcoClient

PdfcoClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

html_to_pdf_async async

html_to_pdf_async(input: HtmlToPdfInput) -> 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.

url_to_pdf_async async

url_to_pdf_async(input: UrlToPdfInput) -> 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.

pdf_filler_async async

pdf_filler_async(input: PdfFillerInput) -> 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.

merge_pdf_simplified_async async

merge_pdf_simplified_async(input: MergePdfSimplifiedInput) -> 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.

merge_pdf_async async

merge_pdf_async(input: MergePdfInput) -> 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.

split_pdf_async async

split_pdf_async(input: SplitPdfInput) -> 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.

split_pdf2_async async

split_pdf2_async(input: SplitPdf2Input) -> 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.

pdf_search_text_async async

pdf_search_text_async(input: PDFSearchTextInput) -> 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.

document_parser_async async

document_parser_async(input: DocumentParserInput) -> 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.

job_check_async async

job_check_async(input: JobCheckInput) -> 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.

barcode_generator_async async

barcode_generator_async(input: BarcodeGeneratorInput) -> 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.

barcode_reader_async async

barcode_reader_async(input: BarcodeReaderInput) -> 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.

pdf_info_reader_async async

pdf_info_reader_async(input: PDFInfoReaderInput) -> 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.

pdf_forms_info_reader_async async

pdf_forms_info_reader_async(input: PDFFormsInfoReaderInput) -> 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.

pdf_find_table_async async

pdf_find_table_async(input: PDFFindTableInput) -> 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.

search_and_replace_async async

search_and_replace_async(input: SearchAndReplaceInput) -> 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.

search_and_replace_with_image_async async

search_and_replace_with_image_async(input: SearchAndReplaceWithImageInput) -> 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.

search_and_delete_text_async async

search_and_delete_text_async(input: SearchAndDeleteTextInput) -> 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.

pdf_searchable_async async

pdf_searchable_async(input: PDFSearchableInput) -> 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.

pdf_unsearchable_async async

pdf_unsearchable_async(input: PDFUnSearchableInput) -> 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.

pdf_to_csv_async async

pdf_to_csv_async(input: PDFToCSVInput) -> 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.

pdf_to_json_async async

pdf_to_json_async(input: PDFToJSONInput) -> 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.

pdf_to_json_meta_async async

pdf_to_json_meta_async(input: PDFToJSONMetaInput) -> 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.

pdf_to_text_async async

pdf_to_text_async(input: PDFToTextInput) -> 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.

pdf_to_text_simple_async async

pdf_to_text_simple_async(input: PDFToTextSimpleInput) -> 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.

pdf_to_xls_async async

pdf_to_xls_async(input: PDFToXLSInput) -> 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.

pdf_to_xlsx_async async

pdf_to_xlsx_async(input: PDFToXLSXInput) -> 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.

pdf_to_xml_async async

pdf_to_xml_async(input: PDFToXMLInput) -> 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.

pdf_to_jpg_async async

pdf_to_jpg_async(input: PDFToJPGInput) -> 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.

pdf_to_png_async async

pdf_to_png_async(input: PDFToPNGInput) -> 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.

pdf_to_webp_async async

pdf_to_webp_async(input: PDFToWEBPInput) -> 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.

pdf_to_tiff_async async

pdf_to_tiff_async(input: PDFToTIFFInput) -> 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.

pdf_from_csv_async async

pdf_from_csv_async(input: PDFFromCSVInput) -> 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.

pdf_from_doc_async async

pdf_from_doc_async(input: PDFFromDocInput) -> 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.

pdf_from_images_async async

pdf_from_images_async(input: PDFFromImagesInput) -> 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.

pdf_from_email_async async

pdf_from_email_async(input: PDFFromEmailInput) -> 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.

pdf_add_security_async async

pdf_add_security_async(input: PDFAddSecurityInput) -> 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.

pdf_security_remove_async async

pdf_security_remove_async(input: PDFSecurityRemoveInput) -> 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.

pdf_from_xls_xlsx_async async

pdf_from_xls_xlsx_async(input: PDFFromXLSXLSXInput) -> 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.

xls_to_csv_async async

xls_to_csv_async(input: XLStoCSVInput) -> 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.

xls_to_json_async async

xls_to_json_async(input: XLStoJSONInput) -> 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.

xls_to_html_async async

xls_to_html_async(input: XLStoHTMLInput) -> 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.

xls_to_txt_async async

xls_to_txt_async(input: XLStoTXTInput) -> 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.

xls_to_xml_async async

xls_to_xml_async(input: XLStoXMLInput) -> 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.

pdf_rotate_pages_async async

pdf_rotate_pages_async(input: PDFRotatePagesInput) -> 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.

pdf_auto_rotate_pages_async async

pdf_auto_rotate_pages_async(input: PDFAutoRotatePagesInput) -> 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.

pdf_delete_pages_async async

pdf_delete_pages_async(input: PDFDeletePagesInput) -> 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.

pdf_compress_async async

pdf_compress_async(input: PDFCompressInput) -> 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.

pdf_classifier_async async

pdf_classifier_async(input: PDFClassifierInput) -> 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.

email_send_async async

email_send_async(input: EmailSendInput) -> 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.

email_decode_async async

email_decode_async(input: EmailDecodeInput) -> 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.

email_attachment_extraction_async async

email_attachment_extraction_async(input: EmailAttachmentExtractionInput) -> 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.

pdf_attachment_extraction_async async

pdf_attachment_extraction_async(input: PDFAttachmentExtractionInput) -> 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.