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

Experiment resources

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

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

This API exposes 17 operations across 15 paths, and defines 58 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.

17 operations 15 paths 58 schemas 6 GET2 PATCH8 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 17

Across 15 paths, the API surfaces 17 operations — 6 GET, 2 PATCH, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Experiments 17

Experiment resources

PATCH
/v1/private/experiments/batch
Batch update experiments
batchUpdateExperiments body → 204400
GET
/v1/private/experiments
Find experiments
findExperiments 14 params → 200400
POST
/v1/private/experiments
Create experiment
createExperiment body → 201
POST
/v1/private/experiments/items
Create experiment items
createExperimentItems body → 204
POST
/v1/private/experiments/items/delete
Delete experiment items
deleteExperimentItems body → 204
POST
/v1/private/experiments/delete
Delete experiments by id
deleteExperimentsById body → 204
POST
/v1/private/experiments/execute
Create and execute experiment
executeExperiment body → 202
PUT
/v1/private/experiments/items/bulk
Record experiment items in bulk
experimentItemsBulk body → 204400409422
GET
/v1/private/experiments/feedback-scores/names
Find Feedback Score names
findFeedbackScoreNames 2 params → 200
GET
/v1/private/experiments/groups
Find experiment groups
findExperimentGroups 6 params → 200400
GET
/v1/private/experiments/groups/aggregations
Find experiment groups with aggregations
findExperimentGroupsAggregations 6 params → 200400
POST
/v1/private/experiments/finish
Finish experiments
finishExperiments body → 204400
GET
/v1/private/experiments/{id}
Get experiment by id
getExperimentById 1 param → 200404
PATCH
/v1/private/experiments/{id}
Update experiment by id
updateExperiment 1 param body → 204404400
GET
/v1/private/experiments/items/{id}
Get experiment item by id
getExperimentItemById 1 param → 200404
POST
/v1/private/experiments/items/stream
Stream experiment items
streamExperimentItems body → 200
POST
/v1/private/experiments/stream
Stream experiments
streamExperiments body → 200

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are Experiment_Public (33 properties), ExperimentItem (23 properties), Span_ExperimentItemBulkWriteView (20 properties), Trace_ExperimentItemBulkWriteView (15 properties). Each schema is shown below with its type and property counts.

ErrorMessage_Public
object
3 properties
ExperimentScore_Public
object
2 properties 2 required
GroupDetails
object
1 property
GroupContentWithAggregations
object
2 properties
ExperimentGroupAggregationsResponse
object
1 property
AggregationData
object
10 properties
Comment_Public
object
6 properties 1 required
DeleteIdsHolder
object
1 property 1 required
JsonNode
object
ValueEntry
object
7 properties
ValueEntry_ExperimentItemBulkWriteView
object
7 properties
AssertionScoreAverage_Public
object
Per-assertion average pass rates for test suite experiments. Null for regular experiments.
2 properties 2 required
ErrorMessage
object
3 properties
Message
object
2 properties 2 required
ExperimentItemsDelete
object
1 property 1 required
JsonListString_ExperimentItemBulkWriteView
object
DatasetVersionSummary_Public
object
Summary of the latest dataset version
5 properties
ExperimentItemBulkUpload_ExperimentItemBulkWriteView
object
5 properties 3 required
ErrorInfo_ExperimentItemBulkWriteView
object
3 properties 2 required
JsonListString
object
Experiment_Write
object
15 properties 1 required
JsonListString_Public
object
ExperimentScore_Write
object
2 properties 2 required
ExperimentStreamRequest_Public
object
4 properties 1 required
GroupDetail
object
1 property
ExecutionPolicy
object
2 properties
PromptVersionLink
object
5 properties 1 required
PromptVersionLink_Public
object
4 properties
ExperimentItemsBatch
object
1 property 1 required
Experiment_Public
object
33 properties 1 required
JsonListString_Write
object
ExperimentScore
object
2 properties 2 required
ExperimentItemStreamRequest
object
5 properties 1 required
FeedbackScore_ExperimentItemBulkWriteView
object
10 properties 3 required
FeedbackScoreAverage_Public
object
2 properties 2 required
ExperimentInfo
object
2 properties
FeedbackScoreNames_Public
object
1 property
AssertionResult
object
3 properties
ExperimentGroupResponse
object
2 properties
PromptVariant
object
4 properties 2 required
Comment
object
6 properties 1 required
ExperimentItem_Public
object
10 properties 3 required
ExperimentBatchUpdate
object
Request to batch update multiple experiments
3 properties 2 required
GroupContent
object
1 property
PromptVersionLink_Write
object
1 property 1 required
ExperimentItemBulkRecord_ExperimentItemBulkWriteView
object
5 properties 1 required
ScoreName_Public
object
2 properties
Trace_ExperimentItemBulkWriteView
object
Please provide either none, only one of evaluatetaskresult or trace, but never both
15 properties 1 required
ExperimentExecutionResponse
object
2 properties
Span_ExperimentItemBulkWriteView
object
20 properties 1 required
ExperimentUpdate
object
8 properties
ExperimentItem
object
23 properties 3 required
FeedbackScore
object
10 properties 3 required
ExperimentExecutionRequest
object
7 properties 3 required
PercentageValues
object
3 properties
PercentageValues_Public
object
3 properties
FeedbackScoreAverage
object
2 properties 2 required
ExperimentPage_Public
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opik-experiments-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 Experiments 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.