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
Time
Status
User Agent
Retrieving recent requests…
Loading…
Responses
403
API_REQUEST_LIMIT_REACHED: the team's monthly API request quota is used up.
404
SCENE_NOT_FOUND: no such scene, or one the key cannot reach.
426
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.
429
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.
500
INTERNAL_ERROR: an unexpected error. Retry, and quote meta.request_id to support if it persists.
503
API_KEY_LOOKUP_FAILED: the key could not be checked. Retry; this does not mean the key is invalid.