Skip to main content

chitmark (Python)

Official Python SDK for Chitmark: trust decisions on agent-mediated actions, tuned by business outcomes.

AI agents and multi-account farms drain free tiers, trial credits, and API allowances while looking exactly like your best customers. Chitmark scores each action in under 50 ms and returns allow, challenge, or deny. Then your outcomes (conversion, credit burn, chargeback) come back through feedback and tune the next decision.

PyPI version

Requires Python >= 3.10. Fully typed (py.typed), synchronous httpx under the hood.

Try it without a key: run the playground. Live service health: chitmark.com/status.

Install

pip install chitmark
# or
uv add chitmark

Quick start

from chitmark import Chitmark

with Chitmark(api_key="ck_live_...") as client:
    verdict = client.verify(
        action="signup",
        session="sess_9f3a",
        surface="app.acme.com/signup",
        subject={
            "email": "buyer@acmecorp.com",  # hashed client-side before the wire
            "ip": "203.0.113.7",  # truncated to /24 client-side
            "userAgent": "Mozilla/5.0 ...",
        },
    )

# Persist verdict["eventId"] on the account row: feedback joins only on that id.

The three verbs

Method Endpoint Purpose
client.verify(...) POST /v1/verify Decide
client.feedback(...) POST /v1/feedback Learn
client.challenge(...) POST /v1/challenge Escalate

Store-outage degradation on verify is HTTP 200 with a Verdict (degraded: True); the client deserializes it like any other Verdict. Verify never returns HTTP 503. Timeouts and transport errors synthesize a local degraded challenge Verdict and never raise on verify. HTTP 4xx / 429 Error responses raise ChitmarkApiError. Set on_degraded to challenge, never allow on degraded.

Use is_eligible_allow(verdict) before any protected action: only an explicit non-degraded allow is eligible. Unknown or malformed decisions fail closed.

Report outcomes

Store the eventId from verify on the account row, then report outcomes against that same id. Never guess or derive the id.

# At signup: persist the join key
verdict = client.verify(action="signup", subject={"email": "a@b.com"})
db.accounts.update(user_id, chitmark_event_id=verdict["eventId"])

# Later, when a label matures:
client.feedback(
    event_id=account.chitmark_event_id,  # the stored join key
    outcome="credit_burn",
    value=87.4,  # measured magnitude: unit rides along (default "usd"; also "credits" | "count")
    observed_at="2026-08-06T04:00:00Z",
)

Exact duplicate feedback bodies derive the same warehouse id (eventId + outcome + value + unit + observedAt), so retrying a connector with a stable business timestamp never double-counts a burned value. Prefer an idempotency key; omitting observedAt uses server time. unit ships only alongside value.

Handle a challenge

When verify returns challenge, issue one, solve the proof locally, and complete it. Proof-of-work difficulty is server-issued (4 by default, up to 6 at higher risk tiers): about 65k hashes, milliseconds for one real user, costly at farm scale.

import hashlib

issued = client.challenge(event_id=verdict["eventId"], session="sess_9f3a")
instructions = issued["instructions"]

if instructions["type"] == "pow":
    prefix = "0" * instructions["difficulty"]
    nonce = 0
    while True:
        digest = hashlib.sha256(
            f"{issued['challengeId']}:{instructions['seed']}:{nonce}".encode()
        ).hexdigest()
        if digest.startswith(prefix):
            break
        nonce += 1

    client.complete_challenge(
        event_id=verdict["eventId"],
        challenge_id=issued["challengeId"],
        session="sess_9f3a",
        proof={"type": "proof_of_work", "nonce": str(nonce)},
    )
    # Re-verify with context={"challengeId": ...}; completion alone does not authorize.

Verify the receipt

Every production verdict ships a verdictToken: an ES256 JWT bound to session, origin, and event. Verify authenticity, then authorize on the decision (install the verdict extra for the crypto dependency):

pip install "chitmark[verdict]"
from chitmark.verify_token import verify_verdict_token

claims = verify_verdict_token(
    verdict["verdictToken"],
    session="sess_9f3a",
    tenant_id="org_acme",
)

if claims["degraded"] or claims["decision"] != "allow":
    raise ChallengeRequiredError()  # HTTP 428 / challenge response

# Only now trust the allow.

Rejects expired tokens, unknown keys, bad signatures, and session or origin mismatches with typed error codes. A verified token that is not a non-degraded allow must still fail closed.

Cache JWKS using HTTP headers: respect Cache-Control (max-age=60), and when ETag or Last-Modified are present use conditional requests (If-None-Match / If-Modified-Since) instead of a hard-coded refresh interval. Refresh immediately on unknown kid. Do not fetch on every verification. Every signed JWT requires kid. Keys are EC P-256 for ES256: require JWT alg === "ES256" before verifying (wrong_algorithm otherwise); never trust the token-requested alg. Rotation overlaps old and new keys; the old key stays until tokens under it expire (keep ≥ 5 minutes + 60 seconds). An empty JWKS (keys: []) means verification is impossible: fail closed; never treat an empty set as proof a token is valid (local/CI may also emit unsigned.<eventId>). Pass a cached jwks= mapping into verify_verdict_token to skip the network call.

PII modes

Mode Behavior
hashed (default) SHA-256 email, /24 IP truncation, allowlisted form fields
none Derived/header-shape signals only
raw Tenant opt-in only; higher compliance review

Dependency injection and lifecycle

The client owns its httpx.Client by default and closes it on context exit. Pass your own for connection pooling or tests:

import httpx
from chitmark import Chitmark

pool = httpx.Client(base_url="https://api.chitmark.com", timeout=0.8)
client = Chitmark(api_key="ck_live_...", http_client=pool)

Develop

cd packages/sdk-python
uv sync --extra dev   # or: pip install -e ".[dev]"
pytest
ruff check .

Agent integration

Using Cursor, Claude Code, Codex, or another coding agent? Point it at chitmark.com/SKILL.md, or paste this into your prompt: Integrate Chitmark into my app following https://chitmark.com/SKILL.md.

Resources

License

Proprietary: see LICENSE.

Metadata

Release files for chitmark 0.6.3

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

Source distribution (sdist)

Source distribution for chitmark 0.6.3
File Size Uploaded
chitmark-0.6.3.tar.gz 23.4 kB Details

Built distribution (wheel)

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

Total release size: 42.5 kB

Release files / chitmark-0.6.3.tar.gz

Download URL chitmark-0.6.3.tar.gz
Size 23.4 kB
Tags Source
SHA-256 checksum
How to use checksums
98e4ba25cbce5536ec878db44147e818e76a2cd7285ac097da5ff28e24d173c7
BLAKE2b-256 checksum
How to use checksums
7ab7b7328c00e7944e284b1a2fce90c4e218710145324df68ae974086ba5fa7c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / chitmark-0.6.3-py3-none-any.whl

Download URL chitmark-0.6.3-py3-none-any.whl
Size 19.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7404592da4aef0121250b8a8c68b8a866600f1e33693b60423cd6712e36f309c
BLAKE2b-256 checksum
How to use checksums
c0b44511bccf8051fcdfefa9d352a075ac5dda305c592eb773d5ffb3d7efd697
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.11 {"installer":{"name":"uv","version":"0.10.11","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

0.6.3 This release

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.1

2 release 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