Hatchet

Hatchet Healthcheck API

The Healthcheck API from Hatchet — 2 operation(s) for healthcheck.

Documentation GitHub OpenAPI

Documentation

https://docs.hatchet.run/

https://docs.hatchet.run/home/quickstart

https://docs.hatchet.run/

https://docs.hatchet.run/

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/rate-limits/hatchet-rate-limits.yml

Specifications

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/openapi/hatchet-healthcheck-api-openapi.yml

Code Examples

https://github.com/hatchet-dev/hatchet-python-quickstart

https://github.com/hatchet-dev/hatchet-typescript-quickstart

https://github.com/hatchet-dev/hatchet-go-quickstart

https://github.com/hatchet-dev/hatchet-typescript-deep-research

https://github.com/hatchet-dev/hatchet-typescript-code-agent

https://github.com/hatchet-dev/hatchet-infra-examples

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-task-schema.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-workflow-run-schema.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-event-schema.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-filter-schema.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-webhook-schema.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-task-event-schema.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-log-line-schema.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-tenant-schema.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-worker-schema.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-rate-limit-schema.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-api-token-schema.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-workflow-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-task-get-example.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-workflow-run-trigger-example.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-event-create-example.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-filter-create-example.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-task-cancel-example.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-task-replay-example.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-log-line-list-example.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/rate-limit-upsert-example.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/webhook-worker-create-example.json

https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/worker-list-example.json

https://pypi.org/project/hatchet-sdk/

https://www.npmjs.com/package/@hatchet-dev/typescript-sdk

https://github.com/hatchet-dev/hatchet/tree/main/sdks/go

https://github.com/hatchet-dev/hatchet/tree/main/sdks/ruby

https://docs.hatchet.run/self-hosting

https://github.com/hatchet-dev/hatchet

OpenAPI Specification

openapi: 3.1.0
info:
  version: 1.0.0
  title: Hatchet API Token Healthcheck API
  description: The Hatchet API
servers:
- url: ''
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: Healthcheck
paths:
  /api/ready:
    get:
      description: Gets the readiness status
      operationId: readiness:get
      responses:
        '200':
          description: Healthy
        '500':
          description: Not ready to accept traffic
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
      security: []
      summary: Get Readiness
      tags:
      - Healthcheck
  /api/live:
    get:
      description: Gets the liveness status
      operationId: liveness:get
      responses:
        '200':
          description: Healthy
        '500':
          description: Not liveness
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
      security: []
      summary: Get Liveness
      tags:
      - Healthcheck
components:
  schemas:
    APIErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/APIError'
      required:
      - errors
    APIError:
      type: object
      properties:
        code:
          type: integer
          description: a custom Hatchet error code
          format: uint64
          example: 1400
        field:
          type: string
          description: the field that this error is associated with, if applicable
          example: name
        description:
          type: string
          description: a description for this error
          example: A descriptive error message
        docs_link:
          type: string
          description: a link to the documentation for this error, if it exists
          example: github.com/hatchet-dev/hatchet
      required:
      - description
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    cookieAuth:
      type: apiKey
      in: cookie
      name: hatchet
    customAuth:
      type: http
      scheme: bearer