Skip to main content
[AVAILABLE] — every route below is mounted in packages/api/src/app.ts. No other routes exist.

Base URL

Local: http://localhost:3000 (see Quickstart for starting the server).

Errors

Non-2xx responses are { "error": string }, sometimes with a code field, per packages/api/src/middleware/error-handler.ts:
StatusWhen
400BusinessTransactionValidationError, PolicyValidationError, SignalValidationError
404PolicyNotFoundError
409DuplicateBusinessTransactionError
(varies)Any other RuntimeError — status/code from the error itself
500Unexpected failure (logged via console.error, not a structured logger — see Roadmap)
The Python SDK raises a specific exception per status code (ValidationError/NotFoundError/ConflictError/ServerError/etc.) — see Python SDK. The TypeScript SDK does not — see TypeScript SDK.

Auth

No authentication or authorization middleware exists on this API today. Every route above is unauthenticated in the current implementation.
See Endpoints for the full route reference.