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.6.0.tar.gz (18.1 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.6.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: thresh_sdk-0.6.0.tar.gz
  • Upload date:
  • Size: 18.1 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.6.0.tar.gz
Algorithm Hash digest
SHA256 81fb16a9327f52fa9e6c5aa404e49b0041e079f0206831341f4e90eb58fce3a6
MD5 9058854825309ebd7f8b91baabde0f2d
BLAKE2b-256 9ee850a1fd588520e16bd38be66164e9361f5c6b09bc8cafd60c410222430eba

See more details on using hashes here.

Provenance

The following attestation bundles were made for thresh_sdk-0.6.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.6.0-py3-none-any.whl.

File metadata

  • Download URL: thresh_sdk-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 5.0 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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0b797aabb23f9677824b8b2c791406ff1b98f279e4dabbeb96e99288f545ebdf
MD5 1056be07d519fa19b9217f43156ea927
BLAKE2b-256 487eff6e1e05cfa05a4d9b5d809f02d0ad908d9ccd98bc1acf1e7c80ecc915cd

See more details on using hashes here.

Provenance

The following attestation bundles were made for thresh_sdk-0.6.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