Submit feedback on a message

Provide feedback on a specific message in a conversation.

Impersonation:

• When using impersonation, the feedback is submitted as the impersonated user

Feedback Types

Type	is_positive Value	Description
Thumbs up	true	Positive feedback
Thumbs down	false	Negative feedback
Neutral	null	Neutral or no sentiment

Query ID

The query_id identifies a specific user query and all related responses. It can be obtained from:

• The streaming response (each message contains query_id)
• The streaming_completed event’s chat_history
• The conversation retrieval endpoint

POST /projects/{project_id}/feedbacks

Submit feedback on a message

Python

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/feedbacks/"

payload = {
    "context": {
        "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "query_id": 0,
        "source": "PlaygroundConversation"
    },
    "feedback": "This answer was helpful and accurate",
    "is_positive": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "given_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[e-mail]"
  },
  "status": "to_review",
  "feedback": "<string>",
  "context": {
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "query_id": 123,
    "source": "<string>"
  },
  "is_positive": true,
  "user_message": "<string>",
  "conversation_title": "<string>",
  "suggested_action_type": "<string>",
  "suggested_action_data": {}
}

Authorizations

BearerAuthTokenAuth

Authorization · string · header · required

Use Authorization: Bearer

Headers

X-Impersonate-Email · string<email>

Email of the user to impersonate. Requires CAN_IMPERSONATE_OTHER_USERS permission. If the target user is not found or does not have access to the project, the request proceeds as the authenticated user. Contact Clarifeye to enable this permission.

Path Parameters

project_id · string<uuid> · required

UUID of the project

Body

application/json

context · object · required

Show child attributes

feedback · string

Text comment (can be empty for quick feedback)

Example:

"This answer was helpful and accurate"

is_positive · boolean | null

• true: Positive feedback (thumbs up)
• false: Negative feedback (thumbs down)
• null: Neutral feedback

Example:

true

Response

201

application/json

Feedback submitted successfully

id · string<uuid>

created_at · string<date-time>

updated_at · string<date-time>

given_by · object

User who submitted the feedback

Show child attributes

status · enum<string>

• to_review: Feedback pending review (default)
• reviewed: Feedback has been reviewed

Available options: to_review, reviewed

feedback · string

Feedback text comment

context · object

Legacy context object (conversation_id is now available as a direct field)

Show child attributes

is_positive · boolean | null

• true: Positive feedback
• false: Negative feedback
• null: Neutral

user_message · string

The user message that was responded to (computed field)

conversation_title · string

Title of the conversation (computed field)

suggested_action_type · string | null

Auto-generated suggested action type

suggested_action_data · object

Auto-generated suggested action data