Introducing the Carom API

Carom now has an API—a way for programmers (or anyone with an AI agent) to integrate their Carom data into other applications, tools, and workflows. Just about everything you can do in our own application, you can do via the API. We’re excited to see what people do with it!

You can generate an API key and start building today. Go to Settings › API keys in Carom, then read the API overview and documentation to get started. If something is missing or unclear, write to us.

A new interface, built on the same privacy and sharing model

It’s up to an account administrator to decide whether to enable the API for their organizations. If they choose to do so, users can create API keys that act exactly like them—they can only view, search for, edit, and delete the records they have access to in our application.

Keys come in two flavors: read-only or read + write. Especially if you’re having your own AI agents build tooling for you, read-only is the safest way to start: you won’t be able to modify or create anything in Carom. As an administrator, you can restrict access to all of your users to read-only—limit the blast radius in case something goes wrong, but still show Carom data where you want it.

If you do want your AI agents or applications to be able to modify Carom data, you can use a read + write key. There are a few functions that aren’t accessible through the API—mostly related to account management (you can’t delete your account through the API) and email sending. As always, we’re balancing risk and reward, and we want to make sure a rogue agent doesn’t decide to email everyone you know.

For developers, and AI assistants

In the past, APIs were for programmers. Now the most common consumers are surely AI agents. You can point your local Claude or ChatGPT agent to our API, provide an API key, and get to work—without ever reading the documentation or understanding how to code. And next time we’ll talk about how we’re making this even easier, with a command-line interface (CLI) that simplifies the interactions for agents.

A few ideas to get you started

The best part of creating an API is seeing how people put it to use—often in ways its developers wouldn’t have imagined. But here are a few thoughts for useful tools this would enable:

  • Insights in your chat system, so you can see the latest information pushed into Slack, or allow your users to check in with the latest information in Carom right from there.
  • Live insights included in your reports; dashboards and reports for your executives, sales team, or board can include the latest deal status from Carom.
  • Integration into your existing support process, so as users email your support email, their information can make it to the right people in the tools you’re already using.

If you have ideas, issues, or questions, as always, just let us know.