API Overview
The implemented Arn API surface.
API Reference
The current API is an oRPC service mounted at /rpc. It exposes health checks, OpenAPI documentation, and authenticated user/session helpers.
Relationship, customer, vendor, connector, sync-rule, workstream, file, decision, and task resources are not implemented yet.
Local API paths#
| Path | Purpose |
|---|---|
/rpc/docs | Interactive OpenAPI reference generated from the oRPC contract |
/rpc/openapi.json | OpenAPI 3.1 document generated from the current router |
/rpc/status/health | API health check |
/rpc/status/database | Database health check |
/rpc/status/hello?name=Arn | Greeting endpoint used to verify query input |
/rpc/user/session | Current authenticated session |
/rpc/user/me | Current authenticated user and session |
/rpc/user/privatePing | Authenticated RPC access check |
/rpc/user/account | Account overview composed from session and private ping data |
Authentication#
User endpoints require the Better Auth session cookie. The web app creates that session through the signup, login, email verification, passkey, and provider-auth flows.
The OpenAPI document declares cookie auth with the better-auth.session_token cookie. Do not document bearer-token API keys until an API-key system exists.
Contract boundary#
The API contract lives in apps/api/src/routes/rpc.ts. Public API docs should be generated from, or checked against, that contract before being expanded.