Skip to content

API Clients

gotenberg_client.SyncGotenbergClient

A synchronous client for interacting with a Gotenberg instance.

This client provides methods to interact with various Gotenberg APIs, including:

Attributes

bookmarks: SyncBookmarksApi property

Returns a new instance for interacting with the Bookmarks routes for reading and writing PDF bookmarks

chromium: SyncChromiumApi property

Returns a new instance for interacting with Chromium routes for the conversion of URLs, HTML, Markdown into PDFs and the generation of screenshots from those types

embed: SyncEmbedApi property

Returns a new instance for interacting with the Embed attachments route

encrypt: SyncEncryptApi property

Returns a new instance for interacting with the Encrypt PDFs route

flatten: SyncFlattenApi property

Returns a new instance for interacting with Flatten PDFs route for flattening PDFs

health: SyncHealthCheckApi property

Returns a new instance for reading the Health route

libre_office: SyncLibreOfficeApi property

Returns a new instance for interacting with Libreoffice routes for the conversion of a variety of office documents into PDFs

merge: SyncMergePdfsApi property

Returns a new instance for interacting with Merge PDFs route for merging multiple PDFs into one

metadata: SyncPdfMetadataApi property

Returns a new instance for interacting with Read PDF Metadata and Write PDF Metadata routes for the manipulation or reading of metadata

pdf_convert: SyncPdfAApi property

Returns a new instance for interacting with PDF/A & PDF/UA routes for the conversion of PDFs to PDF/A and/or PDF/UA

rotate: SyncRotateApi property

Returns a new instance for interacting with the Rotate PDFs route

split: SyncSplitApi property

Returns a new instance for interacting with Split PDFs route for splitting PDFs

stamp: SyncStampApi property

Returns a new instance for interacting with the Stamp PDFs route

version: SyncVersionApi property

Returns a new instance for reading the Version route

watermark: SyncWatermarkApi property

Returns a new instance for interacting with the Watermark PDFs route

Methods:

add_error_webhook_url(url: str) -> None

Configure the webhook error URL value.

Parameters:

Name Type Description Default
url str

The URL to be used as the webhook endpoint.

 required

add_headers(header: dict[str, str]) -> None

Add custom headers to the request, such as authentication, etc

Parameters:

Name Type Description Default
header Dict[str, str]

A dictionary of header names and values to add.

 required

add_webhook_url(url: str) -> None

Configure the webhook URL value.

Parameters:

Name Type Description Default
url str

The URL to be used as the webhook endpoint.

 required

close() -> None

Close the underlying HTTP client connection.

set_error_webhook_http_method(method: Literal['POST', 'PATCH', 'PUT']) -> None

Set the HTTP method Gotenberg will use to call the error webhook url.

Args: method: The HTTP method to use.

set_webhook_extra_headers(extra_headers: dict[str, str]) -> None

Add custom headers to the webhook request, such as authentication, etc

Parameters:

Name Type Description Default
extra_headers Dict[str, str]

A dictionary of additional headers to include in webhook calls.

 required

set_webhook_http_method(method: Literal['POST', 'PATCH', 'PUT']) -> None

Set the HTTP method Gotenberg will use to call the webhook url.

Parameters:

Name Type Description Default
method Literal['POST', 'PATCH', 'PUT']

The HTTP method to use.

 required

gotenberg_client.AsyncGotenbergClient

An asynchronous client for interacting with a Gotenberg instance.

This client provides methods to interact with various Gotenberg APIs, including:

Attributes

bookmarks: AsyncBookmarksApi property

Returns a new instance for interacting with the Bookmarks routes for reading and writing PDF bookmarks

chromium: AsyncChromiumApi property

Returns a new instance for interacting with Chromium routes for the conversion of URLs, HTML, Markdown into PDFs and the generation of screenshots from those types

embed: AsyncEmbedApi property

Returns a new instance for interacting with the Embed attachments route

encrypt: AsyncEncryptApi property

Returns a new instance for interacting with the Encrypt PDFs route

flatten: AsyncFlattenApi property

Returns a new instance for interacting with Flatten PDFs route for flattening PDFs

health: AsyncHealthCheckApi property

Returns a new instance for reading the Health route

libre_office: AsyncLibreOfficeApi property

Returns a new instance for interacting with Libreoffice routes for the conversion of a variety of office documents into PDFs

merge: AsyncMergePdfsApi property

Returns a new instance for interacting with Merge PDFs route for merging multiple PDFs into one

metadata: AsyncPdfMetadataApi property

Returns a new instance for interacting with Read PDF Metadata and Write PDF Metadata routes for the manipulation or reading of metadata

pdf_convert: AsyncPdfAApi property

Returns a new instance for interacting with PDF/A & PDF/UA routes for the conversion of PDFs to PDF/A and/or PDF/UA

rotate: AsyncRotateApi property

Returns a new instance for interacting with the Rotate PDFs route

split: AsyncSplitApi property

Returns a new instance for interacting with Split PDFs route for splitting PDFs

stamp: AsyncStampApi property

Returns a new instance for interacting with the Stamp PDFs route

version: AsyncVersionApi property

Returns a new instance for reading the Version route

watermark: AsyncWatermarkApi property

Returns a new instance for interacting with the Watermark PDFs route

Methods:

add_error_webhook_url(url: str) -> None

Configure the webhook error URL value.

Parameters:

Name Type Description Default
url str

The URL to be used as the webhook endpoint.

 required

add_headers(header: dict[str, str]) -> None

Add custom headers to the request, such as authentication, etc

Parameters:

Name Type Description Default
header Dict[str, str]

A dictionary of header names and values to add.

 required

add_webhook_url(url: str) -> None

Configure the webhook URL value.

Parameters:

Name Type Description Default
url str

The URL to be used as the webhook endpoint.

 required

close() -> None async

Close the underlying asynchronous HTTP client connection.

set_error_webhook_http_method(method: Literal['POST', 'PATCH', 'PUT']) -> None

Set the HTTP method Gotenberg will use to call the error webhook url.

Args: method: The HTTP method to use.

set_webhook_extra_headers(extra_headers: dict[str, str]) -> None

Add custom headers to the webhook request, such as authentication, etc

Parameters:

Name Type Description Default
extra_headers Dict[str, str]

A dictionary of additional headers to include in webhook calls.

 required

set_webhook_http_method(method: Literal['POST', 'PATCH', 'PUT']) -> None

Set the HTTP method Gotenberg will use to call the webhook url.

Parameters:

Name Type Description Default
method Literal['POST', 'PATCH', 'PUT']

The HTTP method to use.

 required