LangWatch Monitors API

openapi: 3.2.0
info:
  title: LangWatch Monitors API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
- url: https://app.langwatch.ai
security:
- project_api_key: []
tags:
- name: Monitors
paths:
  /api/v1/monitors:
    get:
      operationId: getApiMonitors
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    slug:
                      type: string
                    checkType:
                      type: string
                    enabled:
                      type: boolean
                    executionMode:
                      type: string
                      enum:
                      - ON_MESSAGE
                      - AS_GUARDRAIL
                      - MANUALLY
                    sample:
                      type: number
                    level:
                      type: string
                    evaluatorId:
                      type:
                      - string
                      - 'null'
                    preconditions: {}
                    parameters: {}
                    mappings:
                      anyOf:
                      - {}
                      - type: 'null'
                    threadIdleTimeout:
                      type:
                      - number
                      - 'null'
                    createdAt:
                      type: string
                    updatedAt:
                      type: string
                    platformUrl:
                      type: string
                      format: uri
                  required:
                  - id
                  - name
                  - slug
                  - checkType
                  - enabled
                  - executionMode
                  - sample
                  - level
                  - evaluatorId
                  - preconditions
                  - parameters
                  - mappings
                  - threadIdleTimeout
                  - createdAt
                  - updatedAt
                  - platformUrl
                  additionalProperties: false
      description: List all online evaluation monitors for the project
      tags:
      - Monitors
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - evaluations:view
      summary: Get api monitors
      x-summary-source: derived
    post:
      operationId: postApiMonitors
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  slug:
                    type: string
                  checkType:
                    type: string
                  enabled:
                    type: boolean
                  executionMode:
                    type: string
                    enum:
                    - ON_MESSAGE
                    - AS_GUARDRAIL
                    - MANUALLY
                  sample:
                    type: number
                  level:
                    type: string
                  evaluatorId:
                    type:
                    - string
                    - 'null'
                  preconditions: {}
                  parameters: {}
                  mappings:
                    anyOf:
                    - {}
                    - type: 'null'
                  threadIdleTimeout:
                    type:
                    - number
                    - 'null'
                  createdAt:
                    type: string
                  updatedAt:
                    type: string
                  platformUrl:
                    type: string
                    format: uri
                required:
                - id
                - name
                - slug
                - checkType
                - enabled
                - executionMode
                - sample
                - level
                - evaluatorId
                - preconditions
                - parameters
                - mappings
                - threadIdleTimeout
                - createdAt
                - updatedAt
                - platformUrl
                additionalProperties: false
      description: Create a new online evaluation monitor
      tags:
      - Monitors
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - evaluations:create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                checkType:
                  type: string
                  minLength: 1
                executionMode:
                  default: ON_MESSAGE
                  type: string
                  enum:
                  - ON_MESSAGE
                  - AS_GUARDRAIL
                  - MANUALLY
                preconditions:
                  default: []
                  type: array
                  items: {}
                parameters:
                  default: {}
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    $ref: '#/components/schemas/JsonValue'
                mappings:
                  anyOf:
                  - type: object
                    properties:
                      mapping:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                      expansions:
                        type: array
                        items:
                          type: string
                    required:
                    - mapping
                    - expansions
                  - type: 'null'
                sample:
                  default: 1
                  type: number
                  minimum: 0
                  maximum: 1
                evaluatorId:
                  type: string
                  minLength: 1
                level:
                  default: trace
                  type: string
                  enum:
                  - trace
                  - thread
                threadIdleTimeout:
                  anyOf:
                  - type: integer
                    exclusiveMinimum: 0
                    maximum: 9007199254740991
                  - type: 'null'
              required:
              - name
              - checkType
      summary: Post api monitors
      x-summary-source: derived
  /api/v1/monitors/{id}:
    get:
      operationId: getApiMonitorsById
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  slug:
                    type: string
                  checkType:
                    type: string
                  enabled:
                    type: boolean
                  executionMode:
                    type: string
                    enum:
                    - ON_MESSAGE
                    - AS_GUARDRAIL
                    - MANUALLY
                  sample:
                    type: number
                  level:
                    type: string
                  evaluatorId:
                    type:
                    - string
                    - 'null'
                  preconditions: {}
                  parameters: {}
                  mappings:
                    anyOf:
                    - {}
                    - type: 'null'
                  threadIdleTimeout:
                    type:
                    - number
                    - 'null'
                  createdAt:
                    type: string
                  updatedAt:
                    type: string
                  platformUrl:
                    type: string
                    format: uri
                required:
                - id
                - name
                - slug
                - checkType
                - enabled
                - executionMode
                - sample
                - level
                - evaluatorId
                - preconditions
                - parameters
                - mappings
                - threadIdleTimeout
                - createdAt
                - updatedAt
                - platformUrl
                additionalProperties: false
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
                additionalProperties: false
      description: Get a monitor by its ID
      tags:
      - Monitors
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - evaluations:view
      parameters:
      - in: path
        name: id
        schema:
          type: string
          minLength: 1
        required: true
        description: The monitor id.
      summary: Get api monitors by id
      x-summary-source: derived
    patch:
      operationId: patchApiMonitorsById
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  slug:
                    type: string
                  checkType:
                    type: string
                  enabled:
                    type: boolean
                  executionMode:
                    type: string
                    enum:
                    - ON_MESSAGE
                    - AS_GUARDRAIL
                    - MANUALLY
                  sample:
                    type: number
                  level:
                    type: string
                  evaluatorId:
                    type:
                    - string
                    - 'null'
                  preconditions: {}
                  parameters: {}
                  mappings:
                    anyOf:
                    - {}
                    - type: 'null'
                  threadIdleTimeout:
                    type:
                    - number
                    - 'null'
                  createdAt:
                    type: string
                  updatedAt:
                    type: string
                  platformUrl:
                    type: string
                    format: uri
                required:
                - id
                - name
                - slug
                - checkType
                - enabled
                - executionMode
                - sample
                - level
                - evaluatorId
                - preconditions
                - parameters
                - mappings
                - threadIdleTimeout
                - createdAt
                - updatedAt
                - platformUrl
                additionalProperties: false
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
                additionalProperties: false
      description: Update a monitor (name, enabled state, settings, etc.)
      tags:
      - Monitors
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                enabled:
                  type: boolean
                checkType:
                  type: string
                executionMode:
                  type: string
                  enum:
                  - ON_MESSAGE
                  - AS_GUARDRAIL
                  - MANUALLY
                preconditions:
                  type: array
                  items: {}
                parameters:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties:
                    $ref: '#/components/schemas/JsonValue'
                mappings:
                  anyOf:
                  - type: object
                    properties:
                      mapping:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                      expansions:
                        type: array
                        items:
                          type: string
                    required:
                    - mapping
                    - expansions
                  - type: 'null'
                sample:
                  type: number
                  minimum: 0
                  maximum: 1
                evaluatorId:
                  anyOf:
                  - type: string
                    minLength: 1
                  - type: 'null'
                level:
                  type: string
                  enum:
                  - trace
                  - thread
                threadIdleTimeout:
                  anyOf:
                  - type: integer
                    exclusiveMinimum: 0
                    maximum: 9007199254740991
                  - type: 'null'
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - evaluations:update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          minLength: 1
        required: true
        description: The monitor id.
      summary: Patch api monitors by id
      x-summary-source: derived
    delete:
      operationId: deleteApiMonitorsById
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  deleted:
                    type: boolean
                required:
                - id
                - deleted
                additionalProperties: false
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
                additionalProperties: false
      description: Delete a monitor
      tags:
      - Monitors
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - evaluations:manage
      parameters:
      - in: path
        name: id
        schema:
          type: string
          minLength: 1
        required: true
        description: The monitor id.
      summary: Delete api monitors by id
      x-summary-source: derived
  /api/v1/monitors/{id}/toggle:
    post:
      operationId: postApiMonitorsByIdToggle
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  enabled:
                    type: boolean
                required:
                - id
                - enabled
                additionalProperties: false
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                - error
                additionalProperties: false
      description: Enable or disable a monitor
      tags:
      - Monitors
      security:
      - project_api_key: []
      x-access-policy:
        kind: handlerManaged
        credential:
        - project_api_key
        permissions:
        - evaluations:update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          minLength: 1
        required: true
        description: The monitor id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
              required:
              - enabled
      summary: Post api monitors by id toggle
      x-summary-source: derived
components:
  schemas:
    JsonValue:
      anyOf:
      - type: string
      - type: number
      - type: boolean
      - type: 'null'
      - type: array
        items:
          $ref: '#/components/schemas/JsonValue'
      - type: object
        propertyNames:
          type: string
        additionalProperties:
          $ref: '#/components/schemas/JsonValue'
  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)