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

Hatchet Workflow Runs API

The Workflow Runs API from Hatchet — 9 operation(s) for workflow runs.

Hatchet Workflow Runs API is one of 27 APIs that Hatchet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 12 JSON Schema definitions.

Tagged areas include Workflow Runs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, code examples, authentication docs, and 12 JSON Schemas.

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

Requests are made against the base URL https://api.hatchet-cloud.run.

9 operations 9 paths 24 schemas 7 GET2 POST

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.hatchet-cloud.run
Authentication
HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Hatchet Workflow Runs API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the cookie as hatchet (cookieAuth). It accepts HTTP bearer tokens (customAuth). By default, every request must be authenticated.

Paths & Operations 9

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

Workflow Runs 9
GET
/api/v1/stable/tenants/{tenant}/workflow-runs
List Workflow Runs
v1-workflow-run:list 14 params → 200400403501
GET
/api/v1/stable/tenants/{tenant}/workflow-runs/display-names
List Workflow Runs
v1-workflow-run:display-names:list 2 params → 200400403501
GET
/api/v1/stable/tenants/{tenant}/workflow-runs/external-ids
List Workflow Run External Ids
v1-workflow-run:external-ids:list 7 params → 200400403501
POST
/api/v1/stable/tenants/{tenant}/workflow-runs/trigger
Create Workflow Run
v1-workflow-run:create 1 param body → 200400403
POST
/api/v1/stable/tenants/{tenant}/durable-tasks/branch
Branch Durable Task
v1-durable-task:branch 1 param body → 200400403
GET
/api/v1/stable/workflow-runs/{v1-workflow-run}
List Tasks
v1-workflow-run:get 1 param → 200400403501
GET
/api/v1/stable/workflow-runs/{v1-workflow-run}/status
Get Workflow Run Status
v1-workflow-run:get-status 1 param → 200400403404501
GET
/api/v1/stable/workflow-runs/{v1-workflow-run}/task-events
List Tasks
v1-workflow-run:task-events:list 3 params → 200400403501
GET
/api/v1/stable/workflow-runs/{v1-workflow-run}/task-timings
List Timings for a Workflow Run
v1-workflow-run:get:timings 2 params → 200400403501

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are V1TaskSummary (30 properties), V1TaskTiming (16 properties), V1WorkflowRun (15 properties), V1TaskEvent (11 properties). Each schema is shown below with its type and property counts.

V1TaskEventType
string
APIResourceMeta
object
3 properties 3 required
V1RunningFilter
string
V1WorkflowType
string
APIError
object
4 properties 1 required
PaginationResponse
object
3 properties
V1WorkflowRunDetails
object
5 properties 4 required
V1TaskSummaryList
object
2 properties 2 required
V1WorkflowRunDisplayNameList
object
2 properties 2 required
V1TaskTiming
object
16 properties 8 required
V1TriggerWorkflowRunRequest
object
4 properties 2 required
V1WorkflowRun
object
15 properties 8 required
V1TaskEvent
object
11 properties 5 required
V1BranchDurableTaskRequest
object
3 properties 3 required
V1WorkflowRunExternalIdList
array
The list of external IDs
WorkflowRunShapeForWorkflowRunDetails
array
V1TaskSummary
object
30 properties 15 required
V1TaskEventList
object
2 properties
APIErrors
object
1 property 1 required
V1TaskTimingList
object
2 properties 2 required
WorkflowRunShapeItemForWorkflowRunDetails
object
4 properties 4 required
V1WorkflowRunDisplayName
object
2 properties 2 required
V1TaskStatus
string
V1BranchDurableTaskResponse
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hatchet-workflow-runs-api-openapi.yml Raw ↑

Other APIs Hatchet publishes across the network.

Hatchet API Token API
Hatchet CEL API
Hatchet Durable Tasks API
Hatchet Event API
Hatchet Feature Flags API
Hatchet Filter API
Hatchet Github API
Hatchet Healthcheck API
Hatchet Log API
Hatchet Metadata API
Hatchet Monitoring API
Hatchet Observability API