Skip to main content
The API docs page at /docs/api documents every tRPC procedure in the app, grouped by router. It serves as both the API reference and an interactive testing environment.

​
API overview

The overview table lists every tRPC procedure in the app, grouped by router. By default it shows only your custom procedures — you can toggle to show all procedures including system procedures.
API docs overview showing procedures grouped by router

API overview with procedure types, descriptions, and scope requirements

​
Procedure detail

Clicking a procedure scrolls to its detail view, which shows:
  • Procedure name and type — query or mutation, with corresponding badges
  • Description — from .meta({ description }) on each procedure
  • Required scopes — the scopes needed to call the procedure, with badges
  • Input schema — all input parameters with field names, types (string, number, enum, etc.), required/optional status, and descriptions — flattened from Zod validation schemas
  • Output schema — the response shape with the same field-level detail
Procedure detail view with schemas and interactive console

Procedure detail with input/output schemas and interactive console

​
Interactive API Console

Console requests are live — they execute as your logged-in user and can read and write real data.
Each procedure includes a built-in console where you can construct input payloads and execute API calls directly from the docs page. The console uses the authenticated user’s session, so results reflect the caller’s actual permissions and data access.
Interactive console for testing API procedures

Interactive API console with input form, live request execution, and response viewer

​
Generated from

This page is populated from procedures.json, which the build pipeline generates by analyzing the tRPC router definitions. Descriptions come from .meta({ description }), and input/output schemas are extracted from Zod validators.