Skip to main content

Official Python client for the Kreuzberg Cloud document-processing API.

Project description

kreuzberg-cloud-sdk

Kreuzberg Cloud

PyPI npm Go Reference License Documentation CI

Discord

Official Python client for the Kreuzberg Cloud document-processing API.

  • httpx-based, sync (KreuzbergCloud) and async (AsyncKreuzbergCloud) surfaces
  • Generated from the upstream OpenAPI 3.1 spec, then wrapped in ergonomic helpers
  • Type-annotated end to end, py.typed shipped
  • Zero-friction onboarding via from_sandbox() — no signup needed for evaluation

Install

pip install kreuzberg-cloud-sdk
# or
uv add kreuzberg-cloud-sdk

Requires Python 3.10+.

Quickstart

Sync — single file with explicit API key

from pathlib import Path
from kreuzberg_cloud import KreuzbergCloud

with KreuzbergCloud(api_key="sk_live_...") as client:
    job = client.extract_and_wait(file=Path("invoice.pdf"))
    if job.result is not None:
        print(job.result.content)

Async — batch extract with parallel waits

import asyncio
from pathlib import Path
from kreuzberg_cloud import AsyncKreuzbergCloud

async def main() -> None:
    async with AsyncKreuzbergCloud(api_key="sk_live_...") as client:
        jobs = await client.extract_batch([Path("a.pdf"), Path("b.pdf"), Path("c.pdf")])
        results = await client.wait_for_jobs([str(j.id) for j in jobs])
        for job in results:
            print(job.filename, job.status)

asyncio.run(main())

Async — sandbox onboarding (no API key required)

import asyncio
from kreuzberg_cloud import AsyncKreuzbergCloud

async def main() -> None:
    async with await AsyncKreuzbergCloud.from_sandbox() as client:
        job = await client.extract_and_wait(file=b"hello world")
        print(job.status, job.result and job.result.content)

asyncio.run(main())

Public API

The following methods are available on both KreuzbergCloud (sync) and AsyncKreuzbergCloud (async):

Method Purpose
extract(file=..., options=...) Submit one document, get back a Job.
extract_batch(files, options=...) Submit many documents (parallel for async).
get_job(job_id) Fetch current job status / result.
wait_for_job(job_id, timeout=300, ...) Poll until terminal status.
wait_for_jobs(job_ids, ...) Wait for multiple jobs.
extract_and_wait(file=..., ...) Submit + wait in one call.
create_sandbox_key() Mint an ephemeral sandbox API key.
from_sandbox() (classmethod) Build a client preconfigured with a sandbox key.

Errors are raised as one of: KreuzbergCloudError (base), AuthError, ValidationError, NotFoundError, RateLimitError (carries retry_after), ServerError, TimeoutError.

Documentation

Full reference and guides: https://docs.kreuzberg.cloud

License

MIT — © Kreuzberg, Inc.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kreuzberg_cloud_sdk-0.1.0.tar.gz (41.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kreuzberg_cloud_sdk-0.1.0-py3-none-any.whl (89.9 kB view details)

Uploaded Python 3

File details

Details for the file kreuzberg_cloud_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: kreuzberg_cloud_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 41.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kreuzberg_cloud_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 79036ff7456f3c578dc4c2bae49a1aa8d60c9f71b592ce813268496c23b71f9a
MD5 6438d5becd35f6ebada2fdcf0b29c4ad
BLAKE2b-256 dec7f1c5faf13abefa82b3b9121e006bfee9e0af08a8067b98975f1111909e1b

See more details on using hashes here.

Provenance

The following attestation bundles were made for kreuzberg_cloud_sdk-0.1.0.tar.gz:

Publisher: publish.yaml on kreuzberg-dev/kreuzberg-cloud-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kreuzberg_cloud_sdk-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for kreuzberg_cloud_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 78ed5697648afb3133830e0a2732a6fb08714d9309f2e94a16c542fbb34fac23
MD5 89838591b3e155433cde05aeb0575156
BLAKE2b-256 ffa19cdca60727dfeeb9f5855dc69b3a66d8ff04de91f279f91adb39dfe8cffd

See more details on using hashes here.

Provenance

The following attestation bundles were made for kreuzberg_cloud_sdk-0.1.0-py3-none-any.whl:

Publisher: publish.yaml on kreuzberg-dev/kreuzberg-cloud-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page