API reference

Package

pdfrest

Top-level package for the pdfrest client library.

AsyncPdfRestClient

Bases: _AsyncApiClient

Asynchronous client for interacting with the pdfrest API.

files property

files: AsyncPdfRestFilesClient

Return the AsyncPdfRestFilesClient helper bound to this client.

Returns:

Type	Description
AsyncPdfRestFilesClient	The file-management helper bound to this client.

__aenter__ async

__aenter__() -> AsyncPdfRestClient

Enter the client context manager and return this client instance.

Returns:

Type	Description
AsyncPdfRestClient	The current client instance.

__aexit__ async

__aexit__(
    exc_type: Any, exc: Any, traceback: Any
) -> None

Exit the client context manager and close underlying HTTP resources.

Parameters:

Name	Type	Description	Default
exc_type	Any	Exception type raised in the managed context, if any.	required
exc	Any	Exception instance raised in the managed context, if any.	required
traceback	Any	Traceback object for exceptions raised in the managed context.	required

__init__

__init__(
    *,
    api_key: str | None = None,
    base_url: str | URL | None = None,
    timeout: TimeoutTypes | None = None,
    headers: AnyMapping | None = None,
    http_client: AsyncClient | None = None,
    transport: AsyncBaseTransport | None = None,
    concurrency_limit: int = DEFAULT_FILE_INFO_CONCURRENCY,
    max_retries: int = DEFAULT_MAX_RETRIES,
) -> None

Initialize an asynchronous pdfRest client.

Parameters:

Name	Type	Description	Default
api_key	str | None	API key sent in the Api-Key header.	None
base_url	str | URL | None	Base URL for the pdfRest API service.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None
headers	AnyMapping | None	Default headers merged into every request.	None
http_client	AsyncClient | None	Optional preconfigured httpx.Client instance to reuse.	None
transport	AsyncBaseTransport | None	Optional custom httpx transport.	None
concurrency_limit	int	Maximum concurrent file-info fetch operations used by async file helper methods.	DEFAULT_FILE_INFO_CONCURRENCY
max_retries	int	Maximum number of retries for retryable failures.	DEFAULT_MAX_RETRIES

add_attachment_to_pdf async

add_attachment_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    attachment: PdfRestFile
    | Sequence[PdfRestFile],
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.add_attachment_to_pdf.

Embeds an uploaded file as an attachment inside a PDF container document. This supports package-style delivery where supplemental files travel with the PDF.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
attachment	PdfRestFile | Sequence[PdfRestFile]	Uploaded file to embed as an attachment in the output PDF.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

add_image_to_pdf async

add_image_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    image: PdfRestFile | Sequence[PdfRestFile],
    x: int,
    y: int,
    page: int,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.add_image_to_pdf.

Places an uploaded image onto target pages in a PDF with size/position controls. This is commonly used for logos, seals, and branding overlays.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
image	PdfRestFile | Sequence[PdfRestFile]	Image/PDF resource to place into the source document.	required
x	int	Horizontal position in PDF points.	required
y	int	Vertical position in PDF points.	required
page	int	Target page number (or selector) where inserted content should be applied.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

add_open_password async

add_open_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    new_open_password: str,
    current_permissions_password: str
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.add_open_password.

Applies a user/open password so the PDF requires authentication before viewing. Optional permissions controls can also be set for opened documents.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
new_open_password	str	New user/open password required to open the output PDF.	required
current_permissions_password	str | None	Current owner/permissions password used to authorize permission updates/removal.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

add_permissions_password async

add_permissions_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    new_permissions_password: str,
    restrictions: Sequence[PdfRestriction]
    | None = None,
    current_open_password: str | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.add_permissions_password.

Applies owner permissions and restriction flags (print/copy/edit controls) to a PDF. This secures document capabilities without requiring an open password.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
new_permissions_password	str	New owner/permissions password to apply to the output PDF.	required
restrictions	Sequence[PdfRestriction] | None	Permission restriction literals for protected PDFs.	None
current_open_password	str | None	Current user/open password required to unlock the source PDF before changes.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

add_text_to_pdf async

add_text_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    text_objects: PdfAddTextObject
    | Sequence[PdfAddTextObject],
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.add_text_to_pdf.

Places one or more text overlays onto a PDF with font, size, color, opacity, position, and rotation controls. This supports annotations, stamps, and templated labeling workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
text_objects	PdfAddTextObject | Sequence[PdfAddTextObject]	Text overlay objects to draw onto the document.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

apply_redactions async

apply_redactions(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    rgb_color: PdfRGBColor
    | Sequence[int]
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.apply_redactions.

Applies irreversible redactions to the PDF based on provided rules and outputs a redacted document. Use this after validating coverage with preview_redactions.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
rgb_color	PdfRGBColor | Sequence[int] | None	RGB fill color applied to redaction rectangles when previewing/applying redactions.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

blank_pdf async

blank_pdf(
    *,
    page_size: PdfPageSize = "letter",
    page_count: int = 1,
    page_orientation: PdfPageOrientation
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.blank_pdf.

Creates a new blank PDF with configurable page size, orientation, and page count. This is useful as a template baseline for downstream stamping/filling workflows.

Parameters:

Name	Type	Description	Default
page_size	PdfPageSize	Target page size preset or custom size settings used for output page dimensions.	'letter'
page_count	int	Number of blank pages to generate in the new PDF.	1
page_orientation	PdfPageOrientation | None	Page orientation for standard page sizes (portrait or landscape).	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

change_open_password async

change_open_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    current_open_password: str,
    new_open_password: str,
    current_permissions_password: str
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.change_open_password.

Replaces the existing open password with a new one while preserving or updating related protection options. Use this for credential rotation.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
current_open_password	str	Current user/open password required to unlock the source PDF before changes.	required
new_open_password	str	New user/open password required to open the output PDF.	required
current_permissions_password	str | None	Current owner/permissions password used to authorize permission updates/removal.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

change_permissions_password async

change_permissions_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    current_permissions_password: str,
    new_permissions_password: str,
    restrictions: Sequence[PdfRestriction]
    | None = None,
    current_open_password: str | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.change_permissions_password.

Updates owner permissions/password settings and restriction flags on an already protected PDF. Use this to rotate credentials or revise allowed actions.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
current_permissions_password	str	Current owner/permissions password used to authorize permission updates/removal.	required
new_permissions_password	str	New owner/permissions password to apply to the output PDF.	required
restrictions	Sequence[PdfRestriction] | None	Permission restriction literals for protected PDFs.	None
current_open_password	str | None	Current user/open password required to unlock the source PDF before changes.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

compress_pdf async

compress_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    compression_level: CompressionLevel,
    profile: PdfRestFile
    | Sequence[PdfRestFile]
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.compress_pdf.

Reduces PDF file size using preset or custom compression settings, with optional profile uploads. Use this for storage/bandwidth optimization while balancing quality.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
compression_level	CompressionLevel	Compression level or strategy option.	required
profile	PdfRestFile | Sequence[PdfRestFile] | None	Uploaded color/compression profile as a PdfRestFile.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_colors async

convert_colors(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    color_profile: PdfPresetColorProfile
    | PdfRestFile
    | Sequence[PdfRestFile],
    preserve_black: bool = False,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_colors.

Converts document color spaces using preset profiles and optional black-preservation behavior. Use this to normalize output for print pipelines or color-management requirements.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
color_profile	PdfPresetColorProfile | PdfRestFile | Sequence[PdfRestFile]	Named color profile used by color conversion.	required
preserve_black	bool	When true, keeps pure black content from being remapped during color-profile conversion.	False
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_email_to_pdf async

convert_email_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_email_to_pdf.

Converts email message files into PDF, including rendered message content and supported metadata/body parts. This supports archiving and compliance workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_html_to_pdf async

convert_html_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    compression: PdfConversionCompression = "lossy",
    downsample: PdfConversionDownsample = 300,
    page_size: HtmlPageSize = "letter",
    page_margin: str = "1.0in",
    page_orientation: HtmlPageOrientation = "portrait",
    web_layout: HtmlWebLayout = "desktop",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_html_to_pdf.

Renders HTML content into PDF with page-size/orientation/layout and related rendering controls. This supports report generation and web-to-PDF publishing use cases.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
compression	PdfConversionCompression	Compression mode used during conversion.	'lossy'
downsample	PdfConversionDownsample	Image downsampling setting for conversion.	300
page_size	HtmlPageSize	Target page size preset or custom size settings used for output page dimensions.	'letter'
page_margin	str	Page margin setting (for example 8mm or 0.5in) for HTML/URL rendering outputs.	'1.0in'
page_orientation	HtmlPageOrientation	Page orientation for standard page sizes (portrait or landscape).	'portrait'
web_layout	HtmlWebLayout	Rendering viewport profile (desktop, tablet, or mobile) for HTML/URL conversion.	'desktop'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_image_to_pdf async

convert_image_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_image_to_pdf.

Converts one or more image files into PDF output and can combine them into multipage documents. Use this to normalize scanned/image assets into PDF containers.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_office_to_pdf async

convert_office_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    compression: PdfConversionCompression = "lossy",
    downsample: PdfConversionDownsample = 300,
    tagged_pdf: bool = False,
    locale: PdfConversionLocale | None = None,
    page_size: HtmlPageSize | None = None,
    page_margin: str | None = None,
    page_orientation: HtmlPageOrientation
    | None = None,
    web_layout: HtmlWebLayout | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_office_to_pdf.

Converts Office documents into PDF output using conversion options for layout and fidelity. This is the main entry point for Word/Excel/PowerPoint-to-PDF workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
compression	PdfConversionCompression	Compression mode used during conversion.	'lossy'
downsample	PdfConversionDownsample	Image downsampling setting for conversion.	300
tagged_pdf	bool	For Office conversion, toggles generation of tagged PDFs for accessibility workflows.	False
locale	PdfConversionLocale | None	Locale used by locale-aware conversion options.	None
page_size	HtmlPageSize | None	Target page size preset or custom size settings used for output page dimensions.	None
page_margin	str | None	Page margin setting (for example 8mm or 0.5in) for HTML/URL rendering outputs.	None
page_orientation	HtmlPageOrientation | None	Page orientation for standard page sizes (portrait or landscape).	None
web_layout	HtmlWebLayout | None	Rendering viewport profile (desktop, tablet, or mobile) for HTML/URL conversion.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_postscript_to_pdf async

convert_postscript_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    compression: PdfConversionCompression = "lossy",
    downsample: PdfConversionDownsample
    | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_postscript_to_pdf.

Converts PostScript content to PDF while preserving page content for modern PDF workflows. Use this when ingesting legacy print-oriented document formats.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
compression	PdfConversionCompression	Compression mode used during conversion.	'lossy'
downsample	PdfConversionDownsample | None	Image downsampling setting for conversion.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_bmp async

convert_to_bmp(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_prefix: str | None = None,
    page_range: str | Sequence[str] | None = None,
    resolution: int = 300,
    color_model: BmpColorModel = "rgb",
    smoothing: GraphicSmoothing
    | Sequence[GraphicSmoothing] = "none",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_to_bmp.

Converts PDF pages to BMP images with configurable color model and page selection. Use this for legacy bitmap workflows that require BMP output.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
page_range	str | Sequence[str] | None	Page selection string/list for image conversion outputs.	None
resolution	int	Raster output resolution in DPI for generated image files.	300
color_model	BmpColorModel	Output image color model.	'rgb'
smoothing	GraphicSmoothing | Sequence[GraphicSmoothing]	Graphic smoothing mode for image output endpoints.	'none'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_excel async

convert_to_excel(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_to_excel.

Converts PDF content into Excel workbook output optimized for tabular data extraction. Use this for spreadsheet-centric review or data cleanup workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_gif async

convert_to_gif(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_prefix: str | None = None,
    page_range: str | Sequence[str] | None = None,
    resolution: int = 300,
    color_model: GifColorModel = "rgb",
    smoothing: GraphicSmoothing
    | Sequence[GraphicSmoothing] = "none",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_to_gif.

Converts PDF pages to GIF images with configurable color model and page selection. Useful for lightweight graphics workflows and compatibility scenarios.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
page_range	str | Sequence[str] | None	Page selection string/list for image conversion outputs.	None
resolution	int	Raster output resolution in DPI for generated image files.	300
color_model	GifColorModel	Output image color model.	'rgb'
smoothing	GraphicSmoothing | Sequence[GraphicSmoothing]	Graphic smoothing mode for image output endpoints.	'none'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_jpeg async

convert_to_jpeg(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_prefix: str | None = None,
    page_range: str | Sequence[str] | None = None,
    resolution: int = 300,
    color_model: JpegColorModel = "rgb",
    smoothing: GraphicSmoothing
    | Sequence[GraphicSmoothing] = "none",
    jpeg_quality: int = 75,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_to_jpeg.

Converts PDF pages to JPEG images with configurable color model and page selection. Use this for compressed photo-friendly page exports.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
page_range	str | Sequence[str] | None	Page selection string/list for image conversion outputs.	None
resolution	int	Raster output resolution in DPI for generated image files.	300
color_model	JpegColorModel	Output image color model.	'rgb'
smoothing	GraphicSmoothing | Sequence[GraphicSmoothing]	Graphic smoothing mode for image output endpoints.	'none'
jpeg_quality	int	JPEG quality setting (1-100) controlling compression level and output fidelity.	75
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_markdown async

convert_to_markdown(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    pages: PdfPageSelection | None = None,
    page_break_comments: bool = False,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_to_markdown.

Converts document content into Markdown and supports either inline text output or file output. This is useful when preparing PDFs for LLM/RAG indexing and markdown-centric tooling.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
page_break_comments	bool	When true, inserts page-break marker comments in generated Markdown between source pages.	False
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_pdfa async

convert_to_pdfa(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_type: PdfAType,
    output: str | None = None,
    rasterize_if_errors_encountered: bool = False,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_to_pdfa.

Converts input PDFs to selected PDF/A conformance levels for long-term archival compatibility. Choose the target conformance profile that matches your compliance requirements.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_type	PdfAType	Output mode for endpoints supporting inline or file output.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
rasterize_if_errors_encountered	bool	When enabled, allows rasterized fallback if strict conformance conversion encounters nonconforming content.	False
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_pdfx async

convert_to_pdfx(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_type: PdfXType,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_to_pdfx.

Converts input PDFs to selected PDF/X conformance levels for print-production workflows. Use this when downstream print tooling expects standardized PDF/X output.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_type	PdfXType	Output mode for endpoints supporting inline or file output.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_png async

convert_to_png(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_prefix: str | None = None,
    page_range: str | Sequence[str] | None = None,
    resolution: int = 300,
    color_model: PngColorModel = "rgb",
    smoothing: GraphicSmoothing
    | Sequence[GraphicSmoothing] = "none",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_to_png.

Converts PDF pages to PNG images with configurable color model, smoothing, and page selection controls. Suitable for high-fidelity raster exports and previews.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
page_range	str | Sequence[str] | None	Page selection string/list for image conversion outputs.	None
resolution	int	Raster output resolution in DPI for generated image files.	300
color_model	PngColorModel	Output image color model.	'rgb'
smoothing	GraphicSmoothing | Sequence[GraphicSmoothing]	Graphic smoothing mode for image output endpoints.	'none'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_powerpoint async

convert_to_powerpoint(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_to_powerpoint.

Converts PDF pages into PowerPoint output suitable for slide editing and presentation reuse. This helps repurpose static PDF material into editable decks.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_tiff async

convert_to_tiff(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_prefix: str | None = None,
    page_range: str | Sequence[str] | None = None,
    resolution: int = 300,
    color_model: TiffColorModel = "rgb",
    smoothing: GraphicSmoothing
    | Sequence[GraphicSmoothing] = "none",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_to_tiff.

Converts PDF pages to TIFF images with configurable color model and page selection. This is commonly used in archival, scanning, and print-imaging pipelines.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
page_range	str | Sequence[str] | None	Page selection string/list for image conversion outputs.	None
resolution	int	Raster output resolution in DPI for generated image files.	300
color_model	TiffColorModel	Output image color model.	'rgb'
smoothing	GraphicSmoothing | Sequence[GraphicSmoothing]	Graphic smoothing mode for image output endpoints.	'none'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_word async

convert_to_word(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_to_word.

Converts PDF content into Word output for document editing workflows. This is useful when users need editable text and layout reconstruction in DOCX format.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_url_to_pdf async

convert_url_to_pdf(
    url: UrlValue,
    *,
    output: str | None = None,
    compression: PdfConversionCompression = "lossy",
    downsample: PdfConversionDownsample = 300,
    page_size: HtmlPageSize = "letter",
    page_margin: str = "1.0in",
    page_orientation: HtmlPageOrientation = "portrait",
    web_layout: HtmlWebLayout = "desktop",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_url_to_pdf.

Fetches remote web content by URL and renders it to PDF using HTML rendering options. Use this for automated webpage capture and archival.

Parameters:

Name	Type	Description	Default
url	UrlValue	Remote URL to ingest and convert.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
compression	PdfConversionCompression	Compression mode used during conversion.	'lossy'
downsample	PdfConversionDownsample	Image downsampling setting for conversion.	300
page_size	HtmlPageSize	Target page size preset or custom size settings used for output page dimensions.	'letter'
page_margin	str	Page margin setting (for example 8mm or 0.5in) for HTML/URL rendering outputs.	'1.0in'
page_orientation	HtmlPageOrientation	Page orientation for standard page sizes (portrait or landscape).	'portrait'
web_layout	HtmlWebLayout	Rendering viewport profile (desktop, tablet, or mobile) for HTML/URL conversion.	'desktop'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_xfa_to_acroforms async

convert_xfa_to_acroforms(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.convert_xfa_to_acroforms.

Converts XFA form PDFs into AcroForm-compatible PDFs for broader tooling compatibility. Use this before importing/exporting form data with AcroForm-focused flows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

export_form_data async

export_form_data(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    data_format: ExportDataFormat,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.export_form_data.

Exports form field data from a PDF into a structured data format (such as XFDF/FDF/XML). Use this for downstream processing, storage, or migration of form values.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
data_format	ExportDataFormat	Output form-data format to export (for example XFDF, FDF, XML, XDP, or XFD).	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

extract_images async

extract_images(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    pages: PdfPageSelection | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.extract_images.

Extracts embedded images from the source PDF and returns them as output files. This is useful for asset reuse, auditing image quality, or downstream image processing.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

extract_pdf_text async

extract_pdf_text(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    pages: PdfPageSelection | None = None,
    full_text: Literal[
        "off", "by_page", "document"
    ] = "document",
    preserve_line_breaks: bool = False,
    word_style: bool = False,
    word_coordinates: bool = False,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> ExtractedTextDocument

Asynchronous variant of PdfRestClient.extract_pdf_text.

Extracts text from a PDF as inline JSON text content. Use pages to limit scope and granularity/related options to control how text is aggregated.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
full_text	Literal['off', 'by_page', 'document']	Controls full-text output mode: disabled, aggregated document text, or per-page text blocks.	'document'
preserve_line_breaks	bool	Preserves detected line breaks in full-text output instead of flattening lines.	False
word_style	bool	Includes per-word style metadata such as font, size, and color in structured output.	False
word_coordinates	bool	Includes per-word coordinate metadata for positional text extraction.	False
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
ExtractedTextDocument	Validated ExtractedTextDocument model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

extract_pdf_text_to_file async

extract_pdf_text_to_file(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    pages: PdfPageSelection | None = None,
    full_text: ExtractTextGranularity = "document",
    preserve_line_breaks: bool = False,
    word_style: bool = False,
    word_coordinates: bool = False,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.extract_pdf_text_to_file.

Extracts text into file outputs (including richer structured formats when requested). Use this for large outputs or when you need durable extracted-text artifacts.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
full_text	ExtractTextGranularity	Controls full-text output mode: disabled, aggregated document text, or per-page text blocks.	'document'
preserve_line_breaks	bool	Preserves detected line breaks in full-text output instead of flattening lines.	False
word_style	bool	Includes per-word style metadata such as font, size, and color in structured output.	False
word_coordinates	bool	Includes per-word coordinate metadata for positional text extraction.	False
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

flatten_annotations async

flatten_annotations(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.flatten_annotations.

Burns annotation markup into page content so comments/highlights become static and non-editable. Use this when sharing finalized review copies.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

flatten_layers async

flatten_layers(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.flatten_layers.

Flattens optional content groups (layers) into a single visible page representation. This avoids layer-dependent rendering differences across viewers.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

flatten_pdf_forms async

flatten_pdf_forms(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.flatten_pdf_forms.

Flattens interactive form fields into static page content so values are no longer editable. This is commonly used for finalization and archival workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

flatten_transparencies async

flatten_transparencies(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    quality: FlattenQuality = "medium",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.flatten_transparencies.

Flattens transparent objects into opaque content using selectable quality levels. This improves compatibility with workflows/devices that do not fully support transparency.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
quality	FlattenQuality	Quality preset understood by the selected endpoint.	'medium'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

import_form_data async

import_form_data(
    file: PdfRestFile | Sequence[PdfRestFile],
    data_file: PdfRestFile
    | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.import_form_data.

Imports external form-data files (XFDF/FDF/XML variants) into a source PDF and outputs a filled document. This supports bulk form-filling and integration pipelines.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
data_file	PdfRestFile | Sequence[PdfRestFile]	Uploaded form-data file (for example XFDF/FDF/XML/XDP/XFD) to import into the PDF.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

linearize_pdf async

linearize_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.linearize_pdf.

Linearizes the PDF for fast web view so first pages render sooner over network delivery. This improves user experience for browser-based document viewing.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

merge_pdfs async

merge_pdfs(
    sources: Sequence[PdfMergeInput],
    *,
    output_prefix: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.merge_pdfs.

Merges multiple uploaded PDFs into a single output, with optional per-input page selections. This is useful for packet assembly and document bundling.

Parameters:

Name	Type	Description	Default
sources	Sequence[PdfMergeInput]	Merge source list containing files with optional page selections per source.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

ocr_pdf async

ocr_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    languages: OcrLanguage
    | Sequence[OcrLanguage] = "English",
    pages: PdfPageSelection | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.ocr_pdf.

Runs OCR on image-based PDFs to produce searchable text layers while preserving PDF layout. Use language to guide recognition and output to control output naming.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
languages	OcrLanguage | Sequence[OcrLanguage]	OCR language(s) to use when recognizing text in scanned or image-based pages.	'English'
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

preview_redactions async

preview_redactions(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    redactions: PdfRedactionInstruction
    | Sequence[PdfRedactionInstruction],
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.preview_redactions.

Builds a redaction preview PDF so you can inspect matches before permanently removing content. Redaction rules support literals, regex patterns, and preset detectors.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
redactions	PdfRedactionInstruction | Sequence[PdfRedactionInstruction]	Redaction rules to preview or apply.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

query_pdf_info async

query_pdf_info(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    queries: Sequence[PdfInfoQuery]
    | PdfInfoQuery = ALL_PDF_INFO_QUERIES,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestInfoResponse

Asynchronous variant of PdfRestClient.query_pdf_info.

Retrieves PDF metadata and structural flags (for example page count, tags, signatures, forms, transparency, and permission state). The queries argument controls which info keys pdfRest computes and returns.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
queries	Sequence[PdfInfoQuery] | PdfInfoQuery	Info fields to query from the /pdf-info endpoint.	ALL_PDF_INFO_QUERIES
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestInfoResponse	Validated PdfRestInfoResponse model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

rasterize_pdf async

rasterize_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.rasterize_pdf.

Rasterizes PDF pages into image-based page content at a specified resolution. Use this for visual normalization, redaction hardening, or viewer compatibility scenarios.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

remove_open_password async

remove_open_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    current_open_password: str,
    current_permissions_password: str
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.remove_open_password.

Removes the user/open password requirement from a PDF when the current password is provided. The output document can be opened without viewer authentication.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
current_open_password	str	Current user/open password required to unlock the source PDF before changes.	required
current_permissions_password	str | None	Current owner/permissions password used to authorize permission updates/removal.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

remove_permissions_password async

remove_permissions_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    current_permissions_password: str,
    current_open_password: str | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.remove_permissions_password.

Removes owner permission restrictions from a PDF when authorized with the existing owner password. This restores unrestricted editing/printing capabilities.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
current_permissions_password	str	Current owner/permissions password used to authorize permission updates/removal.	required
current_open_password	str | None	Current user/open password required to unlock the source PDF before changes.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

sign_pdf async

sign_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    signature_configuration: PdfSignatureConfiguration,
    credentials: PdfSignatureCredentials,
    logo: PdfRestFile
    | Sequence[PdfRestFile]
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.sign_pdf.

Applies digital signatures using either PFX credentials or certificate/private-key inputs, with configurable visible signature placement and appearance. Use this for integrity, authenticity, and non-repudiation workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
signature_configuration	PdfSignatureConfiguration	Signature placement and appearance settings.	required
credentials	PdfSignatureCredentials	Digital signing credential bundle (PFX or cert/key files).	required
logo	PdfRestFile | Sequence[PdfRestFile] | None	Optional uploaded logo file displayed in visible digital signature appearances.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

split_pdf async

split_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    page_groups: Sequence[PdfPageSelection]
    | PdfPageSelection
    | None = None,
    output_prefix: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.split_pdf.

Splits a PDF into multiple outputs using page selections and grouping rules. Use this to break long documents into per-range or per-section files.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
page_groups	Sequence[PdfPageSelection] | PdfPageSelection | None	Page-selection groups that define each split output document.	None
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

summarize_text async

summarize_text(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    target_word_count: int = 400,
    summary_format: SummaryFormat = "overview",
    pages: PdfPageSelection | None = None,
    output_format: SummaryOutputFormat = "markdown",
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> SummarizePdfTextResponse

Asynchronous variant of PdfRestClient.summarize_text.

Generates an inline summary from document text and returns it in a structured response model. You can scope to pages, choose summary style, and control output formatting for downstream display.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
target_word_count	int	Approximate target length for generated summary text.	400
summary_format	SummaryFormat	Summary layout/style requested from pdfRest.	'overview'
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output_format	SummaryOutputFormat	Text format returned for generated textual output.	'markdown'
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
SummarizePdfTextResponse	Validated SummarizePdfTextResponse model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

summarize_text_to_file async

summarize_text_to_file(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    target_word_count: int = 400,
    summary_format: SummaryFormat = "overview",
    pages: PdfPageSelection | None = None,
    output_format: SummaryOutputFormat = "markdown",
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.summarize_text_to_file.

Generates a summary and returns a file-based response containing the produced summary document. Use this when you want downloadable artifacts instead of inline summary text.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
target_word_count	int	Approximate target length for generated summary text.	400
summary_format	SummaryFormat	Summary layout/style requested from pdfRest.	'overview'
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output_format	SummaryOutputFormat	Text format returned for generated textual output.	'markdown'
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

translate_pdf_text async

translate_pdf_text(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_language: str,
    pages: PdfPageSelection | None = None,
    output_format: TranslateOutputFormat = "markdown",
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> TranslatePdfTextResponse

Asynchronous variant of PdfRestClient.translate_pdf_text.

Translates extracted document text and returns translated content inline when output_type is JSON. Supports page scoping and output formatting for multilingual text workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_language	str	Target language for translated output text.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output_format	TranslateOutputFormat	Text format returned for generated textual output.	'markdown'
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
TranslatePdfTextResponse	Validated TranslatePdfTextResponse model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

translate_pdf_text_to_file async

translate_pdf_text_to_file(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_language: str,
    pages: PdfPageSelection | None = None,
    output_format: TranslateOutputFormat = "markdown",
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> TranslatePdfTextFileResponse

Asynchronous variant of PdfRestClient.translate_pdf_text_to_file.

Translates document text and returns a file-based response with translated output artifacts. Choose this when you need downloadable translated files instead of inline text.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_language	str	Target language for translated output text.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output_format	TranslateOutputFormat	Text format returned for generated textual output.	'markdown'
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
TranslatePdfTextFileResponse	Validated TranslatePdfTextFileResponse model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

unzip_file async

unzip_file(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    password: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.unzip_file.

Expands an uploaded ZIP archive into individual files on pdfRest storage and returns metadata for the extracted resources. This is useful when reusing uploaded bundles in later API calls.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
password	str | None	Password value used by encrypt/decrypt endpoints.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

up async

up(
    *,
    extra_headers: AnyMapping | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> UpResponse

Asynchronous variant of PdfRestClient.up.

Calls the health endpoint and returns service metadata such as status, product, version, and release date. Use this as a lightweight connectivity check before running document workflows.

Parameters:

Name	Type	Description	Default
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
UpResponse	Validated UpResponse model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

watermark_pdf_with_image async

watermark_pdf_with_image(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    watermark_file: PdfRestFile
    | Sequence[PdfRestFile],
    output: str | None = None,
    watermark_file_scale: float = 0.5,
    opacity: float = 0.5,
    horizontal_alignment: WatermarkHorizontalAlignment = "center",
    vertical_alignment: WatermarkVerticalAlignment = "center",
    x: int = 0,
    y: int = 0,
    rotation: int = 0,
    pages: PdfPageSelection | None = None,
    behind_page: bool = False,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.watermark_pdf_with_image.

Applies image watermarks (for example logos/seals) with placement and opacity controls. This is useful for branded overlays and visual ownership marks.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
watermark_file	PdfRestFile | Sequence[PdfRestFile]	Uploaded image used as watermark content.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
watermark_file_scale	float	Scale multiplier applied to the watermark file graphic before placement.	0.5
opacity	float	Opacity in range 0.0 to 1.0.	0.5
horizontal_alignment	WatermarkHorizontalAlignment	Horizontal alignment anchor used when placing watermark content.	'center'
vertical_alignment	WatermarkVerticalAlignment	Vertical alignment anchor used when placing watermark content.	'center'
x	int	Horizontal position in PDF points.	0
y	int	Vertical position in PDF points.	0
rotation	int	Rotation angle in degrees.	0
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
behind_page	bool	Target page number (or selector) where inserted content should be applied.	False
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

watermark_pdf_with_text async

watermark_pdf_with_text(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    watermark_text: str,
    output: str | None = None,
    font: str | None = None,
    text_size: int = 72,
    text_color: PdfTextColor = (0, 0, 0),
    opacity: float = 0.5,
    horizontal_alignment: WatermarkHorizontalAlignment = "center",
    vertical_alignment: WatermarkVerticalAlignment = "center",
    x: int = 0,
    y: int = 0,
    rotation: int = 0,
    pages: PdfPageSelection | None = None,
    behind_page: bool = False,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.watermark_pdf_with_text.

Applies text watermarks with control over placement, rotation, color, opacity, and alignment. Use this for confidentiality marks, drafts, and document branding.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
watermark_text	str	Text content to render as the watermark.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
font	str | None	Font family name for rendered text.	None
text_size	int	Watermark text size in points.	72
text_color	PdfTextColor	Watermark text color as RGB or CMYK channel values.	(0, 0, 0)
opacity	float	Opacity in range 0.0 to 1.0.	0.5
horizontal_alignment	WatermarkHorizontalAlignment	Horizontal alignment anchor used when placing watermark content.	'center'
vertical_alignment	WatermarkVerticalAlignment	Vertical alignment anchor used when placing watermark content.	'center'
x	int	Horizontal position in PDF points.	0
y	int	Vertical position in PDF points.	0
rotation	int	Rotation angle in degrees.	0
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
behind_page	bool	Target page number (or selector) where inserted content should be applied.	False
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

zip_files async

zip_files(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Asynchronous variant of PdfRestClient.zip_files.

Packages uploaded files into a ZIP archive and returns it as a file-based response. Use this to consolidate multiple outputs for a single download.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

AsyncPdfRestFilesClient

Bases: Protocol

Public interface for async file operations returned by files helpers.

This protocol describes the object returned by AsyncPdfRestClient.files. Retrieve this helper from client.files; do not instantiate it directly.

create async

create(
    files: UploadFiles,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> list[PdfRestFile]

Upload one or more local file objects.

Parameters:

Name	Type	Description	Default
files	UploadFiles	Multipart file payload(s) accepted by httpx upload APIs.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
list[PdfRestFile]	Metadata for uploaded files.

create_from_paths async

create_from_paths(
    file_paths: FilePathInput,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> list[PdfRestFile]

Upload one or more files by filesystem path.

Parameters:

Name	Type	Description	Default
file_paths	FilePathInput	Path input(s), optionally with content type and headers.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
list[PdfRestFile]	Metadata for uploaded files.

create_from_urls async

create_from_urls(
    urls: UrlInput,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> list[PdfRestFile]

Upload one or more files by remote URL.

Parameters:

Name	Type	Description	Default
urls	UrlInput	One URL or a sequence of URLs to upload.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
extra_body	Body | None	Additional JSON body fields merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
list[PdfRestFile]	Metadata for uploaded files.

delete async

delete(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> None

Delete one or more previously uploaded files.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	File reference(s) to delete.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
extra_body	Body | None	Additional JSON body fields merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Raises:

Type	Description
PdfRestErrorGroup	Raised when one or more deletions fail. Individual failures are reported as PdfRestDeleteError items in the group.

get async

get(
    id: PdfRestFileID | str,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFile

Retrieve metadata for an uploaded file.

Parameters:

Name	Type	Description	Default
id	PdfRestFileID | str	Uploaded file identifier.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
PdfRestFile	The resolved file metadata.

read_bytes async

read_bytes(
    file_ref: PdfRestFile | str,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> bytes

Download a file and return its raw bytes.

Parameters:

Name	Type	Description	Default
file_ref	PdfRestFile | str	File object or file id to download.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
bytes	The downloaded bytes.

read_json async

read_json(
    file_ref: PdfRestFile | str,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> Any

Download a file and parse its content as JSON.

Parameters:

Name	Type	Description	Default
file_ref	PdfRestFile | str	File object or file id to download.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
Any	Parsed JSON value.

read_text async

read_text(
    file_ref: PdfRestFile | str,
    *,
    encoding: str = "utf-8",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> str

Download a file and decode it into text.

Parameters:

Name	Type	Description	Default
file_ref	PdfRestFile | str	File object or file id to download.	required
encoding	str	Text encoding used when decoding the response.	'utf-8'
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
str	The decoded text content.

stream async

stream(
    file_ref: PdfRestFile | str,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> AsyncPdfRestFileStream

Open a streaming download for a file.

Parameters:

Name	Type	Description	Default
file_ref	PdfRestFile | str	File object or file id to download.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
AsyncPdfRestFileStream	An asynchronous streaming wrapper around the HTTP response.

write_bytes async

write_bytes(
    file_ref: PdfRestFile | str,
    destination: DestinationPath,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> Path

Download a file and persist it to disk.

Parameters:

Name	Type	Description	Default
file_ref	PdfRestFile | str	File object or file id to download.	required
destination	DestinationPath	Output path for the downloaded file.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
Path	The written destination path.

PdfRestApiError

Bases: PdfRestError

Raised when the pdfrest API returns a non-successful response.

__init__

__init__(
    status_code: int,
    message: str | None = None,
    response_content: Any | None = None,
    *,
    retry_after: float | None = None,
) -> None

Initialize an API error with HTTP status and response details.

Parameters:

Name	Type	Description	Default
status_code	int	HTTP status code returned by pdfRest.	required
message	str | None	Optional human-readable error message.	None
response_content	Any | None	Parsed or raw error payload from the API response.	None
retry_after	float | None	Optional retry delay in seconds parsed from headers.	None

PdfRestAuthenticationError

Bases: PdfRestApiError

Raised when authentication with the pdfRest API fails.

PdfRestClient

Bases: _SyncApiClient

Synchronous client for interacting with the pdfrest API.

files property

files: PdfRestFilesClient

Return the PdfRestFilesClient helper bound to this client.

Returns:

Type	Description
PdfRestFilesClient	The file-management helper bound to this client.

__enter__

__enter__() -> PdfRestClient

Enter the client context manager and return this client instance.

Returns:

Type	Description
PdfRestClient	The current client instance.

__exit__

__exit__(
    exc_type: Any, exc: Any, traceback: Any
) -> None

Exit the client context manager and close underlying HTTP resources.

Parameters:

Name	Type	Description	Default
exc_type	Any	Exception type raised in the managed context, if any.	required
exc	Any	Exception instance raised in the managed context, if any.	required
traceback	Any	Traceback object for exceptions raised in the managed context.	required

__init__

__init__(
    *,
    api_key: str | None = None,
    base_url: str | URL | None = None,
    timeout: TimeoutTypes | None = None,
    headers: AnyMapping | None = None,
    http_client: Client | None = None,
    transport: BaseTransport | None = None,
    max_retries: int = DEFAULT_MAX_RETRIES,
) -> None

Initialize a synchronous pdfRest client.

Parameters:

Name	Type	Description	Default
api_key	str | None	API key sent in the Api-Key header.	None
base_url	str | URL | None	Base URL for the pdfRest API service.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None
headers	AnyMapping | None	Default headers merged into every request.	None
http_client	Client | None	Optional preconfigured httpx.Client instance to reuse.	None
transport	BaseTransport | None	Optional custom httpx transport.	None
max_retries	int	Maximum number of retries for retryable failures.	DEFAULT_MAX_RETRIES

add_attachment_to_pdf

add_attachment_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    attachment: PdfRestFile
    | Sequence[PdfRestFile],
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Attach an uploaded file to a PDF.

Embeds an uploaded file as an attachment inside a PDF container document. This supports package-style delivery where supplemental files travel with the PDF.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
attachment	PdfRestFile | Sequence[PdfRestFile]	Uploaded file to embed as an attachment in the output PDF.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

add_image_to_pdf

add_image_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    image: PdfRestFile | Sequence[PdfRestFile],
    x: int,
    y: int,
    page: int,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Insert an image into a single page of a PDF.

Places an uploaded image onto target pages in a PDF with size/position controls. This is commonly used for logos, seals, and branding overlays.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
image	PdfRestFile | Sequence[PdfRestFile]	Image/PDF resource to place into the source document.	required
x	int	Horizontal position in PDF points.	required
y	int	Vertical position in PDF points.	required
page	int	Target page number (or selector) where inserted content should be applied.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

add_open_password

add_open_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    new_open_password: str,
    current_permissions_password: str
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Encrypt a PDF with a new open password.

Applies a user/open password so the PDF requires authentication before viewing. Optional permissions controls can also be set for opened documents.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
new_open_password	str	New user/open password required to open the output PDF.	required
current_permissions_password	str | None	Current owner/permissions password used to authorize permission updates/removal.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

add_permissions_password

add_permissions_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    new_permissions_password: str,
    restrictions: Sequence[PdfRestriction]
    | None = None,
    current_open_password: str | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Add a permissions password and optional restrictions to a PDF.

Applies owner permissions and restriction flags (print/copy/edit controls) to a PDF. This secures document capabilities without requiring an open password.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
new_permissions_password	str	New owner/permissions password to apply to the output PDF.	required
restrictions	Sequence[PdfRestriction] | None	Permission restriction literals for protected PDFs.	None
current_open_password	str | None	Current user/open password required to unlock the source PDF before changes.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

add_text_to_pdf

add_text_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    text_objects: PdfAddTextObject
    | Sequence[PdfAddTextObject],
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Insert one or more text blocks into a PDF.

Places one or more text overlays onto a PDF with font, size, color, opacity, position, and rotation controls. This supports annotations, stamps, and templated labeling workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
text_objects	PdfAddTextObject | Sequence[PdfAddTextObject]	Text overlay objects to draw onto the document.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

apply_redactions

apply_redactions(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    rgb_color: PdfRGBColor
    | Sequence[int]
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Apply previously previewed redactions and return the final redacted PDF.

Applies irreversible redactions to the PDF based on provided rules and outputs a redacted document. Use this after validating coverage with preview_redactions.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
rgb_color	PdfRGBColor | Sequence[int] | None	RGB fill color applied to redaction rectangles when previewing/applying redactions.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

blank_pdf

blank_pdf(
    *,
    page_size: PdfPageSize = "letter",
    page_count: int = 1,
    page_orientation: PdfPageOrientation
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Create a blank PDF with configurable size, count, and orientation.

Creates a new blank PDF with configurable page size, orientation, and page count. This is useful as a template baseline for downstream stamping/filling workflows.

Parameters:

Name	Type	Description	Default
page_size	PdfPageSize	Target page size preset or custom size settings used for output page dimensions.	'letter'
page_count	int	Number of blank pages to generate in the new PDF.	1
page_orientation	PdfPageOrientation | None	Page orientation for standard page sizes (portrait or landscape).	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

change_open_password

change_open_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    current_open_password: str,
    new_open_password: str,
    current_permissions_password: str
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Rotate the open password for an encrypted PDF.

Replaces the existing open password with a new one while preserving or updating related protection options. Use this for credential rotation.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
current_open_password	str	Current user/open password required to unlock the source PDF before changes.	required
new_open_password	str	New user/open password required to open the output PDF.	required
current_permissions_password	str | None	Current owner/permissions password used to authorize permission updates/removal.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

change_permissions_password

change_permissions_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    current_permissions_password: str,
    new_permissions_password: str,
    restrictions: Sequence[PdfRestriction]
    | None = None,
    current_open_password: str | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Rotate the permissions password and optionally update restrictions.

Updates owner permissions/password settings and restriction flags on an already protected PDF. Use this to rotate credentials or revise allowed actions.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
current_permissions_password	str	Current owner/permissions password used to authorize permission updates/removal.	required
new_permissions_password	str	New owner/permissions password to apply to the output PDF.	required
restrictions	Sequence[PdfRestriction] | None	Permission restriction literals for protected PDFs.	None
current_open_password	str | None	Current user/open password required to unlock the source PDF before changes.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

compress_pdf

compress_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    compression_level: CompressionLevel,
    profile: PdfRestFile
    | Sequence[PdfRestFile]
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Compress a PDF using preset or custom compression profiles.

Reduces PDF file size using preset or custom compression settings, with optional profile uploads. Use this for storage/bandwidth optimization while balancing quality.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
compression_level	CompressionLevel	Compression level or strategy option.	required
profile	PdfRestFile | Sequence[PdfRestFile] | None	Uploaded color/compression profile as a PdfRestFile.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_colors

convert_colors(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    color_profile: PdfPresetColorProfile
    | PdfRestFile
    | Sequence[PdfRestFile],
    preserve_black: bool = False,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert PDF colors using presets or a custom uploaded ICC profile.

Converts document color spaces using preset profiles and optional black-preservation behavior. Use this to normalize output for print pipelines or color-management requirements.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
color_profile	PdfPresetColorProfile | PdfRestFile | Sequence[PdfRestFile]	Named color profile used by color conversion.	required
preserve_black	bool	When true, keeps pure black content from being remapped during color-profile conversion.	False
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_email_to_pdf

convert_email_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert an RFC822 email file to PDF.

Converts email message files into PDF, including rendered message content and supported metadata/body parts. This supports archiving and compliance workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_html_to_pdf

convert_html_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    compression: PdfConversionCompression = "lossy",
    downsample: PdfConversionDownsample = 300,
    page_size: HtmlPageSize = "letter",
    page_margin: str = "1.0in",
    page_orientation: HtmlPageOrientation = "portrait",
    web_layout: HtmlWebLayout = "desktop",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert an uploaded HTML file to PDF.

Renders HTML content into PDF with page-size/orientation/layout and related rendering controls. This supports report generation and web-to-PDF publishing use cases.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
compression	PdfConversionCompression	Compression mode used during conversion.	'lossy'
downsample	PdfConversionDownsample	Image downsampling setting for conversion.	300
page_size	HtmlPageSize	Target page size preset or custom size settings used for output page dimensions.	'letter'
page_margin	str	Page margin setting (for example 8mm or 0.5in) for HTML/URL rendering outputs.	'1.0in'
page_orientation	HtmlPageOrientation	Page orientation for standard page sizes (portrait or landscape).	'portrait'
web_layout	HtmlWebLayout	Rendering viewport profile (desktop, tablet, or mobile) for HTML/URL conversion.	'desktop'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_image_to_pdf

convert_image_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert a supported image file to PDF.

Converts one or more image files into PDF output and can combine them into multipage documents. Use this to normalize scanned/image assets into PDF containers.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_office_to_pdf

convert_office_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    compression: PdfConversionCompression = "lossy",
    downsample: PdfConversionDownsample = 300,
    tagged_pdf: bool = False,
    locale: PdfConversionLocale | None = None,
    page_size: HtmlPageSize | None = None,
    page_margin: str | None = None,
    page_orientation: HtmlPageOrientation
    | None = None,
    web_layout: HtmlWebLayout | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert a Microsoft Office file (Word, Excel, PowerPoint) to PDF.

Converts Office documents into PDF output using conversion options for layout and fidelity. This is the main entry point for Word/Excel/PowerPoint-to-PDF workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
compression	PdfConversionCompression	Compression mode used during conversion.	'lossy'
downsample	PdfConversionDownsample	Image downsampling setting for conversion.	300
tagged_pdf	bool	For Office conversion, toggles generation of tagged PDFs for accessibility workflows.	False
locale	PdfConversionLocale | None	Locale used by locale-aware conversion options.	None
page_size	HtmlPageSize | None	Target page size preset or custom size settings used for output page dimensions.	None
page_margin	str | None	Page margin setting (for example 8mm or 0.5in) for HTML/URL rendering outputs.	None
page_orientation	HtmlPageOrientation | None	Page orientation for standard page sizes (portrait or landscape).	None
web_layout	HtmlWebLayout | None	Rendering viewport profile (desktop, tablet, or mobile) for HTML/URL conversion.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_postscript_to_pdf

convert_postscript_to_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    compression: PdfConversionCompression = "lossy",
    downsample: PdfConversionDownsample
    | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert a PostScript or EPS file to PDF.

Converts PostScript content to PDF while preserving page content for modern PDF workflows. Use this when ingesting legacy print-oriented document formats.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
compression	PdfConversionCompression	Compression mode used during conversion.	'lossy'
downsample	PdfConversionDownsample | None	Image downsampling setting for conversion.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_bmp

convert_to_bmp(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_prefix: str | None = None,
    page_range: str | Sequence[str] | None = None,
    resolution: int = 300,
    color_model: BmpColorModel = "rgb",
    smoothing: GraphicSmoothing
    | Sequence[GraphicSmoothing] = "none",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert one or more pdfRest files to BMP images.

Converts PDF pages to BMP images with configurable color model and page selection. Use this for legacy bitmap workflows that require BMP output.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
page_range	str | Sequence[str] | None	Page selection string/list for image conversion outputs.	None
resolution	int	Raster output resolution in DPI for generated image files.	300
color_model	BmpColorModel	Output image color model.	'rgb'
smoothing	GraphicSmoothing | Sequence[GraphicSmoothing]	Graphic smoothing mode for image output endpoints.	'none'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_excel

convert_to_excel(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert a PDF to an Excel spreadsheet.

Converts PDF content into Excel workbook output optimized for tabular data extraction. Use this for spreadsheet-centric review or data cleanup workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_gif

convert_to_gif(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_prefix: str | None = None,
    page_range: str | Sequence[str] | None = None,
    resolution: int = 300,
    color_model: GifColorModel = "rgb",
    smoothing: GraphicSmoothing
    | Sequence[GraphicSmoothing] = "none",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert one or more pdfRest files to GIF images.

Converts PDF pages to GIF images with configurable color model and page selection. Useful for lightweight graphics workflows and compatibility scenarios.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
page_range	str | Sequence[str] | None	Page selection string/list for image conversion outputs.	None
resolution	int	Raster output resolution in DPI for generated image files.	300
color_model	GifColorModel	Output image color model.	'rgb'
smoothing	GraphicSmoothing | Sequence[GraphicSmoothing]	Graphic smoothing mode for image output endpoints.	'none'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_jpeg

convert_to_jpeg(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_prefix: str | None = None,
    page_range: str | Sequence[str] | None = None,
    resolution: int = 300,
    color_model: JpegColorModel = "rgb",
    smoothing: GraphicSmoothing
    | Sequence[GraphicSmoothing] = "none",
    jpeg_quality: int = 75,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert one or more pdfRest files to JPEG images.

Converts PDF pages to JPEG images with configurable color model and page selection. Use this for compressed photo-friendly page exports.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
page_range	str | Sequence[str] | None	Page selection string/list for image conversion outputs.	None
resolution	int	Raster output resolution in DPI for generated image files.	300
color_model	JpegColorModel	Output image color model.	'rgb'
smoothing	GraphicSmoothing | Sequence[GraphicSmoothing]	Graphic smoothing mode for image output endpoints.	'none'
jpeg_quality	int	JPEG quality setting (1-100) controlling compression level and output fidelity.	75
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_markdown

convert_to_markdown(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    pages: PdfPageSelection | None = None,
    page_break_comments: bool = False,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert a PDF to Markdown and return a file-based response.

Converts document content into Markdown and supports either inline text output or file output. This is useful when preparing PDFs for LLM/RAG indexing and markdown-centric tooling.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
page_break_comments	bool	When true, inserts page-break marker comments in generated Markdown between source pages.	False
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_pdfa

convert_to_pdfa(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_type: PdfAType,
    output: str | None = None,
    rasterize_if_errors_encountered: bool = False,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert a PDF to a specified PDF/A version.

Converts input PDFs to selected PDF/A conformance levels for long-term archival compatibility. Choose the target conformance profile that matches your compliance requirements.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_type	PdfAType	Output mode for endpoints supporting inline or file output.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
rasterize_if_errors_encountered	bool	When enabled, allows rasterized fallback if strict conformance conversion encounters nonconforming content.	False
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_pdfx

convert_to_pdfx(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_type: PdfXType,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert a PDF to a specified PDF/X version.

Converts input PDFs to selected PDF/X conformance levels for print-production workflows. Use this when downstream print tooling expects standardized PDF/X output.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_type	PdfXType	Output mode for endpoints supporting inline or file output.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_png

convert_to_png(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_prefix: str | None = None,
    page_range: str | Sequence[str] | None = None,
    resolution: int = 300,
    color_model: PngColorModel = "rgb",
    smoothing: GraphicSmoothing
    | Sequence[GraphicSmoothing] = "none",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert one or more pdfRest files to PNG images.

Converts PDF pages to PNG images with configurable color model, smoothing, and page selection controls. Suitable for high-fidelity raster exports and previews.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
page_range	str | Sequence[str] | None	Page selection string/list for image conversion outputs.	None
resolution	int	Raster output resolution in DPI for generated image files.	300
color_model	PngColorModel	Output image color model.	'rgb'
smoothing	GraphicSmoothing | Sequence[GraphicSmoothing]	Graphic smoothing mode for image output endpoints.	'none'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_powerpoint

convert_to_powerpoint(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert a PDF to a PowerPoint presentation.

Converts PDF pages into PowerPoint output suitable for slide editing and presentation reuse. This helps repurpose static PDF material into editable decks.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_tiff

convert_to_tiff(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_prefix: str | None = None,
    page_range: str | Sequence[str] | None = None,
    resolution: int = 300,
    color_model: TiffColorModel = "rgb",
    smoothing: GraphicSmoothing
    | Sequence[GraphicSmoothing] = "none",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert one or more pdfRest files to TIFF images.

Converts PDF pages to TIFF images with configurable color model and page selection. This is commonly used in archival, scanning, and print-imaging pipelines.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
page_range	str | Sequence[str] | None	Page selection string/list for image conversion outputs.	None
resolution	int	Raster output resolution in DPI for generated image files.	300
color_model	TiffColorModel	Output image color model.	'rgb'
smoothing	GraphicSmoothing | Sequence[GraphicSmoothing]	Graphic smoothing mode for image output endpoints.	'none'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_to_word

convert_to_word(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert a PDF to a Word document.

Converts PDF content into Word output for document editing workflows. This is useful when users need editable text and layout reconstruction in DOCX format.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_url_to_pdf

convert_url_to_pdf(
    url: UrlValue,
    *,
    output: str | None = None,
    compression: PdfConversionCompression = "lossy",
    downsample: PdfConversionDownsample = 300,
    page_size: HtmlPageSize = "letter",
    page_margin: str = "1.0in",
    page_orientation: HtmlPageOrientation = "portrait",
    web_layout: HtmlWebLayout = "desktop",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert HTML content from one URL to PDF.

Fetches remote web content by URL and renders it to PDF using HTML rendering options. Use this for automated webpage capture and archival.

Parameters:

Name	Type	Description	Default
url	UrlValue	Remote URL to ingest and convert.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
compression	PdfConversionCompression	Compression mode used during conversion.	'lossy'
downsample	PdfConversionDownsample	Image downsampling setting for conversion.	300
page_size	HtmlPageSize	Target page size preset or custom size settings used for output page dimensions.	'letter'
page_margin	str	Page margin setting (for example 8mm or 0.5in) for HTML/URL rendering outputs.	'1.0in'
page_orientation	HtmlPageOrientation	Page orientation for standard page sizes (portrait or landscape).	'portrait'
web_layout	HtmlWebLayout	Rendering viewport profile (desktop, tablet, or mobile) for HTML/URL conversion.	'desktop'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

convert_xfa_to_acroforms

convert_xfa_to_acroforms(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Convert an XFA PDF to an AcroForm-enabled PDF.

Converts XFA form PDFs into AcroForm-compatible PDFs for broader tooling compatibility. Use this before importing/exporting form data with AcroForm-focused flows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

export_form_data

export_form_data(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    data_format: ExportDataFormat,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Export form data from a PDF into an external data file.

Exports form field data from a PDF into a structured data format (such as XFDF/FDF/XML). Use this for downstream processing, storage, or migration of form values.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
data_format	ExportDataFormat	Output form-data format to export (for example XFDF, FDF, XML, XDP, or XFD).	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

extract_images

extract_images(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    pages: PdfPageSelection | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Extract embedded images from a PDF.

Extracts embedded images from the source PDF and returns them as output files. This is useful for asset reuse, auditing image quality, or downstream image processing.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

extract_pdf_text

extract_pdf_text(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    pages: PdfPageSelection | None = None,
    full_text: Literal[
        "off", "by_page", "document"
    ] = "document",
    preserve_line_breaks: bool = False,
    word_style: bool = False,
    word_coordinates: bool = False,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> ExtractedTextDocument

Extract text content from a PDF and return parsed JSON results.

Extracts text from a PDF as inline JSON text content. Use pages to limit scope and granularity/related options to control how text is aggregated.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
full_text	Literal['off', 'by_page', 'document']	Controls full-text output mode: disabled, aggregated document text, or per-page text blocks.	'document'
preserve_line_breaks	bool	Preserves detected line breaks in full-text output instead of flattening lines.	False
word_style	bool	Includes per-word style metadata such as font, size, and color in structured output.	False
word_coordinates	bool	Includes per-word coordinate metadata for positional text extraction.	False
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
ExtractedTextDocument	Validated ExtractedTextDocument model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

extract_pdf_text_to_file

extract_pdf_text_to_file(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    pages: PdfPageSelection | None = None,
    full_text: ExtractTextGranularity = "document",
    preserve_line_breaks: bool = False,
    word_style: bool = False,
    word_coordinates: bool = False,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Extract text content from a PDF and return a file-based response.

Extracts text into file outputs (including richer structured formats when requested). Use this for large outputs or when you need durable extracted-text artifacts.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
full_text	ExtractTextGranularity	Controls full-text output mode: disabled, aggregated document text, or per-page text blocks.	'document'
preserve_line_breaks	bool	Preserves detected line breaks in full-text output instead of flattening lines.	False
word_style	bool	Includes per-word style metadata such as font, size, and color in structured output.	False
word_coordinates	bool	Includes per-word coordinate metadata for positional text extraction.	False
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

flatten_annotations

flatten_annotations(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Flatten annotations into the PDF content.

Burns annotation markup into page content so comments/highlights become static and non-editable. Use this when sharing finalized review copies.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

flatten_layers

flatten_layers(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Flatten all layers in a PDF into a single layer.

Flattens optional content groups (layers) into a single visible page representation. This avoids layer-dependent rendering differences across viewers.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

flatten_pdf_forms

flatten_pdf_forms(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Flatten form fields in a PDF so they are no longer editable.

Flattens interactive form fields into static page content so values are no longer editable. This is commonly used for finalization and archival workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

flatten_transparencies

flatten_transparencies(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    quality: FlattenQuality = "medium",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Flatten transparent objects in a PDF.

Flattens transparent objects into opaque content using selectable quality levels. This improves compatibility with workflows/devices that do not fully support transparency.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
quality	FlattenQuality	Quality preset understood by the selected endpoint.	'medium'
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

import_form_data

import_form_data(
    file: PdfRestFile | Sequence[PdfRestFile],
    data_file: PdfRestFile
    | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Import form data from a data file into an existing PDF with form fields.

Imports external form-data files (XFDF/FDF/XML variants) into a source PDF and outputs a filled document. This supports bulk form-filling and integration pipelines.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
data_file	PdfRestFile | Sequence[PdfRestFile]	Uploaded form-data file (for example XFDF/FDF/XML/XDP/XFD) to import into the PDF.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

linearize_pdf

linearize_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Linearize a PDF for optimized fast web view.

Linearizes the PDF for fast web view so first pages render sooner over network delivery. This improves user experience for browser-based document viewing.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

merge_pdfs

merge_pdfs(
    sources: Sequence[PdfMergeInput],
    *,
    output_prefix: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Merge multiple PDFs (or page subsets) into a single PDF file.

Merges multiple uploaded PDFs into a single output, with optional per-input page selections. This is useful for packet assembly and document bundling.

Parameters:

Name	Type	Description	Default
sources	Sequence[PdfMergeInput]	Merge source list containing files with optional page selections per source.	required
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

ocr_pdf

ocr_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    languages: OcrLanguage
    | Sequence[OcrLanguage] = "English",
    pages: PdfPageSelection | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Perform OCR on a PDF to make text searchable and extractable.

Runs OCR on image-based PDFs to produce searchable text layers while preserving PDF layout. Use language to guide recognition and output to control output naming.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
languages	OcrLanguage | Sequence[OcrLanguage]	OCR language(s) to use when recognizing text in scanned or image-based pages.	'English'
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

preview_redactions

preview_redactions(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    redactions: PdfRedactionInstruction
    | Sequence[PdfRedactionInstruction],
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Generate a PDF redaction preview with annotated redaction rectangles.

Builds a redaction preview PDF so you can inspect matches before permanently removing content. Redaction rules support literals, regex patterns, and preset detectors.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
redactions	PdfRedactionInstruction | Sequence[PdfRedactionInstruction]	Redaction rules to preview or apply.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

query_pdf_info

query_pdf_info(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    queries: Sequence[PdfInfoQuery]
    | PdfInfoQuery = ALL_PDF_INFO_QUERIES,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestInfoResponse

Query pdfRest for metadata describing a PDF document.

Retrieves PDF metadata and structural flags (for example page count, tags, signatures, forms, transparency, and permission state). The queries argument controls which info keys pdfRest computes and returns.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
queries	Sequence[PdfInfoQuery] | PdfInfoQuery	Info fields to query from the /pdf-info endpoint.	ALL_PDF_INFO_QUERIES
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestInfoResponse	Validated PdfRestInfoResponse model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

rasterize_pdf

rasterize_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Rasterize a PDF into a flattened bitmap-based PDF.

Rasterizes PDF pages into image-based page content at a specified resolution. Use this for visual normalization, redaction hardening, or viewer compatibility scenarios.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

remove_open_password

remove_open_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    current_open_password: str,
    current_permissions_password: str
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Decrypt a PDF by removing its open password.

Removes the user/open password requirement from a PDF when the current password is provided. The output document can be opened without viewer authentication.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
current_open_password	str	Current user/open password required to unlock the source PDF before changes.	required
current_permissions_password	str | None	Current owner/permissions password used to authorize permission updates/removal.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

remove_permissions_password

remove_permissions_password(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    current_permissions_password: str,
    current_open_password: str | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Remove permissions restrictions from a PDF.

Removes owner permission restrictions from a PDF when authorized with the existing owner password. This restores unrestricted editing/printing capabilities.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
current_permissions_password	str	Current owner/permissions password used to authorize permission updates/removal.	required
current_open_password	str | None	Current user/open password required to unlock the source PDF before changes.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

sign_pdf

sign_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    signature_configuration: PdfSignatureConfiguration,
    credentials: PdfSignatureCredentials,
    logo: PdfRestFile
    | Sequence[PdfRestFile]
    | None = None,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Digitally sign a PDF using PFX credentials or a certificate/private key.

Applies digital signatures using either PFX credentials or certificate/private-key inputs, with configurable visible signature placement and appearance. Use this for integrity, authenticity, and non-repudiation workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
signature_configuration	PdfSignatureConfiguration	Signature placement and appearance settings.	required
credentials	PdfSignatureCredentials	Digital signing credential bundle (PFX or cert/key files).	required
logo	PdfRestFile | Sequence[PdfRestFile] | None	Optional uploaded logo file displayed in visible digital signature appearances.	None
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

split_pdf

split_pdf(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    page_groups: Sequence[PdfPageSelection]
    | PdfPageSelection
    | None = None,
    output_prefix: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Split a PDF into one or more PDF files based on the provided page groups.

Splits a PDF into multiple outputs using page selections and grouping rules. Use this to break long documents into per-range or per-section files.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
page_groups	Sequence[PdfPageSelection] | PdfPageSelection | None	Page-selection groups that define each split output document.	None
output_prefix	str | None	Filename prefix used for generated per-page/per-file image outputs.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

summarize_text

summarize_text(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    target_word_count: int = 400,
    summary_format: SummaryFormat = "overview",
    pages: PdfPageSelection | None = None,
    output_format: SummaryOutputFormat = "markdown",
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> SummarizePdfTextResponse

Summarize the textual content of a PDF, Markdown, or text document.

Generates an inline summary from document text and returns it in a structured response model. You can scope to pages, choose summary style, and control output formatting for downstream display.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
target_word_count	int	Approximate target length for generated summary text.	400
summary_format	SummaryFormat	Summary layout/style requested from pdfRest.	'overview'
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output_format	SummaryOutputFormat	Text format returned for generated textual output.	'markdown'
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
SummarizePdfTextResponse	Validated SummarizePdfTextResponse model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

summarize_text_to_file

summarize_text_to_file(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    target_word_count: int = 400,
    summary_format: SummaryFormat = "overview",
    pages: PdfPageSelection | None = None,
    output_format: SummaryOutputFormat = "markdown",
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Summarize a document and return the result as a downloadable file.

Generates a summary and returns a file-based response containing the produced summary document. Use this when you want downloadable artifacts instead of inline summary text.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
target_word_count	int	Approximate target length for generated summary text.	400
summary_format	SummaryFormat	Summary layout/style requested from pdfRest.	'overview'
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output_format	SummaryOutputFormat	Text format returned for generated textual output.	'markdown'
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

translate_pdf_text

translate_pdf_text(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_language: str,
    pages: PdfPageSelection | None = None,
    output_format: TranslateOutputFormat = "markdown",
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> TranslatePdfTextResponse

Translate the textual content of a PDF, Markdown, or text document (JSON).

Translates extracted document text and returns translated content inline when output_type is JSON. Supports page scoping and output formatting for multilingual text workflows.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_language	str	Target language for translated output text.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output_format	TranslateOutputFormat	Text format returned for generated textual output.	'markdown'
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
TranslatePdfTextResponse	Validated TranslatePdfTextResponse model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

translate_pdf_text_to_file

translate_pdf_text_to_file(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    output_language: str,
    pages: PdfPageSelection | None = None,
    output_format: TranslateOutputFormat = "markdown",
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> TranslatePdfTextFileResponse

Translate textual content and receive a file-based response.

Translates document text and returns a file-based response with translated output artifacts. Choose this when you need downloadable translated files instead of inline text.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output_language	str	Target language for translated output text.	required
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
output_format	TranslateOutputFormat	Text format returned for generated textual output.	'markdown'
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
TranslatePdfTextFileResponse	Validated TranslatePdfTextFileResponse model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

unzip_file

unzip_file(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    password: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Extract files from a zip archive.

Expands an uploaded ZIP archive into individual files on pdfRest storage and returns metadata for the extracted resources. This is useful when reusing uploaded bundles in later API calls.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
password	str | None	Password value used by encrypt/decrypt endpoints.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

up

up(
    *,
    extra_headers: AnyMapping | None = None,
    extra_query: Query | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> UpResponse

Call the /up health endpoint and return server metadata.

Calls the health endpoint and returns service metadata such as status, product, version, and release date. Use this as a lightweight connectivity check before running document workflows.

Parameters:

Name	Type	Description	Default
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
UpResponse	Validated UpResponse model.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

watermark_pdf_with_image

watermark_pdf_with_image(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    watermark_file: PdfRestFile
    | Sequence[PdfRestFile],
    output: str | None = None,
    watermark_file_scale: float = 0.5,
    opacity: float = 0.5,
    horizontal_alignment: WatermarkHorizontalAlignment = "center",
    vertical_alignment: WatermarkVerticalAlignment = "center",
    x: int = 0,
    y: int = 0,
    rotation: int = 0,
    pages: PdfPageSelection | None = None,
    behind_page: bool = False,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Apply an image watermark to a PDF.

Applies image watermarks (for example logos/seals) with placement and opacity controls. This is useful for branded overlays and visual ownership marks.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
watermark_file	PdfRestFile | Sequence[PdfRestFile]	Uploaded image used as watermark content.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
watermark_file_scale	float	Scale multiplier applied to the watermark file graphic before placement.	0.5
opacity	float	Opacity in range 0.0 to 1.0.	0.5
horizontal_alignment	WatermarkHorizontalAlignment	Horizontal alignment anchor used when placing watermark content.	'center'
vertical_alignment	WatermarkVerticalAlignment	Vertical alignment anchor used when placing watermark content.	'center'
x	int	Horizontal position in PDF points.	0
y	int	Vertical position in PDF points.	0
rotation	int	Rotation angle in degrees.	0
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
behind_page	bool	Target page number (or selector) where inserted content should be applied.	False
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

watermark_pdf_with_text

watermark_pdf_with_text(
    file: PdfRestFile | Sequence[PdfRestFile],
    *,
    watermark_text: str,
    output: str | None = None,
    font: str | None = None,
    text_size: int = 72,
    text_color: PdfTextColor = (0, 0, 0),
    opacity: float = 0.5,
    horizontal_alignment: WatermarkHorizontalAlignment = "center",
    vertical_alignment: WatermarkVerticalAlignment = "center",
    x: int = 0,
    y: int = 0,
    rotation: int = 0,
    pages: PdfPageSelection | None = None,
    behind_page: bool = False,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Apply a text watermark to a PDF.

Applies text watermarks with control over placement, rotation, color, opacity, and alignment. Use this for confidentiality marks, drafts, and document branding.

Parameters:

Name	Type	Description	Default
file	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
watermark_text	str	Text content to render as the watermark.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
font	str | None	Font family name for rendered text.	None
text_size	int	Watermark text size in points.	72
text_color	PdfTextColor	Watermark text color as RGB or CMYK channel values.	(0, 0, 0)
opacity	float	Opacity in range 0.0 to 1.0.	0.5
horizontal_alignment	WatermarkHorizontalAlignment	Horizontal alignment anchor used when placing watermark content.	'center'
vertical_alignment	WatermarkVerticalAlignment	Vertical alignment anchor used when placing watermark content.	'center'
x	int	Horizontal position in PDF points.	0
y	int	Vertical position in PDF points.	0
rotation	int	Rotation angle in degrees.	0
pages	PdfPageSelection | None	Page selection to constrain processing to specific pages.	None
behind_page	bool	Target page number (or selector) where inserted content should be applied.	False
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

zip_files

zip_files(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    output: str | None = None,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileBasedResponse

Compress one or more files into a zip archive.

Packages uploaded files into a ZIP archive and returns it as a file-based response. Use this to consolidate multiple outputs for a single download.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	Uploaded input file or files as PdfRestFile objects.	required
output	str | None	Output filename prefix used by pdfRest when creating files.	None
extra_query	Query | None	Additional query parameters merged into the request.	None
extra_headers	AnyMapping | None	Additional HTTP headers merged into the request.	None
extra_body	Body | None	Additional request body fields merged into the payload.	None
timeout	TimeoutTypes | None	Request timeout override for this call.	None

Returns:

Type	Description
PdfRestFileBasedResponse	Validated file-based response returned by pdfRest.

Raises:

Type	Description
PdfRestError	If request execution fails at the client or API layer.
ValidationError	If local payload validation fails before sending.

PdfRestConfigurationError

Bases: PdfRestError

Raised when the client is misconfigured (for example, missing API key).

PdfRestDeleteError

Bases: PdfRestError

Raised when an individual file cannot be deleted.

__init__

__init__(
    file_id: PdfRestFileID | str, message: str
) -> None

Initialize a delete failure for one uploaded file.

Parameters:

Name	Type	Description	Default
file_id	PdfRestFileID | str	Identifier of the file that failed to delete.	required
message	str	Error detail returned for the deletion attempt.	required

PdfRestError

Bases: Exception

Base exception for all pdfrest client errors.

PdfRestErrorGroup

Bases: ExceptionGroup

Group of PdfRestError exceptions produced by the PDF REST library.

__init__

__init__(
    message: str, exceptions: Sequence[Exception]
) -> None

Initialize a grouped pdfRest failure.

Parameters:

Name	Type	Description	Default
message	str	Summary message for the grouped error.	required
exceptions	Sequence[Exception]	Collection of PdfRestError instances.	required

Raises:

Type	Description
TypeError	If any item in exceptions is not a PdfRestError.

PdfRestFilesClient

Bases: Protocol

Public interface for file operations returned by files helpers.

This protocol describes the object returned by PdfRestClient.files. Retrieve this helper from client.files; do not instantiate it directly.

create

create(
    files: UploadFiles,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> list[PdfRestFile]

Upload one or more local file objects.

Parameters:

Name	Type	Description	Default
files	UploadFiles	Multipart file payload(s) accepted by httpx upload APIs.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
list[PdfRestFile]	Metadata for uploaded files.

create_from_paths

create_from_paths(
    file_paths: FilePathInput,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> list[PdfRestFile]

Upload one or more files by filesystem path.

Parameters:

Name	Type	Description	Default
file_paths	FilePathInput	Path input(s), optionally with content type and headers.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
list[PdfRestFile]	Metadata for uploaded files.

create_from_urls

create_from_urls(
    urls: UrlInput,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> list[PdfRestFile]

Upload one or more files by remote URL.

Parameters:

Name	Type	Description	Default
urls	UrlInput	One URL or a sequence of URLs to upload.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
extra_body	Body | None	Additional JSON body fields merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
list[PdfRestFile]	Metadata for uploaded files.

delete

delete(
    files: PdfRestFile | Sequence[PdfRestFile],
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    extra_body: Body | None = None,
    timeout: TimeoutTypes | None = None,
) -> None

Delete one or more previously uploaded files.

Parameters:

Name	Type	Description	Default
files	PdfRestFile | Sequence[PdfRestFile]	File reference(s) to delete.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
extra_body	Body | None	Additional JSON body fields merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Raises:

Type	Description
PdfRestErrorGroup	Raised when one or more deletions fail. Individual failures are reported as PdfRestDeleteError items in the group.

get

get(
    id: PdfRestFileID | str,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFile

Retrieve metadata for an uploaded file.

Parameters:

Name	Type	Description	Default
id	PdfRestFileID | str	Uploaded file identifier.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
PdfRestFile	The resolved file metadata.

read_bytes

read_bytes(
    file_ref: PdfRestFile | str,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> bytes

Download a file and return its raw bytes.

Parameters:

Name	Type	Description	Default
file_ref	PdfRestFile | str	File object or file id to download.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
bytes	The downloaded bytes.

read_json

read_json(
    file_ref: PdfRestFile | str,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> Any

Download a file and parse its content as JSON.

Parameters:

Name	Type	Description	Default
file_ref	PdfRestFile | str	File object or file id to download.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
Any	Parsed JSON value.

read_text

read_text(
    file_ref: PdfRestFile | str,
    *,
    encoding: str = "utf-8",
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> str

Download a file and decode it into text.

Parameters:

Name	Type	Description	Default
file_ref	PdfRestFile | str	File object or file id to download.	required
encoding	str	Text encoding used when decoding the response.	'utf-8'
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
str	The decoded text content.

stream

stream(
    file_ref: PdfRestFile | str,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> PdfRestFileStream

Open a streaming download for a file.

Parameters:

Name	Type	Description	Default
file_ref	PdfRestFile | str	File object or file id to download.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
PdfRestFileStream	A synchronous streaming wrapper around the HTTP response.

write_bytes

write_bytes(
    file_ref: PdfRestFile | str,
    destination: DestinationPath,
    *,
    extra_query: Query | None = None,
    extra_headers: AnyMapping | None = None,
    timeout: TimeoutTypes | None = None,
) -> Path

Download a file and persist it to disk.

Parameters:

Name	Type	Description	Default
file_ref	PdfRestFile | str	File object or file id to download.	required
destination	DestinationPath	Output path for the downloaded file.	required
extra_query	Query | None	Additional query parameters appended to the request.	None
extra_headers	AnyMapping | None	Additional headers merged into the request.	None
timeout	TimeoutTypes | None	Optional request timeout override.	None

Returns:

Type	Description
Path	The written destination path.

PdfRestRequestError

Bases: PdfRestError

Raised when the request fails before receiving a response.

PdfRestTimeoutError

Bases: PdfRestError

Raised when a request to pdfrest exceeds the configured timeout.

PdfRestTransportError

Bases: PdfRestError

Raised when a transport-level error occurs while communicating with pdfrest.

UpResponse

Bases: BaseModel

Response payload returned by the /up health endpoint.

product instance-attribute

product: str

Product identifier reported by the service.

release_date class-attribute instance-attribute

release_date: date = Field(alias='releaseDate')

Release date for the deployed pdfRest version.

status instance-attribute

status: str

Service health status string returned by pdfRest.

version instance-attribute

version: str

Semantic version identifier for the running service.

translate_httpx_error

translate_httpx_error(
    exc: HTTPError,
) -> PdfRestError

Convert an httpx exception into a library-specific exception.

Public Types

pdfrest.types

Public import surface for shared pdfrest types.

PdfAddTextObject

Bases: TypedDict

Text overlay object used by add-text style operations.

Attributes:

Name	Type	Description
font	Required[str]	Font family name used to render text.
max_width	Required[float]	Maximum text box width in PDF points.
opacity	Required[float]	Opacity value from 0.0 (transparent) to 1.0 (opaque).
page	Required[Literal['all'] | int]	One-based page number or "all" for every page.
rotation	Required[float]	Rotation angle in degrees.
text	Required[str]	Text content to draw.
text_color_rgb	PdfRGBColor	Optional RGB text color tuple.
text_color_cmyk	PdfCMYKColor	Optional CMYK text color tuple.
text_size	Required[float]	Font size in points.
x	Required[float]	Horizontal origin in PDF points.
y	Required[float]	Vertical origin in PDF points.
is_right_to_left	bool	Whether text should be rendered right-to-left.

PdfCustomPageSize

Bases: TypedDict

Custom page dimensions for page-size aware conversions.

Attributes:

Name	Type	Description
custom_height	Required[float]	Page height in points.
custom_width	Required[float]	Page width in points.

PdfMergeSource

Bases: TypedDict

Merge item containing an uploaded file and optional page selection.

PdfRedactionInstruction

Bases: TypedDict

Single redaction rule for preview/apply redaction operations.

PdfSignatureDisplay

Bases: TypedDict

Optional text fields included in visible signature appearances.

Attributes:

Name	Type	Description
include_distinguished_name	bool	Whether to include signer DN text.
include_datetime	bool	Whether to include signing date/time text.
contact	str	Contact text shown in the visible signature.
location	str	Location text shown in the visible signature.
name	str	Signer name text shown in the visible signature.
reason	str	Signing reason text shown in the visible signature.

PdfSignatureLocation

Bases: TypedDict

Bounding box and page where a signature field should be rendered.

Attributes:

Name	Type	Description
bottom_left	Required[PdfSignaturePoint]	Bottom-left PdfSignaturePoint of the signature rectangle.
top_right	Required[PdfSignaturePoint]	Top-right PdfSignaturePoint of the signature rectangle.
page	Required[str | int]	One-based page index or "all".

PdfSignaturePoint

Bases: TypedDict

Coordinate point used for signature placement in PDF points.

Attributes:

Name	Type	Description
x	float	Horizontal position in points.
y	float	Vertical position in points.

Public Models

pdfrest.models

Public model exports for the pdfrest.models package.

ExtractTextResponse

Bases: BaseModel

Response returned by the extracted-text tool.

full_text class-attribute instance-attribute

full_text: Annotated[
    str | None,
    Field(
        alias="fullText",
        validation_alias=AliasChoices(
            "full_text", "fullText"
        ),
        description="Inline extracted text when output_type is json.",
        default=None,
    ),
] = None

Inline extracted text when output_type is json.

input_id instance-attribute

input_id: Annotated[
    PdfRestFileID,
    Field(
        validation_alias=AliasChoices(
            "input_id", "inputId"
        ),
        description="The id of the input file.",
    ),
]

The id of the input file.

warning class-attribute instance-attribute

warning: Annotated[
    str | None,
    Field(
        description="A warning that was generated during text extraction."
    ),
] = None

A warning that was generated during text extraction.

ExtractedTextDocument

Bases: BaseModel

Structured representation of the JSON output returned by extract_text_to_file.

full_text class-attribute instance-attribute

full_text: Annotated[
    ExtractedTextFullText | None,
    Field(
        alias="fullText",
        validation_alias=AliasChoices(
            "full_text", "fullText"
        ),
        description="Full text output (document string or per-page content).",
        default=None,
    ),
] = None

Full text output (document string or per-page content).

input_id instance-attribute

input_id: Annotated[
    PdfRestFileID,
    Field(
        alias="inputId",
        validation_alias=AliasChoices(
            "input_id", "inputId"
        ),
        description="Identifier of the uploaded PDF.",
    ),
]

Identifier of the uploaded PDF.

words class-attribute instance-attribute

words: Annotated[
    list[ExtractedTextWord] | None,
    Field(
        description="Individual word records when word-level extraction is enabled.",
        default=None,
    ),
] = None

Individual word records when word-level extraction is enabled.

ExtractedTextFullText

Bases: RootModel[str | ExtractedTextFullTextPages]

Full-text extraction payload in document or per-page mode.

Wraps either a single document-level string or a per-page text object and provides convenience accessors for both shapes.

document_text property

document_text: str | None

Return document-level text for either payload shape.

Falls back to joining per-page text when only the page-structured payload is available.

pages property

pages: list[ExtractedTextFullTextPage]

Return per-page text entries when page mode is available.

Raises:

Type	Description
ValueError	If the payload is in document-string mode.

root instance-attribute

root: str | ExtractedTextFullTextPages

Raw payload in document-text or per-page form.

iter_pages

iter_pages() -> list[ExtractedTextFullTextPage]

Return per-page text entries or an empty list in document mode.

This helper avoids forcing callers to catch mode errors when they only need an iterable.

ExtractedTextFullTextPage

Bases: BaseModel

Per-page representation of the aggregated text content.

page instance-attribute

page: Annotated[
    int,
    Field(
        description="1-indexed page number.", ge=1
    ),
]

1-indexed page number.

text instance-attribute

text: Annotated[
    str,
    Field(
        description="Concatenated text for the page."
    ),
]

Concatenated text for the page.

ExtractedTextFullTextPages

Bases: BaseModel

Container for per-page text output.

pages instance-attribute

pages: Annotated[
    list[ExtractedTextFullTextPage],
    Field(
        description="Ordered text for each page present in the document.",
        min_length=1,
    ),
]

Ordered text for each page present in the document.

ExtractedTextPoint

Bases: BaseModel

A point in PDF coordinate space expressed in points.

x instance-attribute

x: Annotated[
    float,
    Field(
        description="Horizontal position in PDF points."
    ),
]

Horizontal position in PDF points.

y instance-attribute

y: Annotated[
    float,
    Field(
        description="Vertical position in PDF points."
    ),
]

Vertical position in PDF points.

ExtractedTextWord

Bases: BaseModel

A single word extracted from a PDF page.

coordinates class-attribute instance-attribute

coordinates: Annotated[
    ExtractedTextWordCoordinates | None,
    Field(
        description="Bounding box for the word when positional data is requested.",
        default=None,
    ),
] = None

Bounding box for the word when positional data is requested.

page instance-attribute

page: Annotated[
    int,
    Field(
        description="1-indexed page number containing the word.",
        ge=1,
    ),
]

1-indexed page number containing the word.

style class-attribute instance-attribute

style: Annotated[
    ExtractedTextWordStyle | None,
    Field(
        description="Font/color details captured for the word.",
        default=None,
    ),
] = None

Font/color details captured for the word.

text instance-attribute

text: Annotated[
    str,
    Field(
        description="Word content as rendered by the PDF."
    ),
]

Word content as rendered by the PDF.

ExtractedTextWordColor

Bases: BaseModel

Font color applied to an extracted word.

space instance-attribute

space: Annotated[
    str,
    Field(
        description="Color space name reported by pdfRest (e.g., DeviceRGB)."
    ),
]

Color space name reported by pdfRest (e.g., DeviceRGB).

values instance-attribute

values: Annotated[
    list[float],
    Field(
        description="Numeric components in the reported color space.",
        min_length=1,
    ),
]

Numeric components in the reported color space.

ExtractedTextWordCoordinates

Bases: BaseModel

Bounding box describing where a word appears on the page.

bottom_left instance-attribute

bottom_left: Annotated[
    ExtractedTextPoint,
    Field(
        alias="bottomLeft",
        validation_alias=AliasChoices(
            "bottom_left", "bottomLeft"
        ),
        description="Lower-left corner of the word bounds.",
    ),
]

Lower-left corner of the word bounds.

bottom_right instance-attribute

bottom_right: Annotated[
    ExtractedTextPoint,
    Field(
        alias="bottomRight",
        validation_alias=AliasChoices(
            "bottom_right", "bottomRight"
        ),
        description="Lower-right corner of the word bounds.",
    ),
]

Lower-right corner of the word bounds.

top_left instance-attribute

top_left: Annotated[
    ExtractedTextPoint,
    Field(
        alias="topLeft",
        validation_alias=AliasChoices(
            "top_left", "topLeft"
        ),
        description="Upper-left corner of the word bounds.",
    ),
]

Upper-left corner of the word bounds.

top_right instance-attribute

top_right: Annotated[
    ExtractedTextPoint,
    Field(
        alias="topRight",
        validation_alias=AliasChoices(
            "top_right", "topRight"
        ),
        description="Upper-right corner of the word bounds.",
    ),
]

Upper-right corner of the word bounds.

ExtractedTextWordFont

Bases: BaseModel

Font metadata applied to an extracted word.

name instance-attribute

name: Annotated[
    str,
    Field(description="Reported font face name."),
]

Reported font face name.

size instance-attribute

size: Annotated[
    float,
    Field(description="Font size in points."),
]

Font size in points.

ExtractedTextWordStyle

Bases: BaseModel

Style information for an extracted word.

color instance-attribute

color: Annotated[
    ExtractedTextWordColor,
    Field(
        description="Color information for the word."
    ),
]

Color information for the word.

font instance-attribute

font: Annotated[
    ExtractedTextWordFont,
    Field(
        description="Font information for the word."
    ),
]

Font information for the word.

PdfRestDeletionResponse

Bases: BaseModel

Response returned by the delete tool.

deletion_responses instance-attribute

deletion_responses: Annotated[
    dict[PdfRestFileID, str],
    Field(
        alias="deletionResponses",
        validation_alias=AliasChoices(
            "deletion_responses",
            "deletionResponses",
        ),
        description="Mapping of file ids to deletion results.",
        min_length=1,
    ),
]

Mapping of file ids to deletion results.

PdfRestErrorResponse

Bases: BaseModel

Error response payloads from pdfRest.

error class-attribute instance-attribute

error: str | None = Field(alias='message')

Human-readable error message returned by the API.

PdfRestFile

Bases: BaseModel

Represents a file on the pdfRest server.

id class-attribute instance-attribute

id: PdfRestFileID = Field(
    min_length=1,
    description="Identifier of the file on the pdfRest server",
)

Identifier of the file on the pdfRest server.

modified class-attribute instance-attribute

modified: AwareDatetime = Field(
    description="The last modified time of the file, which must include time zone info."
)

The last modified time of the file, which must include time zone info.

name class-attribute instance-attribute

name: str = Field(
    min_length=1, description="Name of the file"
)

Name of the file.

scheduled_deletion_time_utc class-attribute instance-attribute

scheduled_deletion_time_utc: (
    AwareDatetime | None
) = Field(
    alias="scheduledDeletionTimeUtc",
    default=None,
    description="The UTC time at which the file will be deleted from the server.",
)

The UTC time at which the file will be deleted from the server.

size class-attribute instance-attribute

size: int = Field(description='Size of the file')

Size of the file.

type class-attribute instance-attribute

type: str = Field(
    min_length=1,
    description="MIME type of the file",
)

MIME type of the file.

url class-attribute instance-attribute

url: HttpUrl = Field(
    description="URL from which the file can be downloaded"
)

URL from which the file can be downloaded.

PdfRestFileBasedResponse

Bases: BaseModel

Response model for file-based pdfRest operations.

Includes input file identifiers, output files, and optional warnings from the API response payload.

input_id property

input_id: PdfRestFileID

Return the lone input id when exactly one input file was supplied.

Raises:

Type	Description
ValueError	If no input id is available or multiple input ids exist.

input_ids instance-attribute

input_ids: Annotated[
    list[PdfRestFileID],
    Field(
        description="The ids of the files that were input to the pdfRest operation",
        validation_alias=AliasChoices(
            "input_id", "inputId"
        ),
    ),
]

The ids of the files that were input to the pdfRest operation.

output_file property

output_file: PdfRestFile

Return the lone output file when exactly one output is available.

Raises:

Type	Description
ValueError	If no output file is available or multiple outputs exist.

output_files instance-attribute

output_files: Annotated[
    list[PdfRestFile],
    Field(
        description="The list of files returned by the pdfRest operation",
        validation_alias=AliasChoices(
            "output_file", "outputFile"
        ),
    ),
]

The list of files returned by the pdfRest operation.

warning class-attribute instance-attribute

warning: Annotated[
    str | None,
    Field(
        description="A warning that was generated during the pdfRest operation"
    ),
] = None

A warning that was generated during the pdfRest operation.

PdfRestFileID

Bases: str

Str-like identifier for pdfRest files.

Format

[optional '1' or '2' prefix] + [UUIDv4 with hyphens]

Examples:

• "de305d2-b6a0-4b5d-9a55-4e4e6d8c2d39" # no prefix
• "1de305d2-b6a0-4b5d-9a55-4e4e6d8c2d39" # prefix '1'
• "2DE305D2-B6A0-4B5D-9A55-4E4E6D8C2D39" # prefix '2' (upper-case input accepted)

Canonical representation is lowercase.

prefix property

prefix: str | None

The leading prefix digit ('1' or '2') if present, else None.

Presence is unambiguous by length:

• 36 chars => no prefix
• 37 chars => prefix present

uuid property

uuid: str

The UUID part (without the optional prefix).

uuid_obj property

uuid_obj: UUID

The UUID object for the UUID part.

__get_pydantic_core_schema__ classmethod

__get_pydantic_core_schema__(
    source_type: Any, handler: Any
) -> CoreSchema

Build a Pydantic v2 core schema for PdfRestFileID.

Accepted inputs: - a UUID (validated as v4) converted to this type with no prefix - a string matching the PdfRestFileID pattern

__get_pydantic_json_schema__ classmethod

__get_pydantic_json_schema__(
    core_schema: Any, handler: Any
) -> JsonSchemaValue

Provide a clean JSON Schema for OpenAPI/JSON Schema generators.

__new__

__new__(value: str) -> PdfRestFileID

Create a normalized file identifier from a validated string.

Parameters:

Name	Type	Description	Default
value	str	Candidate pdfRest file id string.	required

Returns:

Type	Description
PdfRestFileID	Lower-cased, validated file id value.

Raises:

Type	Description
ValueError	If value is not a valid prefixed UUIDv4 identifier.

from_parts classmethod

from_parts(
    u: str | UUID, prefix: int | str | None = None
) -> PdfRestFileID

Build a file id from a UUIDv4 and optional prefix.

Parameters:

Name	Type	Description	Default
u	str | UUID	UUID value as string or uuid.UUID.	required
prefix	int | str | None	Optional leading prefix (1 or 2).	None

Raises:

Type	Description
ValueError	If the UUID is not version 4 or the prefix is invalid.

generate classmethod

generate(
    prefix: int | str | None = None,
) -> PdfRestFileID

Generate a new value with an optional prefix (1 or 2).

is_valid classmethod

is_valid(value: str) -> bool

Quick validity check without constructing the object.

PdfRestInfoResponse

Bases: BaseModel

A response containing the output from the /info route.

all_queries_processed instance-attribute

all_queries_processed: Annotated[
    bool,
    BeforeValidator(
        demo_bool_true_or_passthrough
    ),
    Field(
        validation_alias=AliasChoices(
            "all_queries_processed",
            "allQueriesProcessed",
        ),
        description="Indicates whether all possible queries about the PDF document were successfully processed. This field is required, and the result is true or false.",
    ),
]

Indicates whether all possible queries about the PDF document were successfully processed. This field is required, and the result is true or false.

author class-attribute instance-attribute

author: Annotated[
    str | None,
    Field(
        description="The author of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have an author."
    ),
] = None

The author of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have an author.

contains_acroforms class-attribute instance-attribute

contains_acroforms: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the PDF contains Acroforms. The result is true or false."
    ),
] = None

Indicates whether the PDF contains Acroforms. The result is true or false.

contains_annotations class-attribute instance-attribute

contains_annotations: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the PDF document contains annotations such as notes, highlighted text, file attachments, crossed-out text, or text callout boxes. The result is true or false."
    ),
] = None

Indicates whether the PDF document contains annotations such as notes, highlighted text, file attachments, crossed-out text, or text callout boxes. The result is true or false.

contains_embedded_file class-attribute instance-attribute

contains_embedded_file: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the PDF contains one or more embedded files. The result is true or false."
    ),
] = None

Indicates whether the PDF contains one or more embedded files. The result is true or false.

contains_javascript class-attribute instance-attribute

contains_javascript: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the PDF contains JavaScript. The result is true or false."
    ),
] = None

Indicates whether the PDF contains JavaScript. The result is true or false.

contains_signature class-attribute instance-attribute

contains_signature: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the PDF contains any digital signatures. The result is true or false."
    ),
] = None

Indicates whether the PDF contains any digital signatures. The result is true or false.

contains_transparency class-attribute instance-attribute

contains_transparency: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the PDF contains transparent objects. The result is true or false."
    ),
] = None

Indicates whether the PDF contains transparent objects. The result is true or false.

contains_xfa class-attribute instance-attribute

contains_xfa: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the PDF contains XFA forms. The result is true or false."
    ),
] = None

Indicates whether the PDF contains XFA forms. The result is true or false.

creation_date class-attribute instance-attribute

creation_date: Annotated[
    str | None,
    Field(
        description="The creation date of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a creation date."
    ),
] = None

The creation date of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a creation date.

creator class-attribute instance-attribute

creator: Annotated[
    str | None,
    Field(
        description="The creator of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a creator."
    ),
] = None

The creator of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a creator.

custom_metadata class-attribute instance-attribute

custom_metadata: Annotated[
    dict[str, Any] | None,
    Field(
        description="Custom metadata entries extracted from the PDF. The result is a dictionary mapping keys to their stored values, or None when no custom metadata exists."
    ),
] = None

Custom metadata entries extracted from the PDF. The result is a dictionary mapping keys to their stored values, or None when no custom metadata exists.

doc_language class-attribute instance-attribute

doc_language: Annotated[
    str | None,
    Field(
        description="The language of the document as declared in its metadata. The result is a string."
    ),
] = None

The language of the document as declared in its metadata. The result is a string.

file_size class-attribute instance-attribute

file_size: Annotated[
    int | None,
    BeforeValidator(demo_int_or_passthrough),
    Field(
        description="The size of the PDF file in bytes. The result is an integer."
    ),
] = None

The size of the PDF file in bytes. The result is an integer.

filename class-attribute instance-attribute

filename: Annotated[
    str | None,
    Field(
        description="The name of the PDF file. The result is a string."
    ),
] = None

The name of the PDF file. The result is a string.

image_only class-attribute instance-attribute

image_only: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the document is 'image only,' meaning it consists solely of embedded graphical images with no text or other standard PDF document features except for metadata. The result is true or false."
    ),
] = None

Indicates whether the document is 'image only,' meaning it consists solely of embedded graphical images with no text or other standard PDF document features except for metadata. The result is true or false.

input_id instance-attribute

input_id: Annotated[
    PdfRestFileID,
    Field(
        validation_alias=AliasChoices(
            "input_id", "inputId"
        ),
        description="The id of the input file",
    ),
]

The id of the input file.

keywords class-attribute instance-attribute

keywords: Annotated[
    str | None,
    Field(
        description="The keywords of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not include keywords."
    ),
] = None

The keywords of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not include keywords.

modified_date class-attribute instance-attribute

modified_date: Annotated[
    str | None,
    Field(
        description="The most recent modification date of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a modification date."
    ),
] = None

The most recent modification date of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a modification date.

page_count class-attribute instance-attribute

page_count: Annotated[
    int | None,
    Field(
        description="The number of pages in the PDF document. The result is an integer."
    ),
] = None

The number of pages in the PDF document. The result is an integer.

pdf_version class-attribute instance-attribute

pdf_version: Annotated[
    str | None,
    Field(
        description="The version of the PDF standard used to create the document. The result is a string in the format X.Y.Z, where X, Y, and Z represent the major, minor, and extension versions."
    ),
] = None

The version of the PDF standard used to create the document. The result is a string in the format X.Y.Z, where X, Y, and Z represent the major, minor, and extension versions.

pdfa class-attribute instance-attribute

pdfa: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the document conforms to the PDF/A standard. The result is true or false."
    ),
] = None

Indicates whether the document conforms to the PDF/A standard. The result is true or false.

pdfe_claim class-attribute instance-attribute

pdfe_claim: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the document claims to conform to the PDF/E standard. The result is true or false."
    ),
] = None

Indicates whether the document claims to conform to the PDF/E standard. The result is true or false.

pdfua_claim class-attribute instance-attribute

pdfua_claim: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the document claims to conform to the PDF/UA standard. The result is true or false."
    ),
] = None

Indicates whether the document claims to conform to the PDF/UA standard. The result is true or false.

pdfx_claim class-attribute instance-attribute

pdfx_claim: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the document claims to conform to the PDF/X standard. The result is true or false."
    ),
] = None

Indicates whether the document claims to conform to the PDF/X standard. The result is true or false.

producer class-attribute instance-attribute

producer: Annotated[
    str | None,
    Field(
        description="The producer of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a producer."
    ),
] = None

The producer of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a producer.

requires_password_to_open class-attribute instance-attribute

requires_password_to_open: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the PDF requires a password to open. The result is true or false. *Note*: A document requiring a password cannot be opened by this route and will not provide much other information."
    ),
] = None

Indicates whether the PDF requires a password to open. The result is true or false. Note: A document requiring a password cannot be opened by this route and will not provide much other information.

restrict_permissions_set class-attribute instance-attribute

restrict_permissions_set: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the PDF file has restricted permissions, such as preventing printing, copying, or signing. The result is true or false."
    ),
] = None

Indicates whether the PDF file has restricted permissions, such as preventing printing, copying, or signing. The result is true or false.

subject class-attribute instance-attribute

subject: Annotated[
    str | None,
    Field(
        description="The subject of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a subject."
    ),
] = None

The subject of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a subject.

tagged class-attribute instance-attribute

tagged: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether structure tags are present in the PDF document. The result is true or false."
    ),
] = None

Indicates whether structure tags are present in the PDF document. The result is true or false.

title class-attribute instance-attribute

title: Annotated[
    str | None,
    Field(
        description="The title of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a title."
    ),
] = None

The title of the PDF as retrieved from the metadata. The result is a string that may be empty if the document does not have a title.

uses_embedded_fonts class-attribute instance-attribute

uses_embedded_fonts: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the PDF contains fully embedded fonts. The result is true or false."
    ),
] = None

Indicates whether the PDF contains fully embedded fonts. The result is true or false.

uses_nonembedded_fonts class-attribute instance-attribute

uses_nonembedded_fonts: Annotated[
    bool | None,
    BeforeValidator(
        demo_bool_false_or_passthrough
    ),
    Field(
        description="Indicates whether the PDF contains non-embedded fonts. The result is true or false."
    ),
] = None

Indicates whether the PDF contains non-embedded fonts. The result is true or false.

warning class-attribute instance-attribute

warning: Annotated[
    str | None,
    Field(
        description="A warning indicating why not all queries could be processed."
    ),
] = None

A warning indicating why not all queries could be processed.

SummarizePdfTextResponse

Bases: BaseModel

Response returned by the summarize-pdf-text tool.

input_id instance-attribute

input_id: Annotated[
    PdfRestFileID,
    Field(
        validation_alias=AliasChoices(
            "input_id", "inputId"
        ),
        description="The id of the input file.",
    ),
]

The id of the input file.

summary class-attribute instance-attribute

summary: Annotated[
    str | None,
    Field(
        description="Summary content",
        default=None,
    ),
] = None

Summary content.

TranslatePdfTextFileResponse

Bases: PdfRestFileBasedResponse

File-based response returned by the translated-pdf-text tool.

output_language class-attribute instance-attribute

output_language: Annotated[
    str | None,
    Field(
        alias="output_language",
        validation_alias=AliasChoices(
            "output_language", "outputLanguage"
        ),
        description="Target language used for the translation.",
        default=None,
    ),
] = None

Target language used for the translation.

source_languages class-attribute instance-attribute

source_languages: Annotated[
    list[str] | None,
    Field(
        alias="source_languages",
        validation_alias=AliasChoices(
            "source_languages", "sourceLanguages"
        ),
        description="Languages detected in the source content.",
        default=None,
    ),
] = None

Languages detected in the source content.

TranslatePdfTextResponse

Bases: BaseModel

Response returned by the translated-pdf-text tool.

input_id instance-attribute

input_id: Annotated[
    PdfRestFileID,
    Field(
        validation_alias=AliasChoices(
            "input_id", "inputId"
        ),
        description="The id of the input file.",
    ),
]

The id of the input file.

output_language class-attribute instance-attribute

output_language: Annotated[
    str | None,
    Field(
        alias="output_language",
        validation_alias=AliasChoices(
            "output_language", "outputLanguage"
        ),
        description="Target language used for the translation.",
        default=None,
    ),
] = None

Target language used for the translation.

source_languages class-attribute instance-attribute

source_languages: Annotated[
    list[str] | None,
    Field(
        alias="source_languages",
        validation_alias=AliasChoices(
            "source_languages", "sourceLanguages"
        ),
        description="Languages detected in the source content.",
        default=None,
    ),
] = None

Languages detected in the source content.

translated_text class-attribute instance-attribute

translated_text: Annotated[
    str | None,
    Field(
        alias="translated_text",
        validation_alias=AliasChoices(
            "translated_text", "translatedText"
        ),
        description="Inline translation content when output_type is json.",
        default=None,
    ),
] = None

Inline translation content when output_type is json.

UpResponse

Bases: BaseModel

Response payload returned by the /up health endpoint.

product instance-attribute

product: str

Product identifier reported by the service.

release_date class-attribute instance-attribute

release_date: date = Field(alias='releaseDate')

Release date for the deployed pdfRest version.

status instance-attribute

status: str

Service health status string returned by pdfRest.

version instance-attribute

version: str

Semantic version identifier for the running service.