Read a co-location room's saved state

get

https://platform.reactvision.xyz/functions/v1/colocation/rooms/{room_id}/state

Client or secret key.

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

`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.

`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.

`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

Header

Loading…

Response

Choose an example:

application/json