Opik Feedback-definitions API
Feedback definitions related resources
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/opik-feedback-definitions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Opik REST Feedback Definitions API
description: The Opik REST API is currently in beta and subject to change.
contact:
name: Github Repository
url: https://github.com/comet-ml/opik
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.0
servers:
- url: http://localhost:5173/api
description: Local server
- url: https://www.comet.com/opik/api
description: Opik Cloud
tags:
- name: Feedback-definitions
description: Feedback definitions related resources
paths:
/v1/private/feedback-definitions:
get:
tags:
- Feedback-definitions
summary: Find Feedback definitions
operationId: findFeedbackDefinitions
parameters:
- name: page
in: query
schema:
minimum: 1
type: integer
format: int32
default: 1
- name: size
in: query
schema:
minimum: 1
type: integer
format: int32
default: 10
- name: name
in: query
schema:
type: string
description: Filter feedback definitions by name (partial match, case insensitive)
- name: type
in: query
schema:
type: string
enum:
- numerical
- categorical
- boolean
responses:
'200':
description: Feedback definitions resource
content:
application/json:
schema:
$ref: '#/components/schemas/FeedbackDefinitionPage_Public'
post:
tags:
- Feedback-definitions
summary: Create feedback definition
description: Get feedback definition
operationId: createFeedbackDefinition
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Feedback_Create'
responses:
'201':
description: Created
headers:
Location:
required: true
style: simple
schema:
type: string
example: ${basePath}/v1/private/feedback-definitions/{feedbackId}
/v1/private/feedback-definitions/{id}:
get:
tags:
- Feedback-definitions
summary: Get feedback definition by id
operationId: getFeedbackDefinitionById
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Feedback definition resource
content:
application/json:
schema:
$ref: '#/components/schemas/Feedback_Public'
put:
tags:
- Feedback-definitions
summary: Update feedback definition by id
operationId: updateFeedbackDefinition
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Feedback_Update'
responses:
'204':
description: No Content
delete:
tags:
- Feedback-definitions
summary: Delete feedback definition by id
operationId: deleteFeedbackDefinitionById
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'204':
description: No Content
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
/v1/private/feedback-definitions/delete:
post:
tags:
- Feedback-definitions
summary: Delete feedback definitions
description: Delete feedback definitions batch
operationId: deleteFeedbackDefinitionsBatch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDelete'
responses:
'204':
description: No Content
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
components:
schemas:
ErrorMessage:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: string
BatchDelete:
required:
- ids
type: object
properties:
ids:
maxItems: 1000
minItems: 1
uniqueItems: true
type: array
items:
type: string
format: uuid
Feedback_Public:
required:
- name
- type
type: object
properties:
id:
type: string
format: uuid
readOnly: true
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
createdAt:
type: string
format: date-time
readOnly: true
createdBy:
type: string
readOnly: true
lastUpdatedAt:
type: string
format: date-time
readOnly: true
lastUpdatedBy:
type: string
readOnly: true
type:
type: string
enum:
- numerical
- categorical
- boolean
discriminator:
propertyName: type
mapping:
numerical: '#/components/schemas/NumericalFeedbackDefinition_Public'
categorical: '#/components/schemas/CategoricalFeedbackDefinition_Public'
boolean: '#/components/schemas/BooleanFeedbackDefinition_Public'
FeedbackObject_Public:
required:
- name
- type
type: object
properties:
id:
type: string
format: uuid
readOnly: true
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
createdAt:
type: string
format: date-time
readOnly: true
createdBy:
type: string
readOnly: true
lastUpdatedAt:
type: string
format: date-time
readOnly: true
lastUpdatedBy:
type: string
readOnly: true
type:
type: string
enum:
- numerical
- categorical
- boolean
discriminator:
propertyName: type
mapping:
numerical: '#/components/schemas/NumericalFeedbackDefinition_Public'
categorical: '#/components/schemas/CategoricalFeedbackDefinition_Public'
boolean: '#/components/schemas/BooleanFeedbackDefinition_Public'
FeedbackDefinitionPage_Public:
type: object
properties:
page:
type: integer
format: int32
size:
type: integer
format: int32
total:
type: integer
format: int64
content:
type: array
items:
$ref: '#/components/schemas/FeedbackObject_Public'
Feedback_Create:
required:
- name
- type
type: object
properties:
id:
type: string
format: uuid
readOnly: true
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
type:
type: string
enum:
- numerical
- categorical
- boolean
discriminator:
propertyName: type
mapping:
numerical: '#/components/schemas/NumericalFeedbackDefinition_Create'
categorical: '#/components/schemas/CategoricalFeedbackDefinition_Create'
boolean: '#/components/schemas/BooleanFeedbackDefinition_Create'
Feedback_Update:
required:
- name
- type
type: object
properties:
id:
type: string
format: uuid
readOnly: true
name:
minLength: 1
type: string
description:
maxLength: 255
minLength: 0
type: string
description: Optional description for the feedback definition
example: This feedback definition is used to rate response quality
type:
type: string
enum:
- numerical
- categorical
- boolean
discriminator:
propertyName: type
mapping:
numerical: '#/components/schemas/NumericalFeedbackDefinition_Update'
categorical: '#/components/schemas/CategoricalFeedbackDefinition_Update'
boolean: '#/components/schemas/BooleanFeedbackDefinition_Update'