LangWatch Platform Health API

The Platform Health API from LangWatch — 2 operation(s) for platform health.

Operations 2

GET /api/v1/platform-health Report whether the platform is working #
GET /api/v1/platform-health/{check} Report whether one subsystem is working #

Documentation

Specifications

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/langwatch:langwatch-platform-health-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

langwatch-platform-health-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: LangWatch Platform Health API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
- url: https://app.langwatch.ai
security:
- project_api_key: []
tags:
- name: Platform Health
paths:
  /api/v1/platform-health:
    get:
      operationId: getPlatformHealth
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - healthy
                    - degraded
                    - unhealthy
                  checkedAt:
                    type: string
                  checks:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          enum:
                          - collector
                          - evaluations
                          - processor
                          - triggers
                          - workflows
                        status:
                          type: string
                          enum:
                          - healthy
                          - unhealthy
                          - not_configured
                        durationMs:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        detail:
                          type: string
                      required:
                      - name
                      - status
                      - durationMs
                      additionalProperties: false
                required:
                - status
                - checkedAt
                - checks
                additionalProperties: false
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - healthy
                    - degraded
                    - unhealthy
                  checkedAt:
                    type: string
                  checks:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          enum:
                          - collector
                          - evaluations
                          - processor
                          - triggers
                          - workflows
                        status:
                          type: string
                          enum:
                          - healthy
                          - unhealthy
                          - not_configured
                        durationMs:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        detail:
                          type: string
                      required:
                      - name
                      - status
                      - durationMs
                      additionalProperties: false
                required:
                - status
                - checkedAt
                - checks
                additionalProperties: false
      description: 'An external monitor reads a status and a report: 200 healthy or degraded, 503 unhealthy, 401 unauthorized and 404 for a subsystem this platform does not have.'
      summary: Report whether the platform is working
      security:
      - internal_secret: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - internal_secret
        permissions: []
      parameters:
      - in: query
        name: triggerId
        schema:
          type: string
      - in: query
        name: workflowId
        schema:
          type: string
      tags:
      - Platform Health
  /api/v1/platform-health/{check}:
    get:
      operationId: getPlatformHealthSubsystem
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - healthy
                    - degraded
                    - unhealthy
                  checkedAt:
                    type: string
                  checks:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          enum:
                          - collector
                          - evaluations
                          - processor
                          - triggers
                          - workflows
                        status:
                          type: string
                          enum:
                          - healthy
                          - unhealthy
                          - not_configured
                        durationMs:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        detail:
                          type: string
                      required:
                      - name
                      - status
                      - durationMs
                      additionalProperties: false
                required:
                - status
                - checkedAt
                - checks
                additionalProperties: false
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - healthy
                    - degraded
                    - unhealthy
                  checkedAt:
                    type: string
                  checks:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          enum:
                          - collector
                          - evaluations
                          - processor
                          - triggers
                          - workflows
                        status:
                          type: string
                          enum:
                          - healthy
                          - unhealthy
                          - not_configured
                        durationMs:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        detail:
                          type: string
                      required:
                      - name
                      - status
                      - durationMs
                      additionalProperties: false
                required:
                - status
                - checkedAt
                - checks
                additionalProperties: false
      description: 'An external monitor reads a status and a report: 200 healthy or degraded, 503 unhealthy, 401 unauthorized and 404 for a subsystem this platform does not have.'
      summary: Report whether one subsystem is working
      security:
      - internal_secret: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - internal_secret
        permissions: []
      parameters:
      - in: path
        name: check
        schema:
          type: string
        required: true
      - in: query
        name: triggerId
        schema:
          type: string
      - in: query
        name: workflowId
        schema:
          type: string
      tags:
      - Platform Health
components:
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: 'Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.'
    admin_api_key:
      type: http
      scheme: bearer
      description: 'Admin API key for organization-level operations (managing projects, API keys). Create one in Settings > API Keys or via POST /api/api-keys. Format: sk-lw-{id}_{secret}.'
    scim_bearer:
      type: http
      scheme: bearer
      description: SCIM token for one organization's directory connection, created with POST /api/scim-tokens or in Settings > SCIM. It authenticates provisioning calls only, and stops working if the organization's Enterprise plan lapses.
    cli_access_token:
      type: http
      scheme: bearer
      description: The device session the LangWatch CLI holds after `langwatch login`. It acts as the person who signed in, in the organization they chose, and expires unless the CLI refreshes it.
    instance_admin_key:
      type: http
      scheme: bearer
      description: Instance administrator key, set as LANGWATCH_INSTANCE_ADMIN_API_KEY on a self-hosted deployment. It exists to create the first organization, before any organization key does; every other management API takes an organization key instead.
    internal_secret:
      type: http
      scheme: bearer
      description: The deployment's own shared secret, presented by another LangWatch service rather than by a customer. The families behind it are ingress-blocked; they are described so a self-hosted operator can see what the deployment talks to itself about.
x-provenance:
  method: harvested
  publisher: LangWatch
  source: https://app.langwatch.ai/api/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)