Create a new online evaluation monitor

Create a new online evaluation monitor

POST /api/v1/monitors

Python

Python

import requests

url = "https://app.langwatch.ai/api/v1/monitors"

payload = {
    "name": "<string>",
    "checkType": "<string>"
}
headers = {
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

201

{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "checkType": "<string>",
  "enabled": true,
  "executionMode": "ON_MESSAGE",
  "sample": 123,
  "level": "<string>",
  "evaluatorId": "<string>",
  "preconditions": "<unknown>",
  "parameters": "<unknown>",
  "mappings": null,
  "threadIdleTimeout": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "autoPausedAt": "<string>",
  "autoPausedReason": "<string>",
  "evaluatorLabel": "<string>",
  "createdById": "<string>",
  "updatedById": "<string>",
  "platformUrl": "<string>"
}

Authorizations

X-Auth-Token · string · header · required

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.

Body

application/json

name · string · required

Minimum string length: 1

checkType · string · required

Minimum string length: 1

executionMode · enum<string> · default: ON_MESSAGE

Available options: ON_MESSAGE, AS_GUARDRAIL, MANUALLY

preconditions · any[]

parameters · object

Show child attributes

mappings · object | null

Show child attributes

sample · number · default: 1

Required range: 0 <= x <= 1

evaluatorId · string

Minimum string length: 1

level · enum<string> · default: trace

Available options: trace, thread

threadIdleTimeout · integer | null

Required range: 0 < x <= 9007199254740991

evaluatorLabel · string | null

Run the evaluator at this deploy label, such as production; null runs the latest.

Required string length: 1 - 64

Response

201 - application/json

Success

id · string · required

name · string · required

slug · string · required

checkType · string · required

enabled · boolean · required

executionMode · enum<string> · required

Available options: ON_MESSAGE, AS_GUARDRAIL, MANUALLY

sample · number · required

level · string · required

evaluatorId · string | null · required

preconditions · any · required

parameters · any · required

mappings · unknown · required

threadIdleTimeout · number | null · required

createdAt · string · required

updatedAt · string · required

autoPausedAt · string | null · required

When the monitor paused itself because its evaluations mostly failed.

autoPausedReason · string | null · required

Why the monitor paused itself.

evaluatorLabel · string | null · required

The evaluator deploy label the monitor runs; null runs the latest version.

createdById · string | null · required

The user who created the monitor, when recorded.

updatedById · string | null · required

The user who changed the monitor last.

platformUrl · string<uri> · required