Create a co-location room

post

https://platform.reactvision.xyz/functions/v1/colocation/rooms

Client or secret key.

Creates a room for a frame this device established, and mints its six-character join code. Other devices look the code up, then join the relay room named by room_id. Viro's co-location room helpers call it.

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 cloud_anchor room needs a public anchor: a private anchor answers 404 ANCHOR_NOT_FOUND, the same as an anchor that does not exist.

A room lasts 90 days, and a room on a cloud anchor is deleted with the anchor. A project holds at most 500 rooms.

Recent Requests

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.

`INVALID_BODY`: the body is not a JSON object, `frame_kind` is unknown, `cloud_anchor_id` or `frame_ref` is missing or malformed for the frame kind, or `name` is over 150 characters.

`INVALID_SCENE_ID`: `scene_id` is not a scene of this project.

Create a co-location room

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

`ANCHOR_NOT_FOUND`: `cloud_anchor_id` is not an anchor of this project, or, for a client key, is private.

`TOO_MANY_ROOMS`: the project already holds 500 rooms.

`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 anchor, scene or room count could not be read.

`CREATE_FAILED`: the room could not be created.

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

201The room.

403PROJECT_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.

404ANCHOR_NOT_FOUND: cloud_anchor_id is not an anchor of this project, or, for a client key, is private.

409TOO_MANY_ROOMS: the project already holds 500 rooms.

429RATE_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.