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

Create alert

POST
/v1/private/alerts
POST
/api/v1/private/alerts
$curl -X POST http://localhost:5173/api/v1/private/alerts \
> -H "Content-Type: application/json" \
> -d '{
> "webhook": {
> "url": "string"
> }
>}'
1{}
Create alert
Was this page helpful?
Previous

Delete alert batch

Next
Built with

Request

This endpoint expects an object.
webhookobjectRequired
idstringOptionalformat: "uuid"
namestringOptional0-255 characters
enabledbooleanOptional
alert_typeenumOptional
Allowed values:
metadatamap from strings to stringsOptional
triggerslist of objectsOptional
project_idstringOptionalformat: "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.

Response headers

Locationstring

Response

Created

Errors

400
Bad Request Error
409
Conflict Error
422
Unprocessable Entity Error