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 Projects API

Project related resources

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

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

This API exposes 19 operations across 16 paths, and defines 65 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.

19 operations 16 paths 65 schemas 1 DELETE12 GET1 PATCH5 POST

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 19

Across 16 paths, the API surfaces 19 operations — 1 DELETE, 12 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Projects 19

Project related resources

GET
/v1/private/projects/{projectId}/alerts
Find alerts by project
findAlertsByProject 5 params → 200400
GET
/v1/private/projects/{projectId}/dashboards
Find dashboards by project
findDashboardsByProject 6 params → 200
GET
/v1/private/projects/{projectId}/datasets
Find datasets by project
findDatasetsByProject 8 params → 200
GET
/v1/private/projects/{projectId}/experiments
Find experiments by project
findExperimentsByProject 12 params → 200400
GET
/v1/private/projects/{projectId}/optimizations
Find optimizations by project
findOptimizationsByProject 8 params → 200400
GET
/v1/private/projects/{projectId}/prompts
Get prompts by project
getPromptsByProject 6 params → 200
GET
/v1/private/projects
Find projects
findProjects 4 params → 200
POST
/v1/private/projects
Create project
createProject body → 201422400
GET
/v1/private/projects/{id}
Get project by id
getProjectById 1 param → 200
DELETE
/v1/private/projects/{id}
Delete project by id
deleteProjectById 1 param → 204409
PATCH
/v1/private/projects/{id}
Update project by id
updateProject 1 param body → 204422400
POST
/v1/private/projects/delete
Delete projects
deleteProjectsBatch body → 204
GET
/v1/private/projects/feedback-scores/names
Find Feedback Score names By Project Ids
findFeedbackScoreNamesByProjectIds 1 param → 200
GET
/v1/private/projects/{id}/token-usage/names
Find Token Usage names
findTokenUsageNames 1 param → 200
POST
/v1/private/projects/{id}/kpi-cards
Get Project KPI Cards
getProjectKpiCards 1 param body → 200400
POST
/v1/private/projects/{id}/metrics
Get Project Metrics
getProjectMetrics 1 param body → 200400404
GET
/v1/private/projects/stats
Get Project Stats
getProjectStats 5 params → 200
POST
/v1/private/projects/retrieve
Retrieve project
retrieveProject body → 200422400404
GET
/v1/private/projects/{projectId}/activities
Get recent activity for a project
getRecentActivity 3 params → 200400500

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are Experiment_Public (33 properties), Optimization_Public (23 properties), Dataset_Public (20 properties), Project_Detailed (18 properties). Each schema is shown below with its type and property counts.

JsonNode_Public
object
ExperimentScore_Public
object
2 properties 2 required
ErrorMessage_Public
object
3 properties
PercentageValues_Detailed
object
3 properties
TokenUsageNames
object
1 property
Comment_Public
object
6 properties 1 required
StudioOptimizer_Public
object
2 properties 1 required
ProjectPage_Public
object
5 properties
TraceThreadFilter_Public
object
4 properties
KpiCardRequest
object
4 properties 2 required
AlertPage_Public
object
5 properties
KpiMetric
object
3 properties
AssertionScoreAverage_Public
object
Per-assertion average pass rates for test suite experiments. Null for regular experiments.
2 properties 2 required
PromptPage_Public
object
5 properties
AlertTrigger_Public
object
6 properties 1 required
ErrorMessage
object
3 properties
ErrorCountWithDeviation
object
3 properties
ProjectRetrieve_Detailed
object
1 property 1 required
ErrorMessage_Detailed
object
1 property
FeedbackScoreNames
object
1 property
DatasetVersionSummary_Public
object
Summary of the latest dataset version
5 properties
JsonListString_Public
object
ProjectStatsSummaryItem
object
10 properties
SpanFilter_Public
object
4 properties
OptimizationPage_Public
object
5 properties
TraceFilter_Public
object
4 properties
PromptVersionLink_Public
object
4 properties
Dashboard_Public
object
13 properties 2 required
Project_Write
object
3 properties 1 required
DashboardPage_Public
object
5 properties
Experiment_Public
object
33 properties 1 required
Dataset_Public
object
20 properties 1 required
Project_Detailed
object
18 properties 1 required
FeedbackScoreAverage_Detailed
object
2 properties 2 required
StudioLlmModel_Public
object
2 properties 1 required
ProjectMetricRequest_Public
object
8 properties
ProjectStatsSummary
object
1 property
OptimizationStudioConfig_Public
object
5 properties 5 required
StudioMessage_Public
object
2 properties 2 required
FeedbackScoreAverage_Public
object
2 properties 2 required
RecentActivityItem_Public
object
6 properties
Alert_Public
object
12 properties 1 required
ResultsNumber_Public
object
2 properties
BreakdownConfig_Public
object
3 properties
StudioPrompt_Public
object
1 property 1 required
StudioEvaluation_Public
object
1 property 1 required
Prompt_Public
object
11 properties 1 required
BatchDelete
object
1 property 1 required
ProjectMetricResponse_Public
object
4 properties
StudioMetric_Public
object
2 properties 1 required
Webhook_Public
object
9 properties 1 required
DatasetPage_Public
object
5 properties
KpiCardResponse
object
1 property
ProjectUpdate
object
3 properties
DataPointNumber_Public
object
2 properties 1 required
Optimization_Public
object
23 properties 3 required
AlertTriggerConfig_Public
object
9 properties 1 required
Project_Public
object
9 properties 1 required
ErrorCountWithDeviation_Detailed
object
3 properties
ScoreName
object
2 properties
PercentageValues
object
3 properties
PercentageValues_Public
object
3 properties
RecentActivityPage_Public
object
4 properties
FeedbackScoreAverage
object
2 properties 2 required
ExperimentPage_Public
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opik-projects-api-openapi.yml Raw ↑

Other APIs Opik publishes across the network.

Opik Agent Configs API
Opik AI Spend API
Opik Alerts 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
Where this information came from

This is an independent, third-party profile of Opik Projects 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.