Skip to main content

​
List All Feedbacks

Retrieve all feedback entries in the system. Admin only.

​
Response

​
feedbacks
array
Array of all feedback objects
curl -X GET "https://your-instance.com/api/evaluations/feedbacks/all" \
  -H "Authorization: Bearer $OPENWEBUI_API_KEY"

​
Get All Feedback IDs

Retrieve only the IDs of all feedback entries. Admin only. Useful for batch operations or checking feedback existence.

​
Response

​
ids
array
Array of feedback ID objects
curl -X GET "https://your-instance.com/api/evaluations/feedbacks/all/ids" \
  -H "Authorization: Bearer $OPENWEBUI_API_KEY"

[
  {"id": "feedback-uuid-1"},
  {"id": "feedback-uuid-2"},
  {"id": "feedback-uuid-3"}
]

​
Delete All Feedbacks

Delete all feedback entries from the system. Admin only. This action cannot be undone.

​
Response

​
success
boolean
Whether the deletion was successful
curl -X DELETE "https://your-instance.com/api/evaluations/feedbacks/all" \
  -H "Authorization: Bearer $OPENWEBUI_API_KEY"

​
Export All Feedbacks

Export all feedback entries including full data models. Admin only. Returns the complete feedback objects for data export or backup.

​
Response

​
feedbacks
array
Array of complete feedback model objects
curl -X GET "https://your-instance.com/api/evaluations/feedbacks/all/export" \
  -H "Authorization: Bearer $OPENWEBUI_API_KEY" \
  -o feedbacks_export.json

​
Get User Feedbacks

Retrieve all feedback entries created by the authenticated user.

​
Response

​
feedbacks
array
Array of user’s feedback objects
curl -X GET "https://your-instance.com/api/evaluations/feedbacks/user" \
  -H "Authorization: Bearer $OPENWEBUI_API_KEY"

​
Delete User Feedbacks

Delete all feedback entries created by the authenticated user.

​
Response

​
success
boolean
Whether the deletion was successful
curl -X DELETE "https://your-instance.com/api/evaluations/feedbacks" \
  -H "Authorization: Bearer $OPENWEBUI_API_KEY"

​
List Feedbacks (Paginated)

Retrieve a paginated list of feedback entries with sorting options. Admin only.

​
Query Parameters

​
order_by
string
Field to order results by (e.g., “created_at”, “updated_at”)
​
direction
string
Sort direction: “asc” or “desc”
​
page
integer
default:"1"
Page number (1-indexed, minimum: 1)

​
Response

​
items
array
Array of feedback entries for the current page (30 items per page)
​
total
integer
Total number of feedback entries
​
page
integer
Current page number
​
pages
integer
Total number of pages
curl -X GET "https://your-instance.com/api/evaluations/feedbacks/list?page=1&order_by=created_at&direction=desc" \
  -H "Authorization: Bearer $OPENWEBUI_API_KEY"

{
  "items": [
    {
      "id": "feedback-uuid-1",
      "user_id": "user-123",
      "data": {
        "model_id": "gpt-4",
        "rating": "1",
        "sibling_model_ids": ["claude-3"],
        "tags": ["coding", "helpful"]
      },
      "created_at": 1709395200,
      "updated_at": 1709395200
    }
  ],
  "total": 150,
  "page": 1,
  "pages": 5
}

​
Create Feedback

Create a new feedback entry for model evaluation.

​
Request Body

​
type
string
Type of feedback (e.g., “rating”, “comparison”)
​
data
object
required
Feedback data payload
​
meta
object
Additional metadata

​
Response

​
id
string
Unique identifier for the created feedback
​
user_id
string
ID of the user who created the feedback
​
type
string
Type of feedback
​
data
object
Feedback data
​
meta
object
Metadata
​
created_at
integer
Unix timestamp of creation
​
updated_at
integer
Unix timestamp of last update
curl -X POST "https://your-instance.com/api/evaluations/feedback" \
  -H "Authorization: Bearer $OPENWEBUI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "comparison",
    "data": {
      "model_id": "gpt-4",
      "rating": "1",
      "sibling_model_ids": ["claude-3", "llama-3"],
      "tags": ["coding", "python", "helpful"]
    },
    "meta": {
      "context": "code generation task"
    }
  }'

{
  "id": "feedback-uuid-new",
  "user_id": "user-123",
  "type": "comparison",
  "data": {
    "model_id": "gpt-4",
    "rating": "1",
    "sibling_model_ids": ["claude-3", "llama-3"],
    "tags": ["coding", "python", "helpful"]
  },
  "meta": {
    "context": "code generation task"
  },
  "created_at": 1709395200,
  "updated_at": 1709395200
}

​
Get Feedback by ID

Retrieve a specific feedback entry by ID. Users can only access their own feedback unless they are admins.

​
Path Parameters

​
id
string
required
Unique feedback identifier

​
Response

​
id
string
Unique feedback identifier
​
user_id
string
ID of the user who created the feedback
​
type
string
Type of feedback
​
data
object
Feedback data
​
meta
object
Metadata
​
created_at
integer
Unix timestamp of creation
​
updated_at
integer
Unix timestamp of last update
curl -X GET "https://your-instance.com/api/evaluations/feedback/feedback-uuid-1" \
  -H "Authorization: Bearer $OPENWEBUI_API_KEY"

​
Update Feedback by ID

Update an existing feedback entry. Users can only update their own feedback unless they are admins.

​
Path Parameters

​
id
string
required
Unique feedback identifier

​
Request Body

​
type
string
Type of feedback
​
data
object
required
Updated feedback data payload
​
meta
object
Updated metadata

​
Response

Returns the updated feedback object with the same structure as the create endpoint. 
curl -X POST "https://your-instance.com/api/evaluations/feedback/feedback-uuid-1" \
  -H "Authorization: Bearer $OPENWEBUI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "model_id": "gpt-4",
      "rating": "1",
      "sibling_model_ids": ["claude-3"],
      "tags": ["coding", "python", "helpful", "clear"]
    }
  }'

​
Delete Feedback by ID

Delete a specific feedback entry. Users can only delete their own feedback unless they are admins.

​
Path Parameters

​
id
string
required
Unique feedback identifier

​
Response

​
success
boolean
Whether the deletion was successful
curl -X DELETE "https://your-instance.com/api/evaluations/feedback/feedback-uuid-1" \
  -H "Authorization: Bearer $OPENWEBUI_API_KEY"

true