Create Alert Definition

curl --request POST \
  --url https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "window_ms": 123,
  "recipients": [
    "jsmith@example.com"
  ],
  "notification_channels": [],
  "condition_tree": {
    "children": [
      {
        "lhs": "<string>",
        "type": "predicate",
        "id": "<string>",
        "rhs": "<unknown>"
      }
    ],
    "type": "group",
    "id": "<string>"
  },
  "description": "<string>",
  "severity": "info",
  "state": "active",
  "cooldown_ms": 900000,
  "threshold_n": 1,
  "threshold_type": "count",
  "threshold_percentage": 50,
  "threshold_minimum": 1
}
'

import requests

url = "https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions"

payload = {
    "name": "<string>",
    "window_ms": 123,
    "recipients": ["jsmith@example.com"],
    "notification_channels": [],
    "condition_tree": {
        "children": [
            {
                "lhs": "<string>",
                "type": "predicate",
                "id": "<string>",
                "rhs": "<unknown>"
            }
        ],
        "type": "group",
        "id": "<string>"
    },
    "description": "<string>",
    "severity": "info",
    "state": "active",
    "cooldown_ms": 900000,
    "threshold_n": 1,
    "threshold_type": "count",
    "threshold_percentage": 50,
    "threshold_minimum": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    window_ms: 123,
    recipients: ['jsmith@example.com'],
    notification_channels: [],
    condition_tree: {
      children: [{lhs: '<string>', type: 'predicate', id: '<string>', rhs: '<unknown>'}],
      type: 'group',
      id: '<string>'
    },
    description: '<string>',
    severity: 'info',
    state: 'active',
    cooldown_ms: 900000,
    threshold_n: 1,
    threshold_type: 'count',
    threshold_percentage: 50,
    threshold_minimum: 1
  })
};

fetch('https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'window_ms' => 123,
    'recipients' => [
        'jsmith@example.com'
    ],
    'notification_channels' => [
        
    ],
    'condition_tree' => [
        'children' => [
                [
                                'lhs' => '<string>',
                                'type' => 'predicate',
                                'id' => '<string>',
                                'rhs' => '<unknown>'
                ]
        ],
        'type' => 'group',
        'id' => '<string>'
    ],
    'description' => '<string>',
    'severity' => 'info',
    'state' => 'active',
    'cooldown_ms' => 900000,
    'threshold_n' => 1,
    'threshold_type' => 'count',
    'threshold_percentage' => 50,
    'threshold_minimum' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"window_ms\": 123,\n  \"recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"notification_channels\": [],\n  \"condition_tree\": {\n    \"children\": [\n      {\n        \"lhs\": \"<string>\",\n        \"type\": \"predicate\",\n        \"id\": \"<string>\",\n        \"rhs\": \"<unknown>\"\n      }\n    ],\n    \"type\": \"group\",\n    \"id\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"severity\": \"info\",\n  \"state\": \"active\",\n  \"cooldown_ms\": 900000,\n  \"threshold_n\": 1,\n  \"threshold_type\": \"count\",\n  \"threshold_percentage\": 50,\n  \"threshold_minimum\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"window_ms\": 123,\n  \"recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"notification_channels\": [],\n  \"condition_tree\": {\n    \"children\": [\n      {\n        \"lhs\": \"<string>\",\n        \"type\": \"predicate\",\n        \"id\": \"<string>\",\n        \"rhs\": \"<unknown>\"\n      }\n    ],\n    \"type\": \"group\",\n    \"id\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"severity\": \"info\",\n  \"state\": \"active\",\n  \"cooldown_ms\": 900000,\n  \"threshold_n\": 1,\n  \"threshold_type\": \"count\",\n  \"threshold_percentage\": 50,\n  \"threshold_minimum\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"window_ms\": 123,\n  \"recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"notification_channels\": [],\n  \"condition_tree\": {\n    \"children\": [\n      {\n        \"lhs\": \"<string>\",\n        \"type\": \"predicate\",\n        \"id\": \"<string>\",\n        \"rhs\": \"<unknown>\"\n      }\n    ],\n    \"type\": \"group\",\n    \"id\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"severity\": \"info\",\n  \"state\": \"active\",\n  \"cooldown_ms\": 900000,\n  \"threshold_n\": 1,\n  \"threshold_type\": \"count\",\n  \"threshold_percentage\": 50,\n  \"threshold_minimum\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "agent_id": 123,
  "name": "<string>",
  "severity": "<string>",
  "state": "<string>",
  "window_ms": 123,
  "cooldown_ms": 123,
  "recipients": [
    "<string>"
  ],
  "notification_channels": [
    "<string>"
  ],
  "condition_tree": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "threshold_type": "count",
  "threshold_n": 123,
  "threshold_percentage": 20,
  "threshold_minimum": 10,
  "last_triggered": "2026-07-31T14:05:12Z",
  "created_by": 123,
  "updated_by": 123
}

{
  "detail": "Not authenticated"
}

{
  "detail": "User does not have access to workspace 42"
}

{
  "detail": "Agent with ID 17 not found"
}

{
  "detail": "Agent has no webhook URL configured. Add one in Agent Settings > Webhooks before enabling webhook alerts."
}

Agent Settings

Create Alert Definition

Create a new alert definition for an agent.

An alert fires when its condition matches enough calls within a rolling window. threshold_type decides which threshold fields are required: count needs threshold_n, percentage needs both threshold_percentage and threshold_minimum.

condition_tree must have a group at its root and contain at least one predicate. With percentage, the tree is limited to a single predicate.

Selecting webhook in notification_channels requires the agent to have a webhook URL configured.

POST

api

workspaces

{workspace_id}

agents

{agent_id}

settings

alert-definitions

Create Alert Definition

curl --request POST \
  --url https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "window_ms": 123,
  "recipients": [
    "jsmith@example.com"
  ],
  "notification_channels": [],
  "condition_tree": {
    "children": [
      {
        "lhs": "<string>",
        "type": "predicate",
        "id": "<string>",
        "rhs": "<unknown>"
      }
    ],
    "type": "group",
    "id": "<string>"
  },
  "description": "<string>",
  "severity": "info",
  "state": "active",
  "cooldown_ms": 900000,
  "threshold_n": 1,
  "threshold_type": "count",
  "threshold_percentage": 50,
  "threshold_minimum": 1
}
'

import requests

url = "https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions"

payload = {
    "name": "<string>",
    "window_ms": 123,
    "recipients": ["jsmith@example.com"],
    "notification_channels": [],
    "condition_tree": {
        "children": [
            {
                "lhs": "<string>",
                "type": "predicate",
                "id": "<string>",
                "rhs": "<unknown>"
            }
        ],
        "type": "group",
        "id": "<string>"
    },
    "description": "<string>",
    "severity": "info",
    "state": "active",
    "cooldown_ms": 900000,
    "threshold_n": 1,
    "threshold_type": "count",
    "threshold_percentage": 50,
    "threshold_minimum": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    window_ms: 123,
    recipients: ['jsmith@example.com'],
    notification_channels: [],
    condition_tree: {
      children: [{lhs: '<string>', type: 'predicate', id: '<string>', rhs: '<unknown>'}],
      type: 'group',
      id: '<string>'
    },
    description: '<string>',
    severity: 'info',
    state: 'active',
    cooldown_ms: 900000,
    threshold_n: 1,
    threshold_type: 'count',
    threshold_percentage: 50,
    threshold_minimum: 1
  })
};

fetch('https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'window_ms' => 123,
    'recipients' => [
        'jsmith@example.com'
    ],
    'notification_channels' => [
        
    ],
    'condition_tree' => [
        'children' => [
                [
                                'lhs' => '<string>',
                                'type' => 'predicate',
                                'id' => '<string>',
                                'rhs' => '<unknown>'
                ]
        ],
        'type' => 'group',
        'id' => '<string>'
    ],
    'description' => '<string>',
    'severity' => 'info',
    'state' => 'active',
    'cooldown_ms' => 900000,
    'threshold_n' => 1,
    'threshold_type' => 'count',
    'threshold_percentage' => 50,
    'threshold_minimum' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"window_ms\": 123,\n  \"recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"notification_channels\": [],\n  \"condition_tree\": {\n    \"children\": [\n      {\n        \"lhs\": \"<string>\",\n        \"type\": \"predicate\",\n        \"id\": \"<string>\",\n        \"rhs\": \"<unknown>\"\n      }\n    ],\n    \"type\": \"group\",\n    \"id\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"severity\": \"info\",\n  \"state\": \"active\",\n  \"cooldown_ms\": 900000,\n  \"threshold_n\": 1,\n  \"threshold_type\": \"count\",\n  \"threshold_percentage\": 50,\n  \"threshold_minimum\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"window_ms\": 123,\n  \"recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"notification_channels\": [],\n  \"condition_tree\": {\n    \"children\": [\n      {\n        \"lhs\": \"<string>\",\n        \"type\": \"predicate\",\n        \"id\": \"<string>\",\n        \"rhs\": \"<unknown>\"\n      }\n    ],\n    \"type\": \"group\",\n    \"id\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"severity\": \"info\",\n  \"state\": \"active\",\n  \"cooldown_ms\": 900000,\n  \"threshold_n\": 1,\n  \"threshold_type\": \"count\",\n  \"threshold_percentage\": 50,\n  \"threshold_minimum\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usetuner.ai/api/v1/workspaces/{workspace_id}/agents/{agent_id}/settings/alert-definitions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"window_ms\": 123,\n  \"recipients\": [\n    \"jsmith@example.com\"\n  ],\n  \"notification_channels\": [],\n  \"condition_tree\": {\n    \"children\": [\n      {\n        \"lhs\": \"<string>\",\n        \"type\": \"predicate\",\n        \"id\": \"<string>\",\n        \"rhs\": \"<unknown>\"\n      }\n    ],\n    \"type\": \"group\",\n    \"id\": \"<string>\"\n  },\n  \"description\": \"<string>\",\n  \"severity\": \"info\",\n  \"state\": \"active\",\n  \"cooldown_ms\": 900000,\n  \"threshold_n\": 1,\n  \"threshold_type\": \"count\",\n  \"threshold_percentage\": 50,\n  \"threshold_minimum\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "agent_id": 123,
  "name": "<string>",
  "severity": "<string>",
  "state": "<string>",
  "window_ms": 123,
  "cooldown_ms": 123,
  "recipients": [
    "<string>"
  ],
  "notification_channels": [
    "<string>"
  ],
  "condition_tree": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "threshold_type": "count",
  "threshold_n": 123,
  "threshold_percentage": 20,
  "threshold_minimum": 10,
  "last_triggered": "2026-07-31T14:05:12Z",
  "created_by": 123,
  "updated_by": 123
}

{
  "detail": "Not authenticated"
}

{
  "detail": "User does not have access to workspace 42"
}

{
  "detail": "Agent with ID 17 not found"
}

{
  "detail": "Agent has no webhook URL configured. Add one in Agent Settings > Webhooks before enabling webhook alerts."
}

Authorizations

Authorization

string

header

required

Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.

Path Parameters

agent_id

integer

required

Tuner's internal numeric ID for the agent.

workspace_id

integer

required

Workspace ID. Find this in Workspace > General Settings.

Body

application/json

Schema for creating an alert definition.

name

string

required

Alert name

Required string length: 1 - 200

window_ms

integer

required

Rolling time window in milliseconds (e.g. 300000 for 5 minutes). Client must send ms; frontend converts from seconds/minutes for UX.

recipients

string<email>[]

required

List of email recipients

Minimum array length: 1

notification_channels

enum<string>[]

required

Channels to notify on: email and/or webhook

Minimum array length: 1

Notification channels available for alert definitions.

Available options:

email,

webhook

condition_tree

ConditionTreeGroup · object

required

Condition tree (root must always be a group node, even for single conditions)

Show child attributes

description

string | null

Optional alert description

severity

enum<string>

default:info

Alert severity level

Available options:

info,

warning,

critical

state

enum<string>

default:active

Alert state (active or paused)

Available options:

active,

paused

cooldown_ms

integer

default:900000

Cooldown period in milliseconds (e.g. 900000 for 15 minutes). Client must send ms; frontend converts for UX.

threshold_n

integer | null

Number of qualifying calls to trigger alert. Required when threshold_type='count'.

Required range: x > 0

threshold_type

enum<string>

default:count

Threshold mode: 'count' (absolute) or 'percentage' (ratio of evaluated calls)

Available options:

count,

percentage

threshold_percentage

number | null

Required when threshold_type='percentage': percentage threshold (0 < x <= 100)

Required range: 0 < x <= 100

threshold_minimum

integer | null

Required when threshold_type='percentage': minimum qualifying calls before alert fires (hard gate)

Required range: x > 0

Response

Successful Response

Response schema for an alert definition.

integer

required

Tuner's ID for this alert definition.

Example:

4

agent_id

integer

required

Agent this alert belongs to.

Example:

17

name

string

required

Display name, used in notifications.

Example:

"High red-flag rate"

severity

string

required

Severity label included in notifications.

Example:

"warning"

state

string

required

active when the alert can fire, paused when it can't.

Example:

"active"

window_ms

integer

required

Rolling window in milliseconds. 300000 is five minutes.

Example:

300000

cooldown_ms

integer

required

Minimum time in milliseconds before this alert can fire again.

Example:

900000

recipients

string[]

required

Email addresses notified when the alert fires.

Example:

["oncall@acme.com"]

notification_channels

string[]

required

Where notifications are sent.

Example:

["email"]

condition_tree

Condition Tree · object

required

Condition a call must match to count toward the threshold.

Example:

{
  "children": [
    {
      "lhs": "eval.12",
      "op": "eq",
      "rhs": "FAIL",
      "type": "predicate"
    }
  ],
  "op": "AND",
  "type": "group"
}

created_at

string<date-time>

required

When the alert was created.

Example:

"2026-07-14T09:22:31Z"

updated_at

string<date-time>

required

When the alert was last updated.

Example:

"2026-07-20T11:40:08Z"

description

string | null

Note explaining what this alert watches for.

threshold_type

string

default:count

count fires on an absolute number of matching calls, percentage on a share of the calls evaluated in the window.

Example:

"percentage"

threshold_n

integer | null

Matching calls needed to fire. Set in count mode.

threshold_percentage

number | null

Share of evaluated calls needed to fire. Set in percentage mode.

Example:

20

threshold_minimum

integer | null

Minimum matching calls before the percentage is applied. Set in percentage mode.

Example:

10

last_triggered

string<date-time> | null

When this alert last fired. Null if it never has.

Example:

"2026-07-31T14:05:12Z"

created_by

integer | null

User who created the alert.

updated_by

integer | null

User who last updated it.

⌘I