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 API

The Workflow API from Hatchet — 16 operation(s) for workflow.

Hatchet Workflow 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. 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 22 operations across 16 paths, and defines 58 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.

22 operations 16 paths 58 schemas 3 DELETE14 GET3 PATCH2 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 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 22

Across 16 paths, the API surfaces 22 operations — 3 DELETE, 14 GET, 3 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Workflow 22
GET
/api/v1/tenants/{tenant}/queue-metrics
Get Workflow Metrics
tenant:get:queue-metrics 3 params → 200400403404
GET
/api/v1/tenants/{tenant}/workflows
Get Workflows
workflow:list 4 params → 200400403
GET
/api/v1/tenants/{tenant}/workflows/scheduled
Get Scheduled Workflow Runs
workflow-scheduled:list 10 params → 200400403
GET
/api/v1/tenants/{tenant}/workflows/scheduled/{scheduled-workflow-run}
Get Scheduled Workflow Run
workflow-scheduled:get 2 params → 200400403404
DELETE
/api/v1/tenants/{tenant}/workflows/scheduled/{scheduled-workflow-run}
Delete Scheduled Workflow Run
workflow-scheduled:delete 2 params → 204400403
PATCH
/api/v1/tenants/{tenant}/workflows/scheduled/{scheduled-workflow-run}
Update Scheduled Workflow Run
workflow-scheduled:update 2 params body → 200400403404
POST
/api/v1/tenants/{tenant}/workflows/scheduled/bulk-delete
Bulk Delete Scheduled Workflow Runs
workflow-scheduled:bulk-delete 1 param body → 200400403
POST
/api/v1/tenants/{tenant}/workflows/scheduled/bulk-update
Bulk Update Scheduled Workflow Runs
workflow-scheduled:bulk-update 1 param body → 200400403
GET
/api/v1/tenants/{tenant}/workflows/crons
Get Cron Job Workflows
cron-workflow:list 9 params → 200400403
GET
/api/v1/tenants/{tenant}/workflows/crons/{cron-workflow}
Get Cron Job Workflow Run
workflow-cron:get 2 params → 200400403404
DELETE
/api/v1/tenants/{tenant}/workflows/crons/{cron-workflow}
Delete Cron Job Workflow Run
workflow-cron:delete 2 params → 204400403
PATCH
/api/v1/tenants/{tenant}/workflows/crons/{cron-workflow}
Update Cron Job Workflow Run
workflow-cron:update 2 params body → 204400403
GET
/api/v1/workflows/{workflow}
Get Workflow
workflow:get 1 param → 200400403404
DELETE
/api/v1/workflows/{workflow}
Delete Workflow
workflow:delete 1 param → 204400403404
PATCH
/api/v1/workflows/{workflow}
Update Workflow
workflow:update 1 param body → 200400403
GET
/api/v1/workflows/{workflow}/versions
Get Workflow Version
workflow-version:get 2 params → 200400403404
GET
/api/v1/workflows/{workflow}/metrics
Get Workflow Metrics
workflow:get:metrics 3 params → 200400403404
GET
/api/v1/tenants/{tenant}/workflows/{workflow}/worker-count
Get Workflow Worker Count
workflow:get:workers-count 2 params → 200400403
GET
/api/v1/tenants/{tenant}/workflows/runs
Get Workflow Runs
workflow-run:list 16 params → 200400403
GET
/api/v1/tenants/{tenant}/workflows/runs/metrics
Get Workflow Runs Metrics
workflow-run:get:metrics 8 params → 200400403
GET
/api/v1/tenants/{tenant}/workflow-runs/{workflow-run}
Get Workflow Run
workflow-run:get 2 params → 200400403
GET
/api/v1/tenants/{tenant}/workflow-runs/{workflow-run}/shape
Get Workflow Run
workflow-run:get:shape 2 params → 200400403

Schemas 58

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

ScheduledWorkflowsBulkDeleteFilter
object
4 properties
WorkflowRunsMetricsCounts
object
6 properties
WorkflowRunList
object
2 properties
TenantQueueMetrics
object
3 properties
CronWorkflows
object
12 properties 8 required
ScheduledWorkflowsBulkDeleteRequest
object
2 properties
WorkflowMetrics
object
2 properties
APIResourceMeta
object
3 properties 3 required
WorkflowTriggerCronRef
object
2 properties
Workflow
object
8 properties 3 required
ScheduledRunStatus
string
ScheduledWorkflowsBulkError
object
2 properties 1 required
CronWorkflowsList
object
2 properties
WorkflowUpdateRequest
object
1 property
APIError
object
4 properties 1 required
CronWorkflowsOrderByField
string
WorkflowRunOrderByField
string
PaginationResponse
object
3 properties
WorkflowVersion
object
14 properties 4 required
QueueMetrics
object
3 properties 3 required
JobRunStatus
string
ScheduledWorkflowsMethod
string
ScheduledWorkflowsList
object
2 properties
ScheduledWorkflowsBulkUpdateResponse
object
2 properties 2 required
WorkflowRun
object
16 properties 5 required
UpdateCronWorkflowTriggerRequest
object
1 property
WorkflowKind
string
UpdateScheduledWorkflowRunRequest
object
1 property 1 required
WorkflowWorkersCount
object
3 properties 1 required
Job
object
7 properties 5 required
ConcurrencySetting
object
5 properties 4 required
ScheduledWorkflowsBulkDeleteResponse
object
2 properties 2 required
WorkflowRunOrderByDirection
string
StepRunStatus
string
ConcurrencyLimitStrategy
string
ConcurrencyScope
string
WorkflowRunStatusList
array
APIErrors
object
1 property 1 required
WorkflowID
string
A workflow ID.
WorkflowRunShape
object
17 properties 5 required
WorkflowRunStatus
string
WorkflowTriggerEventRef
object
2 properties
WorkflowTag
object
2 properties 2 required
WorkflowRunTriggeredBy
object
5 properties 1 required
Step
object
10 properties 6 required
JobRun
object
16 properties 5 required
ScheduledWorkflowsOrderByField
string
WorkflowConcurrency
object
3 properties 3 required
WorkflowKindList
array
CronWorkflowsMethod
string
ScheduledWorkflowsBulkUpdateRequest
object
1 property 1 required
WorkflowVersionMeta
object
5 properties 4 required
WorkflowList
object
3 properties
StepRun
object
26 properties 5 required
ScheduledWorkflowsBulkUpdateItem
object
2 properties 2 required
WorkflowTriggers
object
5 properties
ScheduledWorkflows
object
14 properties 7 required
WorkflowRunsMetrics
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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