Sphere API Reference

The Sphere platform exposes a unified REST API across multiple services — authentication, data model, chat, workflows, and more. All traffic routes through a single Traefik gateway with path-based routing.

Getting started

Sphere is a multi-tenant platform with event-driven architecture. Each tenant has isolated databases and resources. To get started, you need to resolve your tenant via the Hub, authenticate via sphere-auth to obtain a JWT token, then use that token to access all service endpoints through the gateway.

Guides

Authentication

Learn how to authenticate via Hub discovery, login, and JWT tokens.

Read more

Core Concepts

Understand multi-tenant architecture, CQRS, and event-driven patterns.

Read more

Pagination

Work with cursor-based and offset pagination across all endpoints.

Read more

Errors

Handle error responses, validation errors, and HTTP status codes.

Read more

Resources

Auth & Sessions

Login, tokens, MFA, password management, and session lifecycle.

Chat

Conversations, messages, real-time signals, inbox, notifications, and webhooks.

Data Model

Families, entities, relations, and the CQRS intention-based write path.

Users & Permissions

User profiles, tenant administration, workspace RBAC, and member management.

Was this page helpful?