# Cruss

> Free API workspace for engineering teams. A Postman alternative with no per-seat pricing, no paywalls on collaboration, and no member limits.

## What Cruss is

Cruss is a hosted API testing and documentation platform. Teams use it to send REST and GraphQL requests, organise collections, run collection suites, chain requests, and publish API documentation — all for free with no member limits.

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

## Core features

- REST & GraphQL request builder (all HTTP methods, JSON/form/raw/GraphQL body types)
- Team collections with real-time sync and role-based access (admin / editor / viewer)
- Collection Runner — run all requests 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
- Response history — last 20 responses per request
- 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)
- API Network — publish collections as public API docs at cruss.io/network
- Organisations — group workspaces with flat-rate Pro billing at $15/month

## Endpoints (Worker API at 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 in a workspace
GET  /requests/collection/:id             — list all requests in a collection
POST /requests/collection/:id             — create a request in a collection
POST /proxy                               — proxy an HTTP request through Cruss
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 API doc page
GET  /organizations                       — list orgs for authenticated user

## Pricing

- Workspaces: free forever, unlimited members, unlimited workspaces
- Organisations Pro: $15/month flat (not per seat), unlimited Pro workspaces
- Free tier limits: up to 3 workspaces per org, 10 AI doc generations/day

## Tech stack

Frontend: Next.js 14 (Pages Router), deployed on Vercel
Backend:  Single Cloudflare Worker (TypeScript)
Database: Supabase (PostgreSQL 15, Realtime, Auth)
Storage:  Cloudflare R2
AI:       Gemini 2.0 Flash (API doc generation)
Payments: Stripe

## VS Code extension

Publisher: HyacinthOkeke
Extension ID: Cruss-code.cruss
License: MIT
Repository: https://github.com/Cruss-API
Marketplace: https://marketplace.visualstudio.com/items?itemName=Cruss-code.cruss