API collections ​

An API collection consists of API endpoints with a common access pattern, so that they can be managed together. For example, a set of Salesforce endpoints that are called by recipes used by the sales team should be grouped together into an API collection.

Go to Platform > API platform > API collections to access the API collections page. The API collections page displays all API collections within a workspace.

A collection can include either API proxy endpoints, API recipe endpoints, or AI gateway endpoints.

API collections page

Collection types ​

There are three types of API collections:

• API proxy collection: Forwards incoming requests to an existing API backend. Optimized for high-volume, low-cost jobs with minimal latency.
• API recipe collection: Builds custom endpoints from API recipes. Optimized for high-value jobs with full flexibility to fetch and process data.
• AI gateway collection: Exposes endpoints to LLMs, GPTs, or other AI applications to take actions on your behalf.

The type of collection you choose depends on your use case. Use the following decision tree to determine the collection type that fits your requirements:

API proxy collection ​

Choose an API proxy collection when you plan to bring your own backend. When a proxy endpoint receives an incoming request, Workato forwards the request to your existing API backend.

API proxy collections are ideal in this scenario for the following reasons:

• API proxy collections are optimized for high-volume, low-cost jobs.
• Proxy jobs are executed with minimal latency.
• Proxy requests are not subject to concurrency limits.
• With API proxy collections, customization options are limited because the main function is to forward requests.

Refer to the API proxy collection guide for more information.

API recipe collection ​

Choose an API recipe collection when you plan to build your own backend. Each endpoint in the collection maps to an API recipe that contains the logic to fetch and process data from other sources. For example, a recipe could use the Salesforce API to search for opportunities that match a particular name, and create the opportunity if the search returns no matches.

API recipe collections are ideal in this scenario for the following reasons:

• API recipe collections are optimized for high-value jobs.
• API recipe jobs are subject to a concurrency limit.
• API recipe collections provide the flexibility to highly customize how you fetch and process data.

Refer to the API recipe collection guide for more information.

AI gateway collection ​

Choose an AI gateway collection if you plan to expose endpoints to LLMs, GPTs, or other AI applications. This exposure enables AI applications to take actions on your behalf.

AI gateway collections are ideal in this scenario for the following reasons:

• AI gateway collections allow you to specify an authorization mechanism between Workato and the AI agent to keep your requests secure.
• AI gateway collections allow you to upload your OpenAPI Specification (OAS) from Workato to prevent additional processing for your AI agents.

Refer to the AI gateway collection guide for more information.

Sync to Postman ​

You can make your API collection available beyond the original client after your API collection is successfully deployed and live. Sync your API collection to your Postman workspace to increase visibility and drive adoption through Postman's internal and external portals.

Refer to Sync to Postman for more information.