Live App →
Developers

For Developers

Build against the Sentinel platform. API reference, authentication, SDKs, and contribution guides.

For Developers

For Developers

Build against the Sentinel platform. API reference, authentication, SDKs, and contribution guides for engineers extending the stack.

Quickstart

First API call in under 10 minutes

→

Authentication

Bearer JWT flow, refresh tokens, server actions

→

API reference

Every Studio BFF route — auth, dashboard, Nexus, Zen, agents

→

SDKs & clients

Available client libraries and patterns for direct HTTP

→

Webhooks

Event subscriptions for pipeline completion and chat events

→

Rate limits

Per-tenant quotas and burst behavior

→

Errors

Status codes, envelope shape, and recovery patterns

→

Frontend architecture

Next.js 16 App Router, Zustand, React Query

→

Design system

Typography, tokens, themes, Tailwind variants

→

Screen catalog

All routes, CTAs, and data dependencies

→

In ten minutes

# 1. Get a token from the Studio BFF
curl -X POST https://studio-backend-dev.centricitywealth.tech/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"<your-email>","password":"<your-password>"}'

# 2. Use the access_token in subsequent calls
curl https://studio-backend-dev.centricitywealth.tech/api/v1/dashboard \
  -H "Authorization: Bearer <access_token>"

That’s the whole loop. Every other backend (Nexus, Zen, Agentic, KB) is fronted by the same Studio gateway — you never call the capability backends directly. See Quickstart for the full version.

Architecture in one diagram

graph LR
  Client["Your client<br/>(browser, server, SDK)"] --> Studio["Studio BFF<br/>FastAPI · JWT · RBAC"]
  Studio --> Nexus[Nexus<br/>Document AI]
  Studio --> Zen[Zen<br/>RAG chat]
  Studio --> Agents[Agentic<br/>workflows]
  Studio --> KB[Knowledge base]
  Studio --> LLM[LLM orchestrator]
  Studio --> Integrations[Integrations]

Single entry point, central auth, normalised response envelope — the BFF pattern is described in detail in the Platform overview.

What’s in the API

Surface Purpose Routes
/api/v1/auth/* Login, register, refresh, logout, MFA 6
/api/v1/dashboard Aggregated platform metrics, tenant health 3
/api/v1/nexus/* Document upload, extraction, export 32
/api/v2/nexus/pipeline/* Pipeline lifecycle, progress polling, batch 8
/api/v1/zen/* Chat sessions, messages, RAG context uploads 14
/api/v1/agents/* Agent invocation, model catalog, tool registry 10
/api/v1/integrations/* Webhook management, connector config 6

Full schemas: API reference.

SDKs and Client Libraries

Sentinel provides first-party SDKs and reference implementations:

Language Package Status
TypeScript @centricitywealth/sentinel-client Beta — npm
Python sentinel-py Beta — PyPI
cURL / HTTP Raw examples in docs Stable

Both SDKs handle auth refresh, envelope unwrapping, and typed error classes automatically. See SDKs & clients for installation and usage.

Development Environment

# Clone the sentinel-frontend repo
git clone https://github.com/centricitywealthtech/sentinel-frontend.git
cd sentinel-frontend

# Install dependencies
pnpm install

# Start the dev server (proxies to studio-backend-dev)
pnpm dev

The frontend runs on http://localhost:3000 and proxies API calls to the dev BFF. No local backend required for UI development.

Contributing

Sentinel is built as a monorepo federation. Each service has its own repo, but contributions follow a shared convention:

  1. Branch from dev: git checkout -b feature/your-change
  2. Run lint and test: make check (Python) or pnpm lint (TypeScript)
  3. Open PR against dev with a descriptive title and test evidence
  4. CI runs lint → test → security scan → build before human review

See CI / CD for the full pipeline.

Where to go next