Skip to main content

Official Python client for the Thresh document extraction API

Project description

thresh-sdk

Official Python client for the Thresh document extraction API — documents in, schema-conformant JSON out.

from thresh import Thresh

client = Thresh(api_key="th_live_...")
doc = client.upload(
    "contract.pdf",
    fields=["purchase_price", "closing_date", "buyer_name"],
    tables=[{"name": "monthly_charges", "columns": ["item", "qty", "mrc"]}],
    questions=["Is the contract contingent upon financing?"],
)
result = client.wait(doc.id)

result.fields["purchase_price"]        # "399900"
result.tables["monthly_charges"]       # [{"item": ..., "qty": ..., "mrc": ...}, ...]
result.answer("Is the contract contingent upon financing?")  # "Yes"
  • upload(...) accepts a path or a binary file object; pass idempotency_key= to make retries safe.
  • No schema? client.upload("contract.pdf") runs auto-extraction: the engine discovers and names the fields and tables itself. Refine what it found, then client.create_template("sale-contract", fields=[...]) and reuse it with client.upload("next.pdf", template="sale-contract").
  • wait(id, timeout=300) polls until completed or failed (failed results return with .error set — no exception).
  • verify_webhook_signature(secret, header, body) validates Thresh-Signature headers on webhook deliveries.
  • Errors raise ThreshError with .status, .error_type, and .request_id.

Missing values come back as the string "null"; checkbox states as "true"/"false".

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

thresh_sdk-0.7.0.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

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

thresh_sdk-0.7.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file thresh_sdk-0.7.0.tar.gz.

File metadata

  • Download URL: thresh_sdk-0.7.0.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for thresh_sdk-0.7.0.tar.gz
Algorithm Hash digest
SHA256 3df6b48286c9ff3d8437085c4f36e8ee03eeed8dec2381c1232a4f04d7430470
MD5 434c6e2138e5f4ee8fa39a9e01b4bf65
BLAKE2b-256 a6044958002f88612be1f39cda2f2885f6058c189833cb512ba2b66117500b48

See more details on using hashes here.

Provenance

The following attestation bundles were made for thresh_sdk-0.7.0.tar.gz:

Publisher: publish-sdk.yml on Fillnull/thresh

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

File details

Details for the file thresh_sdk-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: thresh_sdk-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for thresh_sdk-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ad9462dd6b91bd23278038ded914817496acb98c1239b657b74b70135292c5b
MD5 9346155d4cc699ea9ddfce583efe864b
BLAKE2b-256 e137c42113695ec604857020339b5880282168a59084e9b1c90ded019da839ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for thresh_sdk-0.7.0-py3-none-any.whl:

Publisher: publish-sdk.yml on Fillnull/thresh

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