Hatchet

Hatchet Observability API

The Observability API from Hatchet — 1 operation(s) for observability.

GitHub OpenAPI
Business capability
Observability Management BC-4220.20

Operations 1

GET /api/v1/stable/tenants/{tenant}/traces Get Otel Trace #

Documentation

📖
Documentation
https://docs.hatchet.run/
📖
GettingStarted
https://docs.hatchet.run/home/quickstart
📖
APIReference
https://docs.hatchet.run/
📖
Authentication
https://docs.hatchet.run/
📖
RateLimits
https://artifacts.apis.io/hatchet/rate-limits/hatchet-rate-limits.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hatchet/openapi/hatchet-observability-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/hatchet-dev/hatchet-python-quickstart
💻
CodeExamples
https://github.com/hatchet-dev/hatchet-typescript-quickstart
💻
CodeExamples
https://github.com/hatchet-dev/hatchet-go-quickstart
💻
CodeExamples
https://github.com/hatchet-dev/hatchet-typescript-deep-research
💻
CodeExamples
https://github.com/hatchet-dev/hatchet-typescript-code-agent
💻
CodeExamples
https://github.com/hatchet-dev/hatchet-infra-examples

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/hatchet/json-schema/hatchet-otel-span-list-schema.json

Other Resources

🔗
Examples
https://artifacts.apis.io/hatchet/examples/v1-task-get-example.json
🔗
Examples
https://artifacts.apis.io/hatchet/examples/v1-workflow-run-trigger-example.json
🔗
Examples
https://artifacts.apis.io/hatchet/examples/v1-event-create-example.json
🔗
Examples
https://artifacts.apis.io/hatchet/examples/v1-filter-create-example.json
🔗
Examples
https://artifacts.apis.io/hatchet/examples/v1-task-cancel-example.json
🔗
Examples
https://artifacts.apis.io/hatchet/examples/v1-task-replay-example.json
🔗
Examples
https://artifacts.apis.io/hatchet/examples/v1-log-line-list-example.json
🔗
Examples
https://artifacts.apis.io/hatchet/examples/rate-limit-upsert-example.json
🔗
Examples
https://artifacts.apis.io/hatchet/examples/webhook-worker-create-example.json
🔗
Examples
https://artifacts.apis.io/hatchet/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:hatchet-observability-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

hatchet-observability-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  title: Hatchet Observability API
  description: The Hatchet API
servers:
- url: ''
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: Observability
paths:
  /api/v1/stable/tenants/{tenant}/traces:
    get:
      x-resources:
      - tenant
      description: Get OTel trace for a workflow run
      operationId: v1-observability:get-trace
      parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow run external id
        in: query
        name: run_external_id
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The number of spans to skip
        in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int64
      - description: The number of spans to limit by
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelSpanList'
          description: Successfully retrieved the OTel trace
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
          description: A malformed or bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
          description: Trace not found
      summary: Get Otel Trace
      tags:
      - Observability
components:
  schemas:
    OtelSpan:
      type: object
      properties:
        traceId:
          type: string
        spanId:
          type: string
        parentSpanId:
          type: string
        spanName:
          type: string
        spanKind:
          $ref: '#/components/schemas/OtelSpanKind'
        serviceName:
          type: string
        statusCode:
          $ref: '#/components/schemas/OtelStatusCode'
        statusMessage:
          type: string
        durationNs:
          type: integer
          format: int64
        createdAt:
          type: string
          format: date-time
        resourceAttributes:
          type: object
          additionalProperties:
            type: string
        spanAttributes:
          type: object
          additionalProperties:
            type: string
        scopeName:
          type: string
        scopeVersion:
          type: string
        retryCount:
          type: integer
          format: int32
      required:
      - traceId
      - spanId
      - spanName
      - spanKind
      - serviceName
      - statusCode
      - durationNs
      - createdAt
      - retryCount
    OtelSpanKind:
      type: string
      enum:
      - UNSPECIFIED
      - INTERNAL
      - SERVER
      - CLIENT
      - PRODUCER
      - CONSUMER
    OtelStatusCode:
      type: string
      enum:
      - UNSET
      - OK
      - ERROR
    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
    APIErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/APIError'
      required:
      - errors
    PaginationResponse:
      type: object
      properties:
        current_page:
          type: integer
          description: the current page
          format: int64
          example: 2
        next_page:
          type: integer
          description: the next page
          format: int64
          example: 3
        num_pages:
          type: integer
          description: the total number of pages for listing
          format: int64
          example: 10
      example:
        next_page: 3
        num_pages: 10
        current_page: 2
    OtelSpanList:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/PaginationResponse'
        retryCounts:
          type: array
          items:
            type: integer
            format: int32
        rows:
          type: array
          items:
            $ref: '#/components/schemas/OtelSpan'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    cookieAuth:
      type: apiKey
      in: cookie
      name: hatchet
    customAuth:
      type: http
      scheme: bearer