Spatial Mods Platform
Spatial Mods is an enterprise AR (augmented reality) platform for businesses that want to attach interactive content — videos, models, signatures, branded overlays — to physical images and objects. Your customers point a camera at a poster, product, or printed material; the platform recognises it in the cloud and streams back the AR experience you authored.
This site is the public developer reference for partners and integrators building against the platform.
What you can build
- AR-enhanced print and packaging — register source images, attach video or HTML overlays, deliver to mobile apps via cloud image recognition.
- Branded mobile experiences — embed our recognition + playback flow inside your own Unity-based mobile app, or use the white-label client.
- Campaign-driven analytics — track scans, engagement, conversion at the business + campaign level.
Surface area
The platform is composed of three independently versioned HTTP APIs:
| API | Purpose | Reference |
|---|---|---|
| Platform API | Campaigns, media library, AR resolution, billing, business membership, analytics. The heart of the integration. | /api/dotnet |
| Auth API | Registration, login, MFA, password reset, contact verification, cross-domain SSO for partner websites. | /api/auth |
| Media API | Image and video upload, deduplication, transcoding job observability. | /api/vuforia |
All endpoints use JSON over HTTPS and authenticate with bearer JWTs issued by the Auth API. Start with Authentication for the end-to-end flow.
Conventions
- Multi-tenant scoping — most endpoints live under
/api/business/{businessId}/…. Your JWT carries the list of businesses you have access to and the role you hold in each. - Errors — every response is a
ServiceResponse<T>envelope:{ "success": bool, "data": …, "message": … }. See the error reference for HTTP-status conventions. - Idempotency — media upload, campaign mutation, and AR resolution are safe to retry. Where ordering matters, the platform uses correlation IDs and upload locks; the rest of the guides walk through those.
When you are ready, jump to Getting Started → Authentication.