Monitors
Update a monitor
PATCH
/
v1
/
monitors
/
{id}
Update a monitor
curl --request PATCH \
--url https://api.veri.studio/v1/monitors/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"evaluator_version": 123,
"sampling_rate": 123,
"filter": {},
"idle_minutes": 123,
"daily_cap": 123,
"enabled": true,
"review_below_confidence": 123,
"review_queue_id": "<string>"
}
'import requests
url = "https://api.veri.studio/v1/monitors/{id}"
payload = {
"name": "<string>",
"evaluator_version": 123,
"sampling_rate": 123,
"filter": {},
"idle_minutes": 123,
"daily_cap": 123,
"enabled": True,
"review_below_confidence": 123,
"review_queue_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
evaluator_version: 123,
sampling_rate: 123,
filter: {},
idle_minutes: 123,
daily_cap: 123,
enabled: true,
review_below_confidence: 123,
review_queue_id: '<string>'
})
};
fetch('https://api.veri.studio/v1/monitors/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"object": "<string>",
"id": "<string>",
"name": "<string>",
"deployment_id": "<string>",
"evaluator_id": "<string>",
"evaluator_name": "<string>",
"scope": "<string>",
"sampling_rate": 123,
"filter": {},
"idle_minutes": 123,
"daily_cap": 123,
"enabled": true,
"stats": {
"scored_today": 123,
"flagged_today": 123,
"scored_7d": 123,
"flagged_7d": 123,
"last_scored_at": "2023-11-07T05:31:56Z",
"human_agreement": {
"n": 123,
"rate": 123
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"evaluator_version": 123,
"review_below_confidence": 123,
"review_queue_id": "<string>"
}Authorizations
API key with the vk_ prefix. Create one from the dashboard.
Path Parameters
Monitor id (mon_...)
Body
application/json
Omitted fields keep their value. The deployment and the evaluator are fixed at create.
A version to pin, or null to track the latest.
{agent?}; null clears it.
Confidence routing; null turns it off (send both, or both null).
Response
The updated monitor
One monitor.
Always "monitor".
mon_...
The deployment whose traffic is scored.
single_turn (scores traced requests) | thread (scores idle threads), from the version the monitor runs.
Share of the traffic scored, 0..1.
{agent?}: only requests or threads sent with this X-Veri-Agent.
Thread monitors: minutes without a request before a thread is scored.
Most targets queued per UTC day.
Show child attributes
Show child attributes
The pinned version; null tracks the latest.
Confidence routing: an ok score whose confidence is below this
(0..1) adds its target to review_queue_id; null = off.
The annotation queue low-confidence targets go to.
Update a monitor
curl --request PATCH \
--url https://api.veri.studio/v1/monitors/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"evaluator_version": 123,
"sampling_rate": 123,
"filter": {},
"idle_minutes": 123,
"daily_cap": 123,
"enabled": true,
"review_below_confidence": 123,
"review_queue_id": "<string>"
}
'import requests
url = "https://api.veri.studio/v1/monitors/{id}"
payload = {
"name": "<string>",
"evaluator_version": 123,
"sampling_rate": 123,
"filter": {},
"idle_minutes": 123,
"daily_cap": 123,
"enabled": True,
"review_below_confidence": 123,
"review_queue_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
evaluator_version: 123,
sampling_rate: 123,
filter: {},
idle_minutes: 123,
daily_cap: 123,
enabled: true,
review_below_confidence: 123,
review_queue_id: '<string>'
})
};
fetch('https://api.veri.studio/v1/monitors/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"object": "<string>",
"id": "<string>",
"name": "<string>",
"deployment_id": "<string>",
"evaluator_id": "<string>",
"evaluator_name": "<string>",
"scope": "<string>",
"sampling_rate": 123,
"filter": {},
"idle_minutes": 123,
"daily_cap": 123,
"enabled": true,
"stats": {
"scored_today": 123,
"flagged_today": 123,
"scored_7d": 123,
"flagged_7d": 123,
"last_scored_at": "2023-11-07T05:31:56Z",
"human_agreement": {
"n": 123,
"rate": 123
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"evaluator_version": 123,
"review_below_confidence": 123,
"review_queue_id": "<string>"
}