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, verified for each route on Endpoints:
StatusWhenVerified this session
400BusinessTransactionValidationError, PolicyValidationError, SignalValidationError, or a route’s own hand-written field checkField checks yes, on every route. BusinessTransactionValidationError specifically, no, see the warning below.
404PolicyNotFoundError, or a route’s own “not found” checkYes
409DuplicateBusinessTransactionErrorYes
(varies, seen: 500)Any other RuntimeError, status/code from the error itselfYes, RUNTIME_ERROR / VERIFICATION_FAILED
500Unexpected failure (logged via console.error, not a structured logger, see Roadmap)Yes, see the warning below
A structurally incomplete POST /execute or POST /transactions body does not reach the 400 BusinessTransactionValidationError path this table implies exists for it. It throws an unhandled TypeError from deep inside validation, caught only by the generic 500 case. Full detail and the exact server-side stack trace on Endpoints.
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.