Version: 0.1

Roam HQ Chat API (Alpha)

The Roam HQ Chat API (Alpha) provides advanced chat, meeting, and user management capabilities for building powerful integrations with your Roam Virtual Office.

OpenAPI Spec: chat.json

Endpoints Overview

Chat & Messaging

Endpoint	Method	Description
/chat.list	GET	List all accessible chats (DMs, MultiDMs, Channels)
/chat.post	POST	Send a message to any chat, group, or user (supports Block Kit)
/chat.typing	POST	Show typing indicator to other participants
/chat.history	GET	Retrieve message history for a chat
/item.upload	POST	Upload files to attach to messages
/reaction.add	POST	Add emoji reaction to a message

Groups & Channels

Endpoint	Method	Description
/group.create	POST	Create a new group/channel
/group.rename	POST	Rename an existing group
/group.archive	POST	Archive a group
/group.members	GET	List members in a group
/group.add	POST	Add members or admins to a group
/group.remove	POST	Remove members from a group

Users

Endpoint	Method	Description
/user.list	GET	List all users in the account
/user.info	GET	Get detailed info about a single user
/user.lookup	GET	Look up a user by email
/addr.info	GET	Get detailed info about any chat address
/userauditlog.list	GET	Retrieve user audit log entries

Meetings & Transcripts

Endpoint	Method	Description
/meeting.list	GET	List meetings with participant info
/meetinglink.create	POST	Create a shareable meeting link
/meetinglink.info	POST	Get meeting link details
/meetinglink.update	POST	Update meeting link properties
/transcript.list	GET	List meeting transcripts
/transcript.info	GET	Get full transcript with cues and action items
/transcript.prompt	POST	Ask an AI question about a transcript

Lobbies & Scheduling

Endpoint	Method	Description
/lobby.list	GET	List active lobby configurations
/lobbyBooking.list	GET	List bookings for a lobby

App Management

Endpoint	Method	Description
/token.info	GET	Get info about the current access token
/app.uninstall	POST	Revoke access token and uninstall app

Access Models

Endpoints support Organization access by default. Some endpoints additionally support Personal access, where the integration acts as the authenticated user and sees only their data.

Endpoints supporting both access models:

• /token.info -- Organization and Personal

• /chat.post -- Organization and Personal (Org: sends as bot, Personal: sends as you)

• /chat.history -- Organization and Personal (Personal: only your chats)

• /transcript.list -- Organization and Personal (Personal: only your meetings)

• /transcript.info -- Organization and Personal (Personal: only your meetings)

• /meetinglink.create -- Organization and Personal (Personal: creates link for authenticated user)

All other endpoints support Organization access only. See the Access Models guide for details.

Common Use Cases

Build a Chat Bot

Create an OAuth app with chat:read and chat:write scopes, configure a webhook URL to receive messages, then respond programmatically.

• Subscribe to chat:message:dm or chat:message:channel events
• Use /reaction.add to acknowledge receipt
• Use /chat.typing to show typing indicator
• Use /chat.post to send a response
• Use Block Kit for rich, structured messages with buttons and formatting

Post-Meeting Automation

Automatically process recordings and transcripts after meetings end.

• Subscribe to transcript:saved or recording:saved events
• Use /transcript.info to retrieve summaries, action items, and full transcript

Scheduling Integrations

Create meeting links and sync lobby bookings with external calendars.

• Subscribe to lobby:booked for new bookings
• Use /meetinglink.create to generate shareable links

Authentication

Authorization: Bearer YOUR_TOKEN

Base URL

https://api.ro.am/v0

---

Have questions? Contact us via Roam Support Chat or email developer@ro.am.

Authentication

HTTP: Bearer Auth

Pass your API Key or OAuth access token as a Bearer token. Example: Authorization: Bearer <token>

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer

Contact

Developer Support: developer@ro.am

URL: https://developer.ro.am

Terms of Service

https://ro.am/terms

🗃️ Chat

6 items

🗃️ Groups

6 items

🗃️ Users

5 items

🗃️ Meetings

9 items

🗃️ App

2 items