Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Roam HQ API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fro.am%2Fro-am" | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fro.am%2Fro-am" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
What an agent can do with Roam HQ API.
Send a Roam message
List groups
Export message events
Test endpoint
Monitor Roam HQ API operational status and events
GET STARTED
Patterns agents use Roam HQ API for, with concrete tasks.
★ 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.
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.
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.
Search Jentic for 'send a roam message', load the operation schema, and execute with Jentic-managed credentials
5 endpoints — the roam hq api is your programmatic interface to your all-in-one virtual office.
METHOD
PATH
DESCRIPTION
/chat.sendMessage
Send a Roam message
/groups.list
List groups
/recording.list
List meeting recordings
/messageevent.export
Export message events
/test
Test endpoint
/chat.sendMessage
Send a Roam message
/groups.list
List groups
/recording.list
List meeting recordings
/messageevent.export
Export message events
/test
Test endpoint
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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.
Alternatives and complements available in the Jentic catalogue.
Specific to using Roam HQ API through Jentic.
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.
For Agents
Programmatically send a roam message, list groups. Covers 5 operations with bearer authentication.
Use for: I need to send a roam message, I want to groups, Search for meeting recordings, Find all export message events
Not supported: Does not handle payments, communications, or crm - use for productivity only.
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.
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.
Base layer of spec validity and structural soundness.
Aggregated quality score from linter diagnostics, weighted by severity.
Percentage of `$ref` references that resolve successfully.
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
Structural correctness score based on schema issues using logarithmic dampening.
Clarity, completeness, and ingestion readiness for developers and tooling.
How richly the API is illustrated with examples.
Percentage of examples that conform to their schemas.
Percentage of operations with complete response definitions (success, client error, server error).
Health of API ingestion, bundling, and resolution within Jentic pipelines.
Semantic breadth, depth, and agent comprehension for AI systems.
Coverage of descriptions across API elements.
Coverage of RFC 9457 Problem Details for error responses.
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
Coverage of summaries across operations/tags/info.
Functional utility, complexity comfort, and AI orchestration readiness.
Agent comfort level based on API operational and structural complexity.
Trust, risk posture, and security compliance.
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
Findability, semantic richness, and reasoning readiness.
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>