Relay App Runs API
Operations for managing and inspecting workflow run instances
Relay App Runs 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 Runs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.
This API exposes 4 operations across 4 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Relay App Runs 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 4
Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Operations for managing and inspecting workflow run instances
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are WorkflowRun (7 properties), WorkflowRunList (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Relay App 2
Other APIs Relay App publishes across the network.