Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Relay App Workflows API

Operations for managing and triggering workflow runs

Relay App Workflows API is one of 3 APIs that Relay App publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.relay.app/v1.

2 operations 2 paths 2 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.relay.app
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Relay App Workflows API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Relay-API-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key for authenticating requests to the Relay App API.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Workflows 2

Operations for managing and triggering workflow runs

GET
/workflows
List Workflows
listWorkflows 2 params → 200401
GET
/workflows/{workflowId}
Get Workflow
getWorkflow 1 param → 200404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Workflow (7 properties), WorkflowList (4 properties). Each schema is shown below with its type and property counts.

Workflow
object
7 properties
WorkflowList
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relay-app-workflows-api-openapi.yml Raw ↑

Other APIs Relay App publishes across the network.

Relay App Runs API
Relay App Webhooks API