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

Get a scene

Client or secret key. Scope: scenes.

Returns everything needed to render an Editor scene: the scene's settings, the project's occlusion mode, the placed assets, the collision, proximity and gaze bindings, the animations, the scene functions fully resolved, the project's variables, and whether the team is on the Free plan. Viro's StudioSceneNavigator loads scenes with it.

With a client key the scene must be in the key's project. An id your key cannot reach (another team's, or another project's for a bound key) gets the same answer as an id that does not exist.

A scene bound to an Advanced VPS location (scene.vps_location_id) places its plane assets in the location's scanned map frame, so a renderer has to localise in the location before it draws them. A renderer that ignores the binding would draw the content where the AR session started, so such a scene is served only to a request that sends x-rv-capabilities: vps, and its payload then carries vps. Without the header it answers 426 SCENE_REQUIRES_VPS_RUNTIME.

Counts as one request against the team's monthly API request quota, including a request that then fails a check, except a 426 SCENE_REQUIRES_VPS_RUNTIME, which is not counted.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Scene id.

Headers
string

Runtime features your renderer supports, as a comma-separated list. vps is the only value today. Send vps only once your renderer places the plane assets of a scene bound to an Advanced VPS location in that location's map frame: without it, a bound scene answers 426 SCENE_REQUIRES_VPS_RUNTIME. Scenes that are not bound are served either way. The Viro release that supports Advanced VPS sends it on its own scene requests.

Responses

MISSING_AUTH: no x-api-key header, and no other credential.

INVALID_API_KEY_FORMAT: the key is not rv_live_, rv_client_ or rv_secret_ followed by 64 lowercase hexadecimal characters.

INVALID_API_KEY: no such key, or a key sent with the wrong prefix for its type.

API_KEY_EXPIRED: the key is past its expiry date.

AUTH_ERROR: a user token (rv_ut_) was sent as a Bearer token. This operation does not accept user tokens.

API_REQUEST_LIMIT_REACHED: the team's monthly API request quota is used up.

SCENE_NOT_FOUND: no such scene, or one the key cannot reach.

SCENE_REQUIRES_VPS_RUNTIME: the scene is bound to an Advanced VPS location and the request did not send x-rv-capabilities: vps. Only a scene your key can reach answers this; any other answers 404. Not counted against the monthly API request quota.

RATE_LIMITED: for a secret key, more than 1,200 requests a minute across all operations. Wait the number of seconds in Retry-After. See Limits.

INTERNAL_ERROR: an unexpected error. Retry, and quote meta.request_id to support if it persists.

API_KEY_LOOKUP_FAILED: the key could not be checked. Retry; this does not mean the key is invalid.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json