Hatchet Metadata API

The Metadata API from Hatchet — 3 operation(s) for metadata.

Operations 3

GET /api/v1/meta Get Metadata #
GET /api/v1/cloud/metadata Get Cloud Metadata #
GET /api/v1/meta/integrations List Integrations #

Documentation

Specifications

Code Examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-task-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-workflow-run-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-filter-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-webhook-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-task-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-v1-log-line-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-tenant-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-worker-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-rate-limit-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-api-token-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/json-schema/hatchet-workflow-schema.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-task-get-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-workflow-run-trigger-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-event-create-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-filter-create-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-task-cancel-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-task-replay-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/v1-log-line-list-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/rate-limit-upsert-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/webhook-worker-create-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/hatchet/refs/heads/main/examples/worker-list-example.json
🔗
SDKs
https://pypi.org/project/hatchet-sdk/
🔗
SDKs
https://www.npmjs.com/package/@hatchet-dev/typescript-sdk
🔗
SDKs
https://github.com/hatchet-dev/hatchet/tree/main/sdks/go
🔗
SDKs
https://github.com/hatchet-dev/hatchet/tree/main/sdks/ruby
🔗
SelfHosting
https://docs.hatchet.run/self-hosting
🔗
SourceCode
https://github.com/hatchet-dev/hatchet

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/hatchet-metadata-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hatchet-metadata-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 1.0.0
  title: Hatchet API Token Metadata API
  description: The Hatchet API
servers:
- url: ''
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: Metadata
paths:
  /api/v1/meta:
    get:
      description: Gets metadata for the Hatchet instance
      operationId: metadata:get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIMeta'
          description: Successfully retrieved the metadata
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
          description: A malformed or bad request
      security: []
      x-security-optional: true
      summary: Get Metadata
      tags:
      - Metadata
  /api/v1/cloud/metadata:
    get:
      description: Gets metadata for the Hatchet cloud instance
      operationId: cloudMetadata::get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
          description: Cloud unavailable
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
          description: A malformed or bad request
      security: []
      x-security-optional: true
      summary: Get Cloud Metadata
      tags:
      - Metadata
  /api/v1/meta/integrations:
    get:
      description: List all integrations
      operationId: metadata:list:integrations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAPIMetaIntegration'
          description: Successfully retrieved the list of integrations
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
          description: A malformed or bad request
      summary: List Integrations
      tags:
      - Metadata
components:
  schemas:
    ListAPIMetaIntegration:
      type: array
      items:
        $ref: '#/components/schemas/APIMetaIntegration'
    APIMetaIntegration:
      type: object
      properties:
        name:
          type: string
          description: the name of the integration
          example: github
        enabled:
          type: boolean
          description: whether this integration is enabled on the instance
      required:
      - name
      - enabled
    APIMeta:
      type: object
      properties:
        auth:
          $ref: '#/components/schemas/APIMetaAuth'
        pylonAppId:
          type: string
          description: the Pylon app ID for usepylon.com chat support
          example: 12345678-1234-1234-1234-123456789012
        posthog:
          $ref: '#/components/schemas/APIMetaPosthog'
        allowSignup:
          type: boolean
          description: whether or not users can sign up for this instance
          example: true
        allowInvites:
          type: boolean
          description: whether or not users can invite other users to this instance
          example: true
        allowCreateTenant:
          type: boolean
          description: whether or not users can create new tenants
          example: true
        allowChangePassword:
          type: boolean
          description: whether or not users can change their password
          example: true
        observabilityEnabled:
          type: boolean
          description: whether or not observability (trace collection) is enabled on this instance
          example: false
    APIMetaAuth:
      type: object
      properties:
        schemes:
          items:
            type: string
          type: array
          description: the supported types of authentication
          example:
          - basic
          - google
    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
    APIMetaPosthog:
      type: object
      properties:
        apiKey:
          type: string
          description: the PostHog API key
          example: phk_1234567890abcdef
        apiHost:
          type: string
          description: the PostHog API host
          example: https://posthog.example.com
    APIErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/APIError'
      required:
      - errors
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    cookieAuth:
      type: apiKey
      in: cookie
      name: hatchet
    customAuth:
      type: http
      scheme: bearer