Temporal Workflows API
Start, describe, list, count, and read the history of workflow executions.
Temporal Workflows API is one of 8 APIs that Temporal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 7 operations across 7 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against 2 base URLs: https://{namespace}.{account}.tmprl.cloud/api/v1, http://localhost:7243/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Temporal Workflows API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— Bearer API key. On Temporal Cloud, pass an API key as Authorization: Bearer . Self-hosted deployments may use mTLS instead. Requests are scoped to the namespac…
Paths & Operations 7
Across 7 paths, the API surfaces 7 operations — 6 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Start, describe, list, count, and read the history of workflow executions.
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are StartWorkflowExecutionRequest (10 properties), Status (3 properties), GetWorkflowExecutionHistoryResponse (3 properties), ListWorkflowExecutionsResponse (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 Temporal 7
Other APIs Temporal publishes across the network.