How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Opik Alerts API

Alert resources

Opik Alerts API is one of 39 APIs that Opik publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 5 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: http://localhost:5173/api, https://www.comet.com/opik/api.

7 operations 5 paths 14 schemas 3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://www.comet.com/opik/api/v1
License
Resource Areas
1

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Alerts 7

Alert resources

GET
/v1/private/alerts
Find alerts
findAlerts 4 params → 200
POST
/v1/private/alerts
Create alert
createAlert body → 201422400409
POST
/v1/private/alerts/delete
Delete alert batch
deleteAlertBatch body → 204400
GET
/v1/private/alerts/{id}
Get Alert by id
getAlertById 1 param → 200404
PUT
/v1/private/alerts/{id}
Update alert
updateAlert 1 param body → 204422400409
GET
/v1/private/alerts/webhooks/examples
Get webhook payload examples
getWebhookExamples 1 param → 200
POST
/v1/private/alerts/webhooks/tests
Test alert webhook
testWebhook body → 200422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Alert_Public (12 properties), AlertTriggerConfig_Public (9 properties), Webhook_Public (9 properties), Alert_Write (8 properties). Each schema is shown below with its type and property counts.

Webhook_Public
object
9 properties 1 required
Webhook_Write
object
5 properties 1 required
ErrorMessage_Public
object
3 properties
WebhookExamples
object
1 property
AlertTriggerConfig_Public
object
9 properties 1 required
Alert_Public
object
12 properties 1 required
AlertTriggerConfig_Write
object
4 properties 1 required
WebhookTestResult
object
4 properties
AlertPage_Public
object
5 properties
AlertTrigger_Public
object
6 properties 1 required
ErrorMessage
object
3 properties
AlertTrigger_Write
object
3 properties 1 required
Alert_Write
object
8 properties 1 required
BatchDelete
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opik-alerts-api-openapi.yml Raw ↑

Other APIs Opik publishes across the network.

Opik Agent Configs API
Opik AI Spend API
Opik Annotation Queues API
Opik Assertion Results API
Opik Attachments API
Opik Automation rule evaluators API
Opik Chat Completions API
Opik Check API
Opik Dashboards API
Opik Datasets API
Opik Environments API
Opik Experiments API
Where this information came from

This is an independent, third-party profile of Opik Alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.