HomeGuidesAPI ReferenceChangelogDiscussions
Hire a ReactVision Expert 🛠️Launch Studio 🖥️Sponsor on GitHub ❤️Log In
Guides

Getting Started with ReactVision Spatial

Set up on ReactVision Spatial for Cloud Anchors, Geospatial Anchors, Co-Location and Asset Generation: create your Studio account, team and project, copy the project ID, and find where to create API keys.

📘

When do you need this?

If you want to use Spatial features, including Cloud Anchors, Geospatial Anchors, Co-Location or Asset Generation, you need to be set up on the ReactVision Spatial platform. For Cloud and Geospatial Anchors this applies when you use provider="reactvision" (the default since v2.53.0); with provider="arcore" or provider="none" you do not need it for anchors.

You set up on ReactVision Spatial in ReactVision Studio. This guide walks you through creating your account, choosing a team, creating a project and copying its project ID, then shows where to create the API keys your app needs: a client key for that project, and a secret key if your backend needs one.


Step 1: Create a ReactVision Studio Account

  1. Go to studio.reactvision.xyz
  2. Log in with an existing account or create a new one

Step 2: Select a Team

  1. Navigate to studio.reactvision.xyz/dashboard/team/list
  2. Select the team you would like to use for your app

Step 3: Create a Project

  1. Once in your team, you will be taken to the Projects section
  2. Click Create Project in the top-right corner
  3. Enter a name for your project
  4. Optionally configure an icon and occlusion settings (these can be updated later)
  5. Click Create to finish

Step 4: Get Your Project ID

  1. Click into the project you just created
  2. Click the Edit button in the top-right corner
  3. In the edit modal, you will see a Project ID displayed under the project name
  4. Click the Copy button to copy your project ID

📋

Keep this handy — you will use this value as rvProjectId in your app configuration.


Step 5: Create API Keys

API keys are created in Studio on your team's API Keys page: in your team's sidebar, under Integrations, click API Keys. There are two kinds.

Client key: goes inside your app, as rvApiKey, with the project ID from Step 4 as rvProjectId. It is bound to one project, chosen when you create it, and reaches only that project. Every user of your app holds it, so treat it as public. Your app needs one: see Client Keys to create it and add it to your app.

Secret key: stays on your own backend. Only a secret key can generate with AI, read or delete your app users' files and mint user tokens, and it is needed to edit or delete anchors and to upload images, videos and 3D models. Never put one in an app you publish. Studio shows a secret key once, when you create it. See Secret Keys if your backend needs one.

For which key each operation accepts, legacy keys and what deleting a project does, see Authentication.


Request region & location (3.0.3+)

  • Region pinning. Studio, scene, project and cloud-anchor requests run in the platform database's region, so devices far from London no longer pay the distance on every query. If that region's edge runtime is down, a request the gateway could not deliver is sent once more unpinned. Nothing to configure for API-key apps.
  • iOS location. The Core Location feed starts only when both RVApiKey and RVProjectId are set (as before 3.0.2). Apps that only use a Studio session no longer prompt for location when opening an AR scene.