Skip to main content

CloudPDF Python SDK

fern shield pypi

The official Python SDK for the CloudPDF API.

Table of Contents

Installation

pip install cloudpdf

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from cloudpdf import CloudPDFClient
from cloudpdf.doc import DocChangesRequestChangesItem

client = CloudPDFClient(
    token="<token>",
)

client.doc.changes(
    doc_id="docId",
    layer_name="layerName",
    changes=[
        DocChangesRequestChangesItem(
            op_id="opId",
        )
    ],
)

Environments

This SDK allows you to configure different environments for API requests.

from cloudpdf import CloudPDFClient
from cloudpdf.environment import CloudPDFEnvironment

client = CloudPDFClient(
    environment=CloudPDFEnvironment.SAAS,
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).

import asyncio
from cloudpdf.doc import DocChangesRequestChangesItem

from cloudpdf import AsyncCloudPDFClient

client = AsyncCloudPDFClient(
    token="<token>",
)


async def main() -> None:
    await client.doc.changes(
        doc_id="docId",
        layer_name="layerName",
        changes=[
            DocChangesRequestChangesItem(
                op_id="opId",
            )
        ],
    )


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from cloudpdf.core.api_error import ApiError

try:
    client.doc.changes(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from cloudpdf import CloudPDFClient

client = CloudPDFClient(...)
response = client.doc.with_raw_response.changes(...)
print(response.headers)  # access the response headers
print(response.status_code)  # access the response status code
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 5XX (All server errors, including 500)

recommended: retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 502 (Bad Gateway)
  • 503 (Service Unavailable)
  • 504 (Gateway Timeout)

Use the max_retries request option to configure this behavior.

client.doc.changes(..., request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from cloudpdf import CloudPDFClient

client = CloudPDFClient(..., timeout=20.0)

# Override timeout for a specific method
client.doc.changes(..., request_options={
    "timeout": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from cloudpdf import CloudPDFClient

client = CloudPDFClient(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Metadata

Release files for cloudpdf 3.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cloudpdf 3.2.0
File Size Uploaded Provenance Actions
cloudpdf-3.2.0.tar.gz 282.0 kB With provenance Details for cloudpdf-3.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cloudpdf 3.2.0
File Interpreter ABI Platform Actions
cloudpdf-3.2.0-py3-none-any.whl Python 3 none any Details for cloudpdf-3.2.0-py3-none-any.whl

Total release size: 1.3 MB

Release files / cloudpdf-3.2.0.tar.gz

Download URL cloudpdf-3.2.0.tar.gz
Size 282.0 kB
Tags Source
SHA-256 checksum
How to use checksums
cda7c292d7a388b4dabf1a9fb37e4c23e26e8d7a77712d99e5a2afacfd26c008
BLAKE2b-256 checksum
How to use checksums
c33bc96e0831a9016fc9779fed1d6a631587b43ffbed6dd27fbce140ad13e62b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Release files / cloudpdf-3.2.0-py3-none-any.whl

Download URL cloudpdf-3.2.0-py3-none-any.whl
Size 1.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
299a5e07f39ee08ca98f364e8473eaa93fe43fc4f4460a672955b6f1c28b7282
BLAKE2b-256 checksum
How to use checksums
1a28d654afc0c25d1fbe6cef67fb5cc1e277e6e7546a3b6e2c3d329c58a6ebd7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Security for cloudpdf 3.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for cloudpdf-3.2.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.2.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page