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

The Task API from Hatchet — 8 operation(s) for task.

Hatchet Task 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 Task. 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 8 operations across 8 paths, and defines 22 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.

8 operations 8 paths 22 schemas 5 GET3 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 Task 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 8

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

Task 8
GET
/api/v1/stable/tasks/{task}
Get a Task
v1-task:get 2 params → 200400403404501
GET
/api/v1/stable/tasks/{task}/task-events
List Events for a Task
v1-task-event:list 3 params → 200400403404501
POST
/api/v1/stable/tenants/{tenant}/tasks/cancel
Cancel Tasks
v1-task:cancel 1 param body → 200400403404501
POST
/api/v1/stable/tenants/{tenant}/tasks/replay
Replay Tasks
v1-task:replay 1 param body → 200400403404501
POST
/api/v1/stable/tasks/{task}/restore
Restore a Task
v1-task:restore 1 param → 200400403404
GET
/api/v1/stable/dags/tasks
List Tasks
v1-dag:list:tasks 2 params → 200400403501
GET
/api/v1/stable/tenants/{tenant}/task-metrics
Get Task Metrics
v1-task:list:status-metrics 7 params → 200400403501
GET
/api/v1/stable/tenants/{tenant}/task-point-metrics
Get Task Point Metrics
v1-task:get:point-metrics 3 params → 200400403501

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are V1TaskSummary (30 properties), V1TaskEvent (11 properties), V1TaskFilter (5 properties), APIError (4 properties). Each schema is shown below with its type and property counts.

V1ReplayTaskRequest
object
2 properties
V1TaskEventType
string
V1TaskRunMetric
object
3 properties 2 required
APIResourceMeta
object
3 properties 3 required
V1TaskRunMetrics
array
V1TaskPointMetric
object
3 properties 3 required
V1WorkflowType
string
APIError
object
4 properties 1 required
PaginationResponse
object
3 properties
V1TaskFilter
object
5 properties 1 required
V1ReplayedTasks
object
1 property
V1TaskEvent
object
11 properties 5 required
V1TaskPointMetrics
object
1 property
V1DagChildren
object
2 properties
V1CancelledTasks
object
1 property
V1TaskSummary
object
30 properties 15 required
V1TaskEventList
object
2 properties
APIErrors
object
1 property 1 required
V1RestoreTaskResponse
object
1 property 1 required
V1CancelTaskRequest
object
2 properties
V1RunningDetailCount
object
2 properties 2 required
V1TaskStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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