Cloud Agent

A cloud agent is a server that exposes the agent OpenAPI. You can access the agent over REST using an API key. You can create your own cloud agent, or you can use the CLI and an agent.yml configuration as we have in our Veramo Cloud Agent deployments repo. This repo also contains Docker config to create, build, and push an image to your registry.

A cloud agent could be for an individual, an organization, or a service. Depending on what you are building, you could have multiple cloud agents running in your infrastructure.

Deploy a cloud agent

The quickest way to deploy an agent is to use a free Heroku account. Go to the Veramo Cloud Agent repo and hit the Heroku deploy button.

Once you have an account, you will be presented with a configuration screen. Most of the values will be generated for you, but you will need to fill out the AGENT_URL. The other values are optional or generated for you.


Set this to your base app URL eg Your default did:web will be based on this when it gets created on the first run, e.g.,

Get the API & Secret Key

Your API & Secret will be in the Heroku env vars section. You may want to save these somewhere convenient.


Supernova e2e Agent is an example of a cloud agent. This is deployed automatically from the same deployment repo. In future releases, you will be able to serve your own custom content from the root.

Client UI

Would you like a UI to explore what's in your agent? You can try out one of our experimental client UIs. This one is called Mars Client. Add your cloud agent and API key to explore everything. Yes, there is a space theme going on here. It's one of the few places where there are enough names for a lifetime of naming things.