MeshAgent Rooms provide real-time collaborative workspaces for agents and participants. Each room dynamically manages participant lists, tracks presence, and enables information sharing. Rooms are automatically provisioned when participants join, ensuring effortless integration and minimizing synchronization complexity. Rooms also serve as gateways to several additional APIs accessible through the room object:
  • Agents API AgentsClient: Manages agent interactions.
  • Database API DatabaseClient: Provides a simple relational-like API for data storage and retrieval through tables.
  • Queues API QueuesClient: Facilitates reliable data/message exchange with other agents or participants.
  • Messaging API MessagingClient: Enables real-time chat messaging among participants.
  • Sync API SyncClient: Offers document synchronization capabilities, listing remote participants, allowing participants to collaborate on shared documents.
  • Storage API StorageClient: Manages file storage and retrieval.

​
Let’s connect to a room

First, be sure to have followed the Getting Started with MeshAgent Docs. Next, in your terminal authenticate to MeshAgent and export the environment variables needed to connect to your MeshAgent project. You can do this using the MeshAgent CLI. 
meshagent auth login
meshagent project activate -i
meshagent api-key activate -i
meshagent env
Now run the code to connect to a MeshAgent room. 
import asyncio
from meshagent.api import RoomClient, websocket_protocol


async def main():
    # Define a unique room name
    room_name = "my-room"
    participant_name = "my-participant"

    async with RoomClient(
        protocol=websocket_protocol(
            participant_name=participant_name, room_name=room_name
        )
    ) as room:
        print("connected to room")


asyncio.run(main())

​
Room Class Overview

​
Methods

  • start: Establishes a connection to the server.
  • dispose: Disconnects from the server and cleans up resources.
  • sendRequest: Sends requests to the server.
  • emit: Emits events to room listeners.
  • listen: Listens for room events.

​
Getters

  • localParticipant: Retrieves local participant details.
  • ready: Indicates room readiness.
  • sync: Accesses synchronization functionality (SyncClient).
  • storage: Accesses storage functionality (StorageClient).
  • agents: Accesses agents functionality (AgentsClient).
  • queues: Accesses queues functionality (QueuesClient).
  • messaging: Accesses messaging functionality (MessagingClient).
  • database: Accesses database functionality (DatabaseClient).