Getting Started
Welcome to the immersive API. This documentation will guide you through integrating our API into your applications. Start by obtaining an API key from your developer dashboard.
/api/v1/immersive/visualize
This endpoint returns immersive analytics for the provided 3D dataset
Authentication
Use Bearer token authentication with the Authorization header. Tokens can be generated from your developer dashboard.
Authorization: Bearer YOUR_API_TOKEN
Tokens expire after 7 days. Use the /renew-token endpoint to get a new one.
Versioning
Currently using version v2.1.0-immersive
March 2025 Release
Production-ready with WebGPU-powered visualization and real-time 3D analytics.
New in 2.1.0: Real-time raytraced data overlays, interactive 3D heatmaps, and immersive UI mode.
API Features
Real-Time 3D
WebGPU-rendered 3D datasets with real-time raytraced visualizations and spatial analytics
- • 4K+ resolution rendering
- • WebXR compatible viewer
- • Instant data binding
Dynamic UI
Smart interface that adjusts to data complexity and user interaction patterns
- • Adaptive UI density
- • Context-aware tooling
- • Voice-command integration
Data Analytics
Multi-dimensional data analysis with instant rendering of correlations
- • Real-time heatmaps
- • Automated pattern detection
- • Cross-dimensional analytics
API Endpoints
/api/v1/immersive/render
Render dataset in immersive 3D with dynamic visual configuration
Request Body
{
"dataset": "energy_usage",
"format": "octree",
"style": "heatgrid"
}
/api/v1/immersive/export
Export interactive visualization as animated 3D model with metadata
Query Parameters
- format: gltf, fbx, obj
- quality: low, medium, high
- withmetadata: true/false
Code Examples
JavaScript
fetch('https://api.example.com/immersive/render', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
dataset: 'sales_q3',
style: 'timeline'
})
}).then(res => res.json()).then(data => {
// Display 3D visualization
});
Python
import requests
requests.get('https://api.example.com/immersive/export',
params={'format': 'gltf', 'quality': 'high'},
headers={'Authorization': 'Token ' + YOUR_API_KEY})
.json()