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-checkup-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: LangWatch Checkup API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
- url: https://app.langwatch.ai
security:
- project_api_key: []
tags:
- name: Checkup
paths:
  /api/v1/checkup:
    get:
      operationId: getApiCheckup
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  ranAt:
                    type: string
                  rows:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          enum:
                          - app
                          - postgres
                          - postgres_migrations
                          - clickhouse
                          - clickhouse_migrations
                          - lwql
                          - redis
                          - gateway
                          - license
                          - connect
                          - usage_report
                          - reach_connect_host
                          - reach_gateway_host
                          - gateway_control_plane
                          - storage
                          - email
                          - model_providers
                          - storage_probe
                          - smtp_verify
                          - model_provider_test
                          - canary_collector
                          - canary_processor
                          - canary_evaluations
                          - canary_scenarios
                          - canary_langy
                        name:
                          type: string
                        group:
                          type: string
                          enum:
                          - install
                          - langwatch
                          - integrations
                          - pipelines
                        cost:
                          type: string
                          enum:
                          - free
                          - egress
                          - paid
                        verdict:
                          oneOf:
                          - type: object
                            properties:
                              outcome:
                                type: string
                                const: verified
                              detail:
                                type: string
                            required:
                            - outcome
                            additionalProperties: false
                          - type: object
                            properties:
                              outcome:
                                type: string
                                const: refused
                              code:
                                type: string
                              detail:
                                type: string
                              fix:
                                type: string
                              docsPath:
                                type: string
                              meta:
                                type: object
                                propertyNames:
                                  type: string
                                additionalProperties: {}
                            required:
                            - outcome
                            additionalProperties: false
                          - type: object
                            properties:
                              outcome:
                                type: string
                                const: unchecked
                              detail:
                                type: string
                              fix:
                                type: string
                              docsPath:
                                type: string
                            required:
                            - outcome
                            additionalProperties: false
                      required:
                      - id
                      - name
                      - group
                      - cost
                      - verdict
                      additionalProperties: false
                  usageReport:
                    type: object
                    properties:
                      payload:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                      switches:
                        type: object
                        properties:
                          optional:
                            type: boolean
                          hostname:
                            type: boolean
                        required:
                        - optional
                        - hostname
                        additionalProperties: false
                      endpoint:
                        type: string
                      disabled:
                        type: boolean
                      schemaVersion:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      nextReportAt:
                        type:
                        - string
                        - 'null'
                    required:
                    - payload
                    - schemaVersion
                    additionalProperties: false
                required:
                - ranAt
                - rows
                - usageReport
                additionalProperties: false
      description: 'The checkup `langwatch doctor` and the Settings > Checkup page show: one row per check with a pass, fail or not checked verdict. A project API key reads the verdicts only; what each check found and how to fix it is shown to install administrators on the Settings > Checkup page. Checks that open a connection or spend money are reported as not checked here and run through `POST /api/checkup/run`. The response also carries the usage figures of the key''s own organization. Answers 404 on LangWatch Cloud.'
      summary: Run the free checks of a self-hosted install
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - organization:view
      tags:
      - Checkup
  /api/v1/checkup/run:
    post:
      operationId: postApiCheckupRun
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  ranAt:
                    type: string
                  rows:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          enum:
                          - app
                          - postgres
                          - postgres_migrations
                          - clickhouse
                          - clickhouse_migrations
                          - lwql
                          - redis
                          - gateway
                          - license
                          - connect
                          - usage_report
                          - reach_connect_host
                          - reach_gateway_host
                          - gateway_control_plane
                          - storage
                          - email
                          - model_providers
                          - storage_probe
                          - smtp_verify
                          - model_provider_test
                          - canary_collector
                          - canary_processor
                          - canary_evaluations
                          - canary_scenarios
                          - canary_langy
                        name:
                          type: string
                        group:
                          type: string
                          enum:
                          - install
                          - langwatch
                          - integrations
                          - pipelines
                        cost:
                          type: string
                          enum:
                          - free
                          - egress
                          - paid
                        verdict:
                          oneOf:
                          - type: object
                            properties:
                              outcome:
                                type: string
                                const: verified
                              detail:
                                type: string
                            required:
                            - outcome
                            additionalProperties: false
                          - type: object
                            properties:
                              outcome:
                                type: string
                                const: refused
                              code:
                                type: string
                              detail:
                                type: string
                              fix:
                                type: string
                              docsPath:
                                type: string
                              meta:
                                type: object
                                propertyNames:
                                  type: string
                                additionalProperties: {}
                            required:
                            - outcome
                            additionalProperties: false
                          - type: object
                            properties:
                              outcome:
                                type: string
                                const: unchecked
                              detail:
                                type: string
                              fix:
                                type: string
                              docsPath:
                                type: string
                            required:
                            - outcome
                            additionalProperties: false
                      required:
                      - id
                      - name
                      - group
                      - cost
                      - verdict
                      additionalProperties: false
                required:
                - ranAt
                - rows
                additionalProperties: false
      description: 'Runs the egress and paid checks of a self-hosted install: reaching the connect and gateway hosts, the storage write, the SMTP connection, one model provider call and the pipeline canaries. Name the checks to run, or leave the list out to run them all. A project API key reads the verdicts only. The scenario canary launches a real run and needs a run plan id. Answers 404 on LangWatch Cloud.'
      summary: Run the checks that open a connection or spend money
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                checks:
                  type: array
                  items:
                    type: string
                    enum:
                    - app
                    - postgres
                    - postgres_migrations
                    - clickhouse
                    - clickhouse_migrations
                    - lwql
                    - redis
                    - gateway
                    - license
                    - connect
                    - usage_report
                    - reach_connect_host
                    - reach_gateway_host
                    - gateway_control_plane
                    - storage
                    - email
                    - model_providers
                    - storage_probe
                    - smtp_verify
                    - model_provider_test
                    - canary_collector
                    - canary_processor
                    - canary_evaluations
                    - canary_scenarios
                    - canary_langy
                scenarioRunPlanId:
                  type: string
                  minLength: 1
                  maxLength: 200
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - organization:manage
      tags:
      - Checkup
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)