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

Read a co-location room's saved state

Client or secret key. Scope: colocation.

Also accepts a user token, sent with x-project-id and answered as a client key is.

Returns the saved copy of a replication room's entities, which the relay writes when the last device leaves.

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.

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

The room's id.

Headers
uuid
required

The room's project. With a client key the project must be the key's own project.

Responses

MISSING_PROJECT_ID: no x-project-id header. Checked before the key.

INVALID_PROJECT_ID: x-project-id is not a UUID.

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.

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.

ROOM_NOT_FOUND: no such room in this project, or an id that is not a UUID.

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.

LOOKUP_FAILED: the room could not be read.

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.

PROJECT_LOOKUP_FAILED: the project could not be checked. Retry.

TIER_LOOKUP_FAILED: the team's plan could not be checked. Retry.

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