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

Create feedback definition

POST
/v1/private/feedback-definitions
POST
/api/v1/private/feedback-definitions
$curl -X POST http://localhost:5173/api/v1/private/feedback-definitions \
>     -H "Content-Type: application/json" \
>     -d '{
>  "type": "numerical",
>  "name": "string"
>}'
201Created
1{}
Get feedback definition
Was this page helpful?
Previous

Get feedback definition by id

Next
Built with

Request

This endpoint expects an object.
numericalobjectRequired
OR
categoricalobjectRequired
OR
booleanobjectRequired

Response headers

Locationstring

Response

Created