For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • GETFind alerts
        • POSTCreate alert
        • POSTDelete alert batch
        • GETGet Alert by id
        • PUTUpdate alert
        • GETGet webhook payload examples
        • POSTTest alert webhook
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceAlerts

Get Alert by id

GET
/v1/private/alerts/:id
GET
/api/v1/private/alerts/:id
$curl http://localhost:5173/api/v1/private/alerts/id
1{
2  "webhook": {
3    "url": "string",
4    "id": "string",
5    "name": "string",
6    "secret_token": "string",
7    "headers": {},
8    "created_at": "2024-01-15T09:30:00Z",
9    "created_by": "string",
10    "last_updated_at": "2024-01-15T09:30:00Z",
11    "last_updated_by": "string"
12  },
13  "id": "string",
14  "name": "string",
15  "enabled": true,
16  "alert_type": "general",
17  "metadata": {},
18  "triggers": [
19    {
20      "event_type": "trace:errors",
21      "id": "string",
22      "alert_id": "string",
23      "trigger_configs": [
24        {
25          "type": "scope:project",
26          "id": "string",
27          "alert_trigger_id": "string",
28          "config_value": {},
29          "group_index": 1,
30          "created_at": "2024-01-15T09:30:00Z",
31          "created_by": "string",
32          "last_updated_at": "2024-01-15T09:30:00Z",
33          "last_updated_by": "string"
34        }
35      ],
36      "created_at": "2024-01-15T09:30:00Z",
37      "created_by": "string"
38    }
39  ],
40  "created_at": "2024-01-15T09:30:00Z",
41  "created_by": "string",
42  "last_updated_at": "2024-01-15T09:30:00Z",
43  "last_updated_by": "string",
44  "project_id": "string"
45}
Get Alert by id
Was this page helpful?
Previous

Update alert

Next
Built with

Path parameters

idstringRequiredformat: "uuid"

Response

Alert resource
webhookobject
idstringformat: "uuid"
namestring0-255 characters
enabledboolean
alert_typeenum
Allowed values:
metadatamap from strings to strings
triggerslist of objects
created_atdatetimeRead-only
created_bystringRead-only
last_updated_atdatetimeRead-only
last_updated_bystringRead-only
project_idstringformat: "uuid"

Optional project scope for this alert. When set, the alert is scoped to the specified project. Do NOT also provide a ‘scope:project’ trigger config — the system will create it automatically from this field. Sending both project_id and a scope:project trigger config will result in an error.

Errors

404
Not Found Error