Get started with OrbitKit

Make your first request to the mock SaaS API and explore the multi-service architecture.

Recommended: Skip the docs and open the Dashboard directly to see live data.

Quickstart

Get productive in a few minutes by following these three steps.

Install the SDK

Install the OrbitKit Python SDK with pip, or use cURL to call the API endpoints directly.

Create your configuration

Set up your vercel.json with subdomain mappings for each service: web, docs, dashboard, and API.

Make your first request

Call the overview endpoint to verify your API service is responding with mock operational data.

python
import orbitkit

client = orbitkit.Client(api_key="your-api-key")
overview = client.overview.get()

print(overview.mrr)          # 128400
print(overview.active_workspaces)  # 372

Service architecture

Each surface is isolated by purpose and deployed as a separate Vercel service behind its own subdomain.

Service	Stack	Description
web	Next.js	Marketing and product storytelling for the root domain.
docs	Next.js	Technical onboarding, API reference, and service overview.
dashboard	Vite + React	Operational UI for metrics, pipeline, and customer health.
api	FastAPI	Mock SaaS endpoints consumed by the dashboard and docs.

API reference

The FastAPI backend exposes mock operational data consumed by the dashboard and used in documentation examples.

GET/health

Service health and version info.

GET/v1/overview

Top-level metrics: MRR, workspaces, automation runs, trial conversion.

GET/v1/pipeline

Funnel stage counts with weekly deltas.

GET/v1/activity

Recent product events shown in the dashboard feed.

GET/v1/customers

Customer list with plan, health, ARR, and expansion opportunity.

Examples

Fetch the overview endpoint and inspect the response shape.

Request

bash
curl https://api.mycooltestingdomain.com/v1/overview

Response

json
{
  "mrr": 128400,
  "active_workspaces": 372,
  "automation_runs": 1842031,
  "sla_percentage": 99.96,
  "growth_percentage": 18.7,
  "trial_conversion_rate": 43.2
}