Skip to main content

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".

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.8.0.tar.gz (18.6 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.8.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: thresh_sdk-0.8.0.tar.gz
  • Upload date:
  • Size: 18.6 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.8.0.tar.gz
Algorithm Hash digest
SHA256 f0c9c30d6cac75e08f56026b6d11d8a4a70f754b86a62ec79e0dbbeb13a83d9c
MD5 899711388db87f2b8546f286ac89876c
BLAKE2b-256 7417b9f89194ea9d8400592170f726ba7fa5760797b4a75e89a106cbae30d1f0

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: thresh_sdk-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 5.5 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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 00fe578563f2d22831fd89dab4c6145ffc57bad9681e7e209c53c56e78244c8c
MD5 194753ba536d6dc30748f3e084767aa5
BLAKE2b-256 2974199899a1ce4087d8b04369a29a7777de390ffe521786947cf0845de717df

See more details on using hashes here.

Provenance

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

Release history Release notifications | RSS feed

0.9.1

2 files

0.9.0

2 files

This release

0.8.0 This release

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

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