canonical: https://jentic.com/apis/ro.am/ro-am

# Roam HQ API

The Roam HQ API is your programmatic interface to your all-in-one Virtual Office. **OpenAPI Spec:** [openapi.json](https://developer.ro.am/openapi.json) **Other APIs:** - [On-Air API](https://developer.ro.am/docs/onair-api/on-air-api) (events, guests, attendance) - [onair.json](https://developer.ro.am/onair.json) - [Alpha API](https://developer.ro.am/docs/chat-api/roam-hq-chat-api-alpha) (chat, us. The API exposes 5 endpoints secured with bearer authentication.

## For AI agents

Programmatically send a roam message, list groups. Covers 5 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for productivity only.

## Capabilities

- Send a Roam message
- List groups
- Export message events
- Test endpoint
- Monitor Roam HQ API operational status and events

## Use cases

### Productivity Operations

Use the Roam HQ API to perform productivity operations programmatically. The API provides 5 endpoints covering core functionality including send a roam message, list groups, list meeting recordings.

Example prompt: Call POST /chat.sendMessage to send a roam message

### Automated chat.sendMessage Management

Automate chat.sendmessage operations by combining multiple Roam HQ API endpoints. Agents can list groups and then list meeting recordings in a single workflow.

Example prompt: Call GET /groups.list to list groups, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Roam HQ API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'send a roam message', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/chat.sendMessage` | Send a Roam message |
| GET | `/groups.list` | List groups |
| GET | `/recording.list` | List meeting recordings |
| POST | `/messageevent.export` | Export message events |
| GET | `/test` | Test endpoint |

## Key resources

- **chat.sendMessage** — Operations related to chat.sendMessage
- **groups.list** — Operations related to groups.list
- **messageevent.export** — Operations related to messageevent.export
- **recording.list** — Operations related to recording.list
- **test** — Operations related to test

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 61 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 71 / 100
  - Developer Experience & Jentic Compatibility: 64 / 100
  - AI-Readiness & Agent Experience: 39 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/ro.am/ro-am/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Roam HQ API by hand means passing your API key or OAuth access token as a bearer token, sending it on every call to the api.ro.am host, and handling each chat, groups, and recording request yourself. Through Jentic you install once, import the Roam HQ API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** This API carries its target, such as the message and its destination, in the request body rather than a resource id in the path, so scope the agent to the operations it needs, such as listing groups and reading recordings: you can grant those reads without allowing chat.sendMessage. Every operation the agent can run is one you have added to that allowed set.
- **Credential handling:** Your Roam HQ token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a Roam message' or 'list recordings', and Jentic returns the matching Roam HQ API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Asana** — Alternative productivity API
- **Monday** — Alternative productivity API
- **Clickup** — Complementary productivity API

## FAQ

### What authentication does the Roam HQ API use?

The Roam HQ API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I send a roam message with the Roam HQ API?

Yes. Use the POST /chat.sendMessage endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Roam HQ API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I send a roam message through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'send a roam message'. Jentic returns the matching Roam HQ API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Roam HQ API have?

The Roam HQ API exposes 5 endpoints covering chat.sendmessage, groups.list, messageevent.export operations.

### Can I limit what my agent is allowed to do with the Roam HQ API?

Yes. Because you run Jentic One yourself, your own rules decide which Roam HQ operations and credentials the agent may use, and every operation it can call is one you have added to that allowed set. You can grant read-only access, such as GET /groups.list and GET /recording.list, without allowing the agent to send messages through POST /chat.sendMessage. Since this API carries its target in the request body rather than a resource id in the path, scoping is done at the operation level, so you keep exports and message sends off the allowed list unless you explicitly add them.