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 Run API

The Workflow Run API from Hatchet — 6 operation(s) for workflow run.

Hatchet Workflow Run 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 Run. 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 6 operations across 6 paths, and defines 33 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.

6 operations 6 paths 33 schemas 1 GET5 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 Run 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 6

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

Workflow Run 6
POST
/api/v1/tenants/{tenant}/workflows/{workflow}/scheduled
Trigger Workflow Run
scheduled-workflow-run:create 2 params body → 200400403404429
POST
/api/v1/tenants/{tenant}/workflows/{workflow}/crons
Create Cron Job Workflow Trigger
cron-workflow-trigger:create 2 params body → 200400403404429
POST
/api/v1/tenants/{tenant}/workflows/cancel
Cancel Workflow Runs
workflow-run:cancel 1 param body → 200400403
POST
/api/v1/workflows/{workflow}/trigger
Trigger Workflow Run
workflow-run:create 2 params body → 200400403404429
POST
/api/v1/tenants/{tenant}/workflow-runs/replay
Replay Workflow Runs
workflow-run:update:replay 1 param body → 200400403429
GET
/api/v1/tenants/{tenant}/workflow-runs/{workflow-run}/input
Get Workflow Run Input
workflow-run:get:input 2 params → 200400403404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are StepRun (26 properties), WorkflowRun (16 properties), JobRun (16 properties), ScheduledWorkflows (14 properties). Each schema is shown below with its type and property counts.

CronWorkflows
object
12 properties 8 required
CreateCronWorkflowTriggerRequest
object
5 properties 4 required
APIResourceMeta
object
3 properties 3 required
TriggerWorkflowRunRequest
object
2 properties 1 required
WorkflowTriggerCronRef
object
2 properties
Workflow
object
8 properties 3 required
APIError
object
4 properties 1 required
WorkflowVersion
object
14 properties 4 required
JobRunStatus
string
ReplayWorkflowRunsRequest
object
1 property 1 required
ScheduledWorkflowsMethod
string
WorkflowRun
object
16 properties 5 required
WorkflowRunsCancelRequest
object
1 property 1 required
Job
object
7 properties 5 required
ConcurrencySetting
object
5 properties 4 required
ScheduleWorkflowRunRequest
object
4 properties 3 required
StepRunStatus
string
ConcurrencyLimitStrategy
string
ConcurrencyScope
string
APIErrors
object
1 property 1 required
WorkflowTriggerEventRef
object
2 properties
WorkflowRunStatus
string
WorkflowTag
object
2 properties 2 required
WorkflowRunTriggeredBy
object
5 properties 1 required
JobRun
object
16 properties 5 required
Step
object
10 properties 6 required
ReplayWorkflowRunsResponse
object
1 property 1 required
WorkflowConcurrency
object
3 properties 3 required
CronWorkflowsMethod
string
WorkflowVersionMeta
object
5 properties 4 required
StepRun
object
26 properties 5 required
WorkflowTriggers
object
5 properties
ScheduledWorkflows
object
14 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hatchet-workflow-run-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