Documentation Index
Fetch the complete documentation index at: https://mintlify.com/paramveer-cyber/Deployaar/llms.txt
Use this file to discover all available pages before exploring further.
Deployaar’s API server is built on Express 5 and exposes two complementary interfaces from a single set of procedure definitions: a REST API generated automatically from tRPC via trpc-to-openapi, and a tRPC batch endpoint used by the web application. Both interfaces share identical underlying logic, authorization checks, and Zod-validated inputs — the only difference is how you talk to them.
Base URLs
| Environment | URL |
|---|
| Production API | https://deployaar.onrender.com |
| Local development | http://localhost:8000 |
| Interactive docs (Scalar) | {base_url}/docs |
| OpenAPI JSON | {base_url}/openapi.json |
Available Endpoints
The table below covers every route mounted in the Express server, including both infrastructure routes and the dynamically generated API surface.
| Method | Path | Description |
|---|
GET | / | Status check. Returns {"message": "API is up and running..."} |
GET | /health | Health check. Returns {"message": "API is healthy", "healthy": true} |
ALL | /api/auth/* | better-auth: sign-in, sign-up, OAuth callbacks, session management, sign-out |
POST | /api/github/webhook | GitHub App webhook receiver. Requests are verified with HMAC-SHA256 using x-hub-signature-256 |
POST | /api/razorpay/webhook | Razorpay payment webhook receiver. Verified via x-razorpay-signature header |
ALL | /api/inngest | Inngest function serve endpoint for step-checkpointed background workflows |
GET | /openapi.json | Generated OpenAPI 3 document describing all tRPC procedures as REST operations |
GET | /docs | Scalar interactive API reference UI (try-it-out enabled) |
ALL | /api/* | REST mirror of all tRPC procedures via trpc-to-openapi |
ALL | /trpc/* | tRPC batch endpoint used by the apps/web Next.js application |
REST vs tRPC
Deployaar exposes the same business logic through two distinct transport layers. Choose the one that fits your use case:
-
/api/* — OpenAPI REST interface. Generated from tRPC procedure definitions by trpc-to-openapi. Usable from any standard HTTP client including curl, Postman, Insomnia, or any language’s HTTP library. This is the recommended interface for external integrations and scripting.
-
/trpc/* — tRPC batch endpoint. Optimized for use with @trpc/client inside the web application. Supports request batching and end-to-end type safety when consumed from TypeScript. The apps/web Next.js app uses this exclusively.
Both endpoints resolve through the exact same serverRouter procedures, run the same Zod input validation, and enforce the same authorization checks — there is no difference in behavior or data returned.
Interactive API Reference
Deployaar serves the Scalar API Reference UI at /docs, auto-generated from the live /openapi.json document. Scalar supports full try-it-out functionality, letting you authenticate and execute real API calls directly from the browser without writing any code.
The fastest way to explore all available endpoints is through the Scalar interface at https://deployaar.onrender.com/docs. Every tRPC procedure that is exposed over REST appears there with its full request/response schema. tRPC Routers
The serverRouter is assembled in packages/trpc/server/index.ts by composing the following top-level routers. Each router maps to a dedicated route folder containing a models.ts (Zod schemas) and a route.ts (procedure definitions).
| Router key | Description |
|---|
health | API liveness check |
github | GitHub App installation status and repository listing |
organization | Organization CRUD and membership management |
invitation | Organization invite creation and acceptance |
cron | Internal cron-triggered procedures (not for external use) |
project | Project CRUD and GitHub repository linking |
featureRequest | Feature request CRUD and full lifecycle management |
prd | PRD generation from an accepted feature request and fetching |
featureTask | Task listing and status updates spawned from a PRD |
pullRequestReview | Review trigger (shallow / standard / deep), results, and issue management |
agentRun | Coding agent trigger and real-time status observation |
billing | Plan information, usage tracking, and checkout |
userSettings | Per-user preferences and configuration |