You can assign custom metadata to your room. For example, if you have different types of room experiences, you can store that type as metadata. This would then come handy when building an overview page listing all the rooms where the type metadata could be used as a filter, making it easy for people to find what they’re looking for.

One way to edit metadata is to use the create room API. In this example we’re creating a new room with a custom roomType property, and setting it to "whiteboard":

fetch("", {  method: "POST",  body: JSON.stringify({    id: "my-room-name",    defaultAccesses: [],    metadata: {      roomType: "whiteboard",    },  }),});

We can then use the get rooms API to retrieve a list of rooms containing the "whiteboard" roomType:

const metadata = "metadata.roomType=whiteboard";const url = `${metadata}`;const response = await fetch(url);const rooms = await response.json();

Metadata can be also be used within a number of our other APIs.