Also accepts a user token, sent with x-project-id and answered as a client key is, which also finds rooms on its app user's own private anchors.
Finds a room of this project by the join code someone typed. A code of another project answers exactly like a code that was never minted.
Send the room's project in x-project-id. Co-location needs a paid plan. Room operations are not counted against the monthly API request quota.
With a client key, a room on a private cloud anchor answers 404 ROOM_NOT_FOUND.
Recent Requests
Log in to see full request history
Time
Status
User Agent
Retrieving recent requests…
Loading…
Responses
401
MISSING_API_KEY: no x-api-key header and no user token.
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.
INVALID_APP_USER_TOKEN: the user token is not valid, or the secret key that minted it has been deleted or has expired.
APP_USER_TOKEN_EXPIRED: the user token has expired.
403
PROJECT_NOT_FOUND: the project does not exist.
PROJECT_ACCESS_DENIED: the project belongs to another team, or is not the project the key is bound to.
PAID_PLAN_REQUIRED: the team is on the Free plan.
APP_USER_TOKEN_SCOPE_NOT_ALLOWED: a user token without the colocation scope.
APP_USER_TOKEN_REQUIRED: a client or legacy key, once ReactVision stops accepting them for co-location. Use a user token or a secret key.
404
ROOM_NOT_FOUND: no room of this project has the code, or, for a client key, the room is on a private anchor.
409
SCENE_BOUND_TO_VPS: the room's scene was bound to an Advanced VPS location after the room was created. Its content is placed in the location's map frame, which a co-location room cannot share.
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
LOOKUP_FAILED: the room or its scene could not be read.
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.
PROJECT_LOOKUP_FAILED: the project could not be checked. Retry.
TIER_LOOKUP_FAILED: the team's plan could not be checked. Retry.