API

Expose Workflows through APIs and configure authentication and access.

Find guidance on API bindings, tokens, OAuth, allowed origins, and OpenAPI definitions. Choose the article for your Runtime when configuring a Workflow endpoint.

11 Articles

API

Workflow HTTP endpoints use different authoring models in each runtime.

API v1

Any Flowgear Workflow can be published as a REST API.

API v2

A Workflow that contains an HTTP Receive and an HTTP Respond step will be published as an HTTP endpoint.

Cookie-based Authentication

An API Key with type Cookie authorizes embedded Flowgear App calls for selected users and Workflows in one Environment.

Core API

This article discusses Core API to automate actions like retrieving logs or reading Workflow definitions or metadata, see API for the Workflow API.

CORS and Allowed Origins

Cross-Origin Resource Sharing (CORS) is a standard that helps protect websites by controlling whether one website is allowed to request data from another.

Delegated MCP User Authentication

An API Key with type Delegated MCP user defines which signed-in users and Workflows can participate in Workflow MCP for one Environment.

Flowgear OAuth

Use this feature to sign in with OAuth and obtain tokens for Flowgear.

OpenAPI Definitions via API

Use this feature to download a ready-to-use OpenAPI 3 Definition (YAML) for exactly the Workflows that your API Key is assigned to call.

Token Authentication

The token in an API Key is used to authorize invokes of Workflows.

Troubleshooting API Binding

Here are some common errors that occur when invoking Workflows via REST API.