What the ReactVision Spatial API covers, how to authenticate, and where to find errors, limits and changes.
The ReactVision Spatial API serves a ReactVision Studio team's cloud anchors, geospatial anchors, files, Studio scenes and projects, scene API requests, AI generation and co-location rooms, and mints user tokens. ViroReact calls it for you once you set rvApiKey; this reference is for calling it directly, usually from your own backend.
Base URL
Every operation is under:
https://platform.reactvision.xyz/functions/v1
Authentication
Send an API key in the x-api-key header:
curl https://platform.reactvision.xyz/functions/v1/projects/{project_id} \
-H "x-api-key: rv_secret_..."
| Key | Prefix | Where it goes |
|---|---|---|
| Client key | rv_client_ | Inside your app. Bound to one project. |
| Secret key | rv_secret_ | On your backend. Never in an app you publish. |
| Legacy key | rv_live_ | Keys made before Studio 1.5.0. They keep working and are being converted. |
Each operation's description starts with the key types it accepts. Any other key type is refused with 403 API_KEY_TYPE_NOT_ALLOWED. Which key to use where, project binding and legacy keys are explained in Authentication, Client Keys and Secret Keys. User tokens (rv_ut_), minted with Mint a user token, are for VPS, which has not launched; no other operation accepts them yet.
Responses and errors
Every response is JSON and carries meta.request_id; quote it when you contact support. An error carries error.code: branch on the code, not the message. See Errors.
Limits
Monthly quotas, search bounds and rate limits are on Limits.
No test mode
Every call acts on your team's live data and counts toward its quotas.
Changes
Changes to the API are announced in the Changelog.