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

The Step Run API from Hatchet — 7 operation(s) for step run.

Hatchet Step 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 Step 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 7 operations across 7 paths, and defines 31 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.

7 operations 7 paths 31 schemas 5 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 Step 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 7

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

Step Run 7
GET
/api/v1/step-runs/{step-run}/events
List Events for Step Run
step-run:list:events 3 params → 200400403404
GET
/api/v1/tenants/{tenant}/workflow-runs/{workflow-run}/step-run-events
List Events for All Step Runs for a Workflow Run
workflow-run:list:step-run-events 3 params → 200400403404
GET
/api/v1/step-runs/{step-run}/archives
List Archives for Step Run
step-run:list:archives 3 params → 200400403404
GET
/api/v1/tenants/{tenant}/step-runs/{step-run}
Get Step Run
step-run:get 2 params → 200400403404
POST
/api/v1/tenants/{tenant}/step-runs/{step-run}/rerun
Rerun Step Run
step-run:update:rerun 2 params body → 200400403
POST
/api/v1/tenants/{tenant}/step-runs/{step-run}/cancel
Attempts to Cancel a Step Run
step-run:update:cancel 2 params → 200400403
GET
/api/v1/tenants/{tenant}/step-runs/{step-run}/schema
Get Step Run Schema
step-run:get:schema 2 params → 200400403404

Schemas 31

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

RerunStepRunRequest
object
1 property 1 required
StepRunArchiveList
object
2 properties
APIResourceMeta
object
3 properties 3 required
WorkflowTriggerCronRef
object
2 properties
Workflow
object
8 properties 3 required
APIError
object
4 properties 1 required
StepRunEvent
object
10 properties 7 required
PaginationResponse
object
3 properties
WorkflowVersion
object
14 properties 4 required
JobRunStatus
string
StepRunEventList
object
2 properties
StepRunArchive
object
17 properties 4 required
WorkflowRun
object
16 properties 5 required
StepRunEventReason
string
Job
object
7 properties 5 required
ConcurrencySetting
object
5 properties 4 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
StepRunEventSeverity
string
JobRun
object
16 properties 5 required
Step
object
10 properties 6 required
WorkflowRunTriggeredBy
object
5 properties 1 required
WorkflowConcurrency
object
3 properties 3 required
WorkflowVersionMeta
object
5 properties 4 required
StepRun
object
26 properties 5 required
WorkflowTriggers
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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