Skip to main content
POST
/
api
/
monitors
Python
import requests

url = "https://app.langwatch.ai/api/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)
const options = {
method: 'POST',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', checkType: '<string>'})
};

fetch('https://app.langwatch.ai/api/monitors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
curl --request POST \
--url https://app.langwatch.ai/api/monitors \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"name": "<string>",
"checkType": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "checkType": "<string>",
  "enabled": true,
  "sample": 123,
  "level": "<string>",
  "evaluatorId": "<string>",
  "threadIdleTimeout": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "platformUrl": "<string>",
  "preconditions": "<unknown>",
  "parameters": "<unknown>",
  "mappings": null
}
{
"error": "<string>",
"message": "<string>"
}
{
"error": "<string>",
"message": "<string>"
}
{
"error": "<string>",
"message": "<string>"
}
{
"error": "<string>",
"message": "<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
mappings
object | null
sample
number
default:1
Required range: 0 <= x <= 1
evaluatorId
string
level
enum<string>
default:trace
Available options:
trace,
thread
threadIdleTimeout
integer | null

Response

Monitor created

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
threadIdleTimeout
number | null
required
createdAt
string
required
updatedAt
string
required
platformUrl
string<uri>
required
preconditions
any
parameters
any
mappings
null