Research artifact — not legal advice, not court-endorsed. Source judgments remain the property of the issuing court. See data/tos_audit.md and LICENSE.

← back to dashboard · playground · simulator · cross-border

API reference

The API is local-dev-shaped: stdlib-only Python http.server, Postgres-backed, no auth (loopback only). Eighteen endpoints across six tags (corpus / rules / rule-runs / routing / authoring / ingestion). Every POST /api/rule_run writes a row to the audit log; module/scope/filename inputs are alphabet-restricted; /api/rule_save is gated by HABEAS_ADMIN_MODE=1.

spec: api/openapi.yaml · base url: http://127.0.0.1:5544

How to read this page

Everything on the dashboard is reachable through this API

The Habeas Protocol API is the bridge between the static dashboard and the running rule library. The spec below is rendered with Redoc; every endpoint shows its inputs, outputs, and an example response.

Three quick paths

Browse the corpus — start with GET /api/corpus/coverage for headline counts; then GET /api/search?q=<term> to search judgments.
Run a rule — GET /api/rule_modules lists all 12 rules; POST /api/rule_run executes one with a JSON body of inputs and returns the disposition + trace.
Route a cross-border dispute — POST /api/conflict_route with the four routing inputs returns the rule chain.

Clients

First-party clients live under clients/: a stdlib-only Python client (pip install -e clients/python) and a zero-build TypeScript client that runs in browsers and Node directly. Both wrap every endpoint below.

If the spec doesn't render

Redoc loads from a CDN. Offline / CSP-blocked? The fallback link to the raw YAML appears below. The spec is also viewable with npx @redocly/cli preview-docs api/openapi.yaml.

This page renders the API reference using Redoc, which requires JavaScript. The raw spec is at api/openapi.yaml.

Habeas Protocol v0.2 — research artifact. Code: MIT. Data: structured-metadata licence (see LICENSE). Outputs computed against rule modules pinned in rules/<module>_source.yaml; not a legal determination. Takedown: see SECURITY.md.