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

Get feedback definition by id

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

Update feedback definition by id

Next
Built with

Path parameters

idstringRequiredformat: "uuid"

Response

Feedback definition resource
numericalobject
OR
categoricalobject
OR
booleanobject