API Manager

API Manager turns published workflows into governed interfaces for applications, people, and AI clients. Use it to assemble API collections, publish OpenAPI contracts, manage client access, expose operations as MCP tools, create mock endpoints, and manage chat or form surfaces.

Where to start

Create an API collection

Group workflow endpoints into a managed, publishable API.

Create a collection →

Publish a collection

Publish an OpenAPI contract and make it available to consumers.

Publish →

Client profiles

Grant applications access and manage their credentials.

Manage access →

MCP servers

Expose API operations as tools that AI clients can call.

Expose AI tools →

Chat and form surfaces

Publish a workflow as a conversational or form-based experience.

Build a surface →

Mock endpoints

Let consumers integrate before the backend is ready.

Create mocks →

Choose a task

Goal	Guide
Group workflow endpoints into a managed API	Create an API collection
Publish or update a collection	Publish an API collection and update a collection
Grant an application access	Create client profiles
Test consumers before a backend is ready	Create mock API endpoints
Expose API operations as AI-callable tools	MCP servers
Publish a workflow as a user experience	Chat and form surfaces
Understand AI protocols and authorization	AI integrations, tools, and authorization

API lifecycle

1. Publish the workflow endpoints that should be externally callable.
2. Create an API collection and select only the required operations.
3. Review the generated OpenAPI contract and publish the collection.
4. Apply a client profile or security profile with least-privilege scopes and claims.
5. Test authentication, authorization, error responses, and rate limits.
6. Monitor API, MCP, and workflow execution behavior after release.

tip

Contract-first development You can also begin with an OpenAPI 3.x contract and generate applications, workflows, or activities. See Working with OpenAPI specs.

Security responsibilities

• Store secrets in managed credentials or vault-backed resources, not documentation or workflow literals.
• Separate client-to-platform authorization from downstream credentials used by a workflow or MCP tool.
• Classify mutating MCP operations as Write and require user confirmation in compatible clients.
• Rotate client secrets and revoke access when ownership or scope changes.
• Use audit logs and operational metrics to review sensitive changes and unexpected calls.

The detailed task guides in this section are the source of truth for individual procedures.

1.Create & Publish API Collections

1. Create an API Collection

• Navigate to Settings from the left sidebar and click on Create Collections.

• Fill in the collection details, select the API paths for the workflows, and click Create.

2. View and Publish the Collection

The created collection will appear on the API Collections page. Click on the collection name to navigate to the Publish API Collections section.

• Click Publish to Manager to publish the API collection.

3. Update the Collection

To update the collection, click the Edit button, make the necessary changes, and click Update.

• After updating, remember to republish the collection by clicking Publish to Manager again.

2.API Manager Features

Once an API is published, it becomes available across the organization.

1. View Published Collections

Published collections are accessible on the API Collections page within the API Manager.

2. Create and Invite Clients

To create a new client, navigate to the Clients page in the API Manager and click Create Client.

• Fill in the required details and click Create to create a client.

• The new client will be listed on the Clients page.

2. Create Access Profile

To create an access profile, click on the client name and navigate to the Create Access Profiles page.

• Add profile details, select the API collections, and click Create.

• After creating the access profile, copy the client ID and secret to request an access token for API authentication.

3. Generate Access Tokens

Access the Create Access Profiles page to view and manage tokens.

• Click the + icon to view the client ID and secret, and to generate an access token.

• To refresh the client secret, click Refresh.

• To generate an access token, click Generate Access Token, paste the client secret, and click Generate. Copy the generated access token for secure API calls.