API Release

Once you've completed a workflow in Agentria, you can release it as an API to use it across various tasks. Once released, external systems can call this workflow directly through HTTP requests.

This guide walks you through releasing a new API, along with setting up the release version and API key that go with it.

What Is an API?

An API (Application Programming Interface) is an interface that lets different pieces of software or services communicate in a standardized way. It exposes a specific feature or piece of data to the outside world so other programs can call and use it. For example, calling the OpenAI API to generate text, or calling the Google Maps API to fetch map data, are both interactions through an API.

An API works as a request and a response, exchanging data according to a fixed set of rules. Because of this, an API is more than a simple data pipe — it's a core building block that gives systems reusability and extensibility.

When you release a workflow as an API in Agentria, the workflow itself becomes an API. That means an external backend server or another service can call it using a defined request format (an endpoint and API key), which runs the workflow and returns the result as a response.

Releasing a workflow as an API gives you the following benefits.

• Reusability: Once released, the same workflow can be called repeatedly by multiple external systems.

• Extensibility: As new services come online, you can connect them using the same API format with minimal extra work.

• Compatibility: Because the request and response format is standardized, systems built in any language or on any platform can call it the same way.

• Independence: External systems can call the API to get a result whenever they need it, without running the workflow directly from the canvas.

Before You Begin

The workflow you want to release must already be complete. If you're unsure when to bump the release version, check the 🔗Version Management guide first. You can also create a version right within this release flow.

Step 1: Starting the API Release

Click the Deploy button

Click the Deploy button at the top-right corner of the canvas.

Deploy menu

Select + New API Release from the menu. If you already have a released API, you can also pick it from the Existing API Release list to add another release of the same workflow under a different name. The same menu also lets you list it on the marketplace or deploy it as an MCP server.

Step 2: Entering API Information

New API Release modal

In the New API Release window, enter the following information.

Step 3: Selecting or Creating a Version

Under Version, select the release version to use for this deployment.

If you already have a version, pick it from the list. Otherwise, select Add Version to create one right in the same window — enter a Version number and Change Log, then click Create. See the 🔗Version Management guide for guidance on when to bump each version number.

Step 4: Selecting or Creating an API Key

Under API Key, specify the key to use for calling this API.

An API key is a string-based credential used to authenticate requests when the API is called externally. If you already have keys, they're listed with their name and expiration date (shown as "Expires: Never" for keys with no expiration), and you can select one to reuse. To issue a new one, select + Create New API Key, then enter a key name and, optionally, an expiration date before continuing.

The full API key value is shown only once — on the release-complete screen right after it's issued — along with a "Copy the key and store it somewhere safe." notice and a copy button. After that, the API Key list only shows the name and expiration date; the value itself can't be viewed again, so be sure to copy it before closing the screen.

Step 5: Completing the Release and Reviewing Info

Once you've selected a version and API key, complete the release. If you're reusing an existing key, click Deploy directly; if you chose + Create New API Key, click Next to reach the key name/expiration screen, then click Deploy.

If you issued a new API key, the API Release Complete! screen shows the newly created key value so you can copy it. This value can't be viewed again once you close the screen, so click Copy & Done to copy it and store it somewhere safe first.

To review or edit a released API's information later, click the Deploy button at the top-right of the canvas again. In the Existing API Release list, you can use the two buttons on the existing API release card.

If you'd like to test calling the endpoint you see in Edit API Settings, check the 🔗Using the Ability API Endpoint or 🔗Using the Agent API Endpoint guide.

Next Steps

Your API release is complete.

You can now call this workflow directly from external systems using the issued endpoint and API key.

• 🔗Version Management — Learn when to bump the release version and how to roll back.

• 🔗Using the Ability API Endpoint — Walks through calling a deployed Ability API from the outside.

• 🔗Using the Agent API Endpoint — Walks through calling a deployed Agent API from the outside.

Frequently Asked Questions

What can I do once I release an API?

Once you release a completed workflow as an API, external systems or services can call it directly through HTTP requests and receive the results. A released API is called using its endpoint name and API key.

Can I release without creating a version in advance?

Yes. In the Version field of the API release window, select Add Version to create a new version right there and use it for the release immediately, without leaving the window.

Can I use the same API key across multiple APIs?

Yes. The API Key list shows previously issued keys along with their expiration date, and you can select one to reuse for another API release. If you'd rather keep them separate, issue a new key for each release with + Create New API Key.

What if I lose an API key?

An API key's full value is shown only once, right after it's issued — once you close that screen, it can't be viewed again. If you lose it, open Deploy → Existing API Release → Edit API Settings and swap in a new API key.