# Cruss

> The collaborative API development workspace for engineering teams. Build, test, document and share APIs together — free, unlimited teammates, no paywalls.

## What Cruss is

Cruss is a collaborative API development workspace. Engineering teams use it to design, test, document and share APIs from a single shared environment — keeping everyone aligned from local development through production.

Modern API workflows are often fragmented across separate tools for testing, documentation, collaboration and knowledge sharing. Cruss brings those workflows into one workspace designed specifically for teams.

The VS Code extension (Cruss HQ.cruss) is open source under the MIT License. The Cruss platform — web app, API, and database — is proprietary software provided free of charge.

## Core capabilities

- Collaborative API workspaces — real-time sync, shared collections, team activity feed
- REST & GraphQL request builder (all HTTP methods, JSON/form/raw/GraphQL body types)
- Team collections with role-based access (admin / editor / viewer)
- Collection Runner — run all requests sequentially with iterations, delays, and assertion results
- Request chaining — extract values from responses and inject into subsequent requests
- Environment variables — {{variableName}} syntax, switch between Dev / Staging / Production
- AI API documentation — generate a public API reference page from any collection (Gemini 2.0 Flash)
- Response history — last 100 responses per user
- Assertions & tests — status code, response time, JSON field, header checks
- cURL & OpenAPI import, Postman Collection v2.1 import/export
- Local API testing — VS Code extension (Node.js, no CORS) or npx cruss-agent (localhost proxy on port 9119)
- Public API Network — orgs publish collections as discoverable API docs at cruss.io/network
- Organisations — group workspaces under one billing entity, flat-rate Pro at $15/month

## Worker API endpoints (api.cruss.io)

All authenticated endpoints require: Authorization: Bearer <supabase_jwt>

GET  /workspaces                          — list workspaces for authenticated user
GET  /collections/workspace/:id           — list all collections + requests in a workspace
POST /collections/workspace/:id           — create a collection
POST /requests/collection/:id             — create a request in a collection
PATCH /requests/:id                       — update a request
POST /proxy                               — proxy an HTTP request (bypasses CORS)
GET  /environments/workspace/:id          — list environments for a workspace
GET  /docs/public                         — list all published API doc pages
GET  /docs/:slug                          — get a single published doc page (no auth required)
GET  /organizations                       — list orgs for authenticated user
GET  /network                             — public API Network directory
GET  /network/:slug                       — public org API profile

## Pricing

- Workspaces: free forever, unlimited members, unlimited workspaces per user
- Organisations Pro: $15/month flat (not per seat) — unlimited workspaces, audit logs, branding
- Free org limit: up to 3 workspaces per org, 10 AI doc generations/day per user

## Tech stack

Frontend: Next.js 14 (Pages Router), deployed on Vercel
Backend:  Single Cloudflare Worker (TypeScript, Wrangler 4)
Database: Supabase (PostgreSQL 15, Realtime, Auth)
Storage:  Cloudflare R2 (org logos, avatars)
AI:       Gemini 2.0 Flash (API doc generation)
Payments: Stripe (flat-rate org billing)
Email:    Resend

## VS Code extension

Publisher: HyacinthOkeke
Extension ID: Cruss HQ.cruss
License: MIT
Repository: https://github.com/Cruss-API
Marketplace: https://marketplace.visualstudio.com/items?itemName=CrussHQ.crusshq
No account required for local mode — requests stored in VS Code globalState.

## Links

Web app:    https://cruss.io
Worker API: https://api.cruss.io
Docs:       https://cruss.io/help
Network:    https://cruss.io/network
GitHub:     https://github.com/Cruss-API