For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • GETFind Feedback definitions
        • POSTCreate feedback definition
        • GETGet feedback definition by id
        • PUTUpdate feedback definition by id
        • DELDelete feedback definition by id
        • POSTDelete feedback definitions
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceFeedback Definitions

Find Feedback definitions

GET
/v1/private/feedback-definitions
GET
/api/v1/private/feedback-definitions
$curl http://localhost:5173/api/v1/private/feedback-definitions
200Retrieved
1{
2  "page": 1,
3  "size": 1,
4  "total": 1,
5  "content": [
6    {
7      "type": "numerical",
8      "name": "string",
9      "createdAt": "2024-01-15T09:30:00Z",
10      "createdBy": "string",
11      "description": "This feedback definition is used to rate response quality",
12      "id": "string",
13      "lastUpdatedAt": "2024-01-15T09:30:00Z",
14      "lastUpdatedBy": "string"
15    }
16  ]
17}
Find Feedback definitions
Was this page helpful?
Previous

Create feedback definition

Next
Built with

Query parameters

pageintegerOptional>=1Defaults to 1
sizeintegerOptional>=1Defaults to 10
namestringOptional
typeenumOptional
Allowed values:

Response

Feedback definitions resource
pageinteger
sizeinteger
totallong
contentlist of objects