> ## Documentation Index > Fetch the complete documentation index at: https://docs.heliyos.ai/llms.txt > Use this file to discover all available pages before exploring further. # Heliyos API and MCP server > Heliyos is the AI operating system for revenue. Use its REST API and MCP server to read and update customer memory, run AI workers and decide reviews. DEVELOPER DOCS Knows every customer relationship.\ *Does the work around it.* ========================== Heliyos is the AI operating system for revenue: one self-updating unified memory of every customer relationship and how you sell, with AI workers that act the moment something changes, from a new account worth pursuing to a deal going quiet, and see the work through. The REST API and the MCP server let your systems and your AI agents read and change it, while your team approves what goes out. ## What Heliyos is Heliyos is built for B2B revenue teams: founders, revenue leaders and GTM operators. It is both the system of record and the system of action. It watches your conversations, accounts and the market for moments that matter and turns them into tasks. AI workers complete those tasks alongside your team, over hours or days, using the tools their job allows. Every result is written back to the record. Use Heliyos as your CRM, or keep HubSpot in sync both ways. ## What Heliyos does Each capability below says what it does in the Heliyos app and what you can reach from the API and the MCP server. * **Unified customer memory.** One self-updating memory per account: a summary, its people, its deals and a timeline of emails, meetings, notes and signals. Heliyos builds it from email, calendar, calls, LinkedIn, forms and files, so nobody has to type it in. Every worker reads it before a task and writes the result back. *API:* [records](https://docs.heliyos.ai/api-reference/records/list-records.md), [timeline](https://docs.heliyos.ai/api-reference/timeline/list-timeline-entries.md), [activities](https://docs.heliyos.ai/api-reference/activities/list-record-events.md), [interactions](https://docs.heliyos.ai/api-reference/interactions/list-interactions.md) and [notes](https://docs.heliyos.ai/api-reference/notes/list-notes.md). * **AI workers.** Taylor, the AI account executive, handles follow-ups, proposals and scheduling. Parker, the AI platform admin, updates company, people and deal records after every email and meeting. Custom workers take any role you describe in plain words, with their own triggers and actions. *API:* [create and manage workers](https://docs.heliyos.ai/api-reference/workers-and-runs/list-workers.md), [triggers](https://docs.heliyos.ai/api-reference/workers-and-runs/list-triggers.md), [actions](https://docs.heliyos.ai/api-reference/workers-and-runs/list-actions.md) and [runs](https://docs.heliyos.ai/api-reference/workers-and-runs/list-runs.md). * **Reviews.** Every important worker action, such as an outbound email, a deal stage change or sharing a file, waits for a person with its evidence and reasoning. Your workspace's autopilot settings decide what may skip review. *API:* [list reviews](https://docs.heliyos.ai/api-reference/reviews/list-reviews.md) and [approve or reject one](https://docs.heliyos.ai/api-reference/reviews/approve-or-reject-a-review.md). * **Ask Heliyos.** Ask about any account and get the answer from its memory. Ask for work and Heliyos plans it and hands it to the right workers. *API:* [Ask Heliyos](https://docs.heliyos.ai/api-reference/workers-and-runs/ask-heliyos.md), then [follow the run](https://docs.heliyos.ai/api-reference/workers-and-runs/get-a-run.md). * **Tasks.** Tasks come from emails, meetings and signals, and go to people or workers. Workers can carry a task to done. *API:* [tasks](https://docs.heliyos.ai/api-reference/tasks/list-tasks.md), [run workers on a task](https://docs.heliyos.ai/api-reference/tasks/run-workers-on-a-task.md) and [task history](https://docs.heliyos.ai/api-reference/activities/list-task-events.md). * **Watchlist.** Add key accounts and workers monitor them: they keep each company enriched, pull in its emails and meetings, and run Scouts on it. *API:* [watch a company](https://docs.heliyos.ai/api-reference/watchlist/watch-a-company.md) and [watchlist statistics](https://docs.heliyos.ai/api-reference/watchlist/get-watchlist-statistics.md). * **Scouts and signals.** Scouts watch companies and the web for buying signals such as funding rounds, product launches, leadership changes and press coverage. Each finding is a signal with a summary and its sources. *API:* [Scouts](https://docs.heliyos.ai/api-reference/scouts/list-workspace-scouts.md) and [signals](https://docs.heliyos.ai/api-reference/signals/list-signals.md). * **Knowledge.** What your workers know about your business: the business context, products, pain points, value proposition, qualification criteria, custom entries and files. *API:* [knowledge base](https://docs.heliyos.ai/api-reference/knowledge-base/get-the-knowledge-base.md) and [files](https://docs.heliyos.ai/api-reference/files/list-files.md). * **Inbox and meetings.** One inbox for Gmail, Outlook and LinkedIn, linked to every company and person. Meetings are recorded and transcribed, and their decisions and actions become record updates and tasks. *API:* read synced email threads and meetings with [interactions](https://docs.heliyos.ai/api-reference/interactions/list-interactions.md). * **Objects and fields.** Companies, people, deals and your own custom objects, with the fields your team needs. *API:* [objects and fields](https://docs.heliyos.ai/api-reference/schemas/list-objects.md). * **AI research columns and enrichment.** Heliyos researches each record for a question you ask, with sources, and fills missing company and contact details. These run in the Heliyos app today and are not in the API. * **Integrations.** Gmail, Outlook, Google Calendar, Microsoft Calendar, LinkedIn, Zoom, Google Meet, Microsoft Teams, HubSpot (two-way sync), Typeform, Google Drive and OneDrive. You connect them in the Heliyos app. ## Choose how you connect > [card] [REST API](https://docs.heliyos.ai/quickstart.md) > > Call Heliyos from your backend, scripts and integrations over HTTPS with a workspace API key. > [card] [MCP server](https://docs.heliyos.ai/mcp/overview.md) > > Give Claude, Cursor, Codex, VS Code and other MCP clients 73 tools for your workspace. ## What you can build > [card] [Keep records in sync](https://docs.heliyos.ai/guides/sync-companies.md) > > Create and update companies, people, deals and custom objects from your own systems. > [card] [Feed customer memory](https://docs.heliyos.ai/api-reference/notes/create-a-note.md) > > Write notes, upload files and update the knowledge base that workers read when they act. > [card] [Hand work to workers](https://docs.heliyos.ai/guides/run-workers-on-a-task.md) > > Create tasks, run workers on them and follow each run through review. > [card] [Watch accounts](https://docs.heliyos.ai/api-reference/scouts/list-workspace-scouts.md) > > Set up Scouts and Watchers, then read the signals they find. > [card] [Read the timeline](https://docs.heliyos.ai/concepts/timeline.md) > > Pull a record's history, emails and meetings into your own tools. > [card] [Shape the workspace](https://docs.heliyos.ai/concepts/workspace-and-objects.md) > > Add fields so Heliyos matches how your team sells. ## How it fits together ```text theme={"dark"} Your code ──HTTPS + API key──► api-prod.heliyos.ai ──► your workspace ▲ (records, notes, tasks, AI agent ──MCP (stdio)──► @heliyos/mcp Scouts, workers, review) ``` * **One workspace per key.** A key reads and writes only the workspace it was created in. * **One contract.** The MCP server calls the same endpoints this reference documents, so anything a tool does, your code can do too. * **The team stays in control.** Work that needs approval waits in review, whichever way it was started. ## Frequently asked questions > [accordion] What is Heliyos? > > Heliyos is the AI operating system for revenue. It keeps one self-updating memory of every customer relationship and how you sell, and runs AI workers that act when something changes and see the work through. Your team approves what goes out. > [accordion] Does Heliyos have an API? > > Yes. The Heliyos REST API is at `https://api-prod.heliyos.ai`. It takes and returns JSON, authenticates with a workspace API key, and covers records, objects and fields, timeline, activities, interactions, notes, tasks, workers and runs, reviews, Scouts, signals, the watchlist, the knowledge base, files, labels, team and notification settings. Start with the [Quickstart](https://docs.heliyos.ai/quickstart.md). > [accordion] Does Heliyos have an MCP server? > > Yes. `@heliyos/mcp` is an open-source Model Context Protocol server with 73 tools. It runs on your machine with `npx -y @heliyos/mcp` and works with Claude Code, Codex, Cursor, VS Code, Claude Desktop, Antigravity and any other MCP client. See [Install](https://docs.heliyos.ai/mcp/install.md). > [accordion] How do I get an API key? > > A workspace admin creates one in **Settings → API keys** in Heliyos. The key is shown once, acts as an admin of that one workspace, and stops working when it is revoked or expires. See [Authentication](https://docs.heliyos.ai/authentication.md). > [accordion] Can AI workers send emails or change deals without approval? > > Not unless you allow it. Important actions wait in Reviews with the worker's evidence and reasoning until a person approves them, unless your workspace's autopilot settings let that kind of action through. With the API you can list reviews and approve or reject them. See [Workers and review](https://docs.heliyos.ai/concepts/workers-and-review.md). > [accordion] Is Heliyos a CRM? > > Heliyos can be your CRM: it holds companies, people, deals and custom objects and keeps them current from your emails and meetings. If you use HubSpot, Heliyos keeps it in sync both ways. > [accordion] What are the API's rate limits? > > 60 requests per minute per API key. Every response says how many requests are left, and a `429` response says when to retry. See [Rate limits](https://docs.heliyos.ai/api-reference/rate-limits.md). > [accordion] How is Heliyos priced? > > Heliyos is priced by usage, with no seats. Runs of custom workers and some features use credits, which you can read with [List credit usage](https://docs.heliyos.ai/api-reference/workspace/list-credit-usage.md). Heliyos is in closed beta. [Join the waitlist](https://www.heliyos.ai). > [accordion] Where do I get help? > > Email [soham@heliyos.ai](mailto:soham@heliyos.ai), or open an issue on [GitHub](https://github.com/heliyos-ai/heliyos-mcp/issues) for the MCP server. > [card] [Make your first request](https://docs.heliyos.ai/quickstart.md) > > Create a key and list your companies in under five minutes. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.