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

Prompt resources

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

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

This API exposes 17 operations across 13 paths, and defines 22 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 13 paths 22 schemas 1 DELETE6 GET2 PATCH7 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 13 paths, the API surfaces 17 operations — 1 DELETE, 6 GET, 2 PATCH, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Prompts 17

Prompt resources

GET
/v1/private/prompts
Get prompts
getPrompts 6 params → 200
POST
/v1/private/prompts
Create prompt
createPrompt body → 201422400409
POST
/v1/private/prompts/versions
Create prompt version
createPromptVersion body → 200422400409
PATCH
/v1/private/prompts/versions
Update prompt versions
updatePromptVersions body → 204400
GET
/v1/private/prompts/{id}
Get prompt by id
getPromptById 3 params → 200400404
PUT
/v1/private/prompts/{id}
Update prompt
updatePrompt 1 param body → 204422400404409
DELETE
/v1/private/prompts/{id}
Delete prompt
deletePrompt 1 param → 204
POST
/v1/private/prompts/delete
Delete prompts
deletePromptsBatch body → 204
GET
/v1/private/prompts/by-commit/{commit}
Get prompt by commit
getPromptByCommit 1 param → 200400404409
GET
/v1/private/prompts/versions/{versionId}
Get prompt version by id
getPromptVersionById 1 param → 200404
GET
/v1/private/prompts/{promptId}/versions/by-number/{versionNumber}
Get prompt version by sequential number
getPromptVersionByNumber 2 params → 200400404
GET
/v1/private/prompts/{id}/versions
Get prompt versions
getPromptVersions 6 params → 200
POST
/v1/private/prompts/retrieve-by-commits
Get prompts by commits
getPromptsByCommits body → 200
POST
/v1/private/prompts/{promptId}/versions/{versionId}/restore
Restore prompt version
restorePromptVersion 2 params → 200404400
POST
/v1/private/prompts/versions/retrieve
Retrieve prompt version
retrievePromptVersion body → 200422400404
POST
/v1/private/prompts/versions/retrieve-by-ids
Retrieve prompt versions by ids
retrievePromptVersionsByIds body → 200400
PATCH
/v1/private/prompts/versions/{versionId}/environments
Set prompt version environment
setPromptVersionEnvironment 1 param body → 204400404

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are PromptVersion_Detail (16 properties), PromptVersion_Public (15 properties), Prompt_Detail (13 properties), Prompt_Write (11 properties). Each schema is shown below with its type and property counts.

JsonNode_Public
object
PromptVersionCommitsRequest_Public
object
1 property 1 required
Prompt_Write
object
11 properties 1 required
PromptPage_Public
object
5 properties
ErrorMessage
object
3 properties
Prompt_Detail
object
13 properties 1 required
PromptVersionUpdate
object
Update to apply to prompt versions. Note: Prompt versions are immutable by design. Only organizational properties (such as tags etc.) can be updated. Core prop…
1 property
PromptVersionEnvironmentUpdate
object
Replace the full set of environments assigned to a prompt version. The provided set becomes the new complete set of environments for this version. - Non-empty…
1 property 1 required
PromptVersionLink_Public
object
4 properties
PromptVersion_Public
object
15 properties 1 required
PromptVersionPage_Public
object
5 properties
PromptVersionIdsRequest_Detail
object
1 property 1 required
PromptVersionBatchUpdate
object
Request to update one or more prompt versions. Note: Prompt versions are immutable by design - only organizational properties (such as tags etc.) can be update…
3 properties 2 required
ErrorMessage_Detail
object
1 property
Prompt_Public
object
11 properties 1 required
BatchDelete
object
1 property 1 required
JsonNode_Detail
object
Prompt_Updatable
object
3 properties 1 required
PromptVersion_Detail
object
16 properties 1 required
PromptVersionRetrieve_Detail
object
5 properties 1 required
JsonNode_Write
object
CreatePromptVersion_Detail
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opik-prompts-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 Prompts 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.