REST API
Complete REST API documentation for rooom platform. HTTP endpoints for 3D product management, virtual spaces, renderings, and analytics.
The rooom REST API gives programmatic access to rooomSpaces and rooomProducts. Use it to manage 3D products and spaces, configure viewers, trigger renderings, and retrieve analytics from any language or framework that can send HTTP requests.
Base URL
All endpoints share a single base URL and follow REST conventions.
Endpoints
Browse all operations in the API Endpoints section or use the sidebar to navigate by category.
Authentication
An API key is required. Pass it in the Authorization header as a Bearer token.
See the Authentication guide to create and manage API keys. A failed authentication returns 401 Unauthorized.
Transport
The API runs over HTTPS with HTTP/1.1 and HTTP/2 support. TLS 1.2 and 1.3 are accepted. For cipher details see the Security page or the SSL Labs report.
Content Type
All requests must use Content-Type: application/json. Responses, including errors, are JSON.
Errors
Error responses always include a code and message field. See the Errors reference for the full list of status codes.
Rate Limiting
The API allows 20 requests per second per IP address.
INFO
Need a higher limit? Get in touch.
Versioning
All endpoints target the latest API version. Response objects may gain new fields over time — only read the keys your application needs.