⭐Reviews & Score

Overview

Review are a core feature of both Prompts and Agents. They allow you to determine how your prompts are performing and super-charge the analytics feature.

After each interaction with the Agent/Prompt API you'll receive a chatId. This can then be used in our Reviews API for your app's user to review the quality of the output they received.

For example, if your user just finished your AI powered language lesson, you can present them with a 1-5 star rating element & text review field. You then connect the chatId (from the previous Prompt / Agent output), reviewScore (stars, 1-5), and reviewText (freeform user text) to our reviews API.

We then save and store this so you can see how your users judge the quality of your AI outputs. We find this to be absolutely invaluable when developing AI features, and strongly recommend connecting to the review API.

Submit a review

post

This endpoint allows users to submit reviews based on their chat interactions. It records the review score and optional textual feedback.

Authorizations

Body

chatIdstringRequired

The ID of the chat being reviewed

Example: chat-67890

reviewTextstring | nullableOptional

Textual content of the review

Example: Great assistance, very helpful!

reviewScorenumber · doubleRequired

Numerical score of the review

Example: 4.5

userIdstring | nullableOptional

ID of the user submitting the review

Example: user-54321

Responses

200

Review submitted successfully

application/json

400

Bad request, e.g., missing or invalid ID

application/json

post

HTTPcURLJavaScriptPython

POST /v1/review HTTP/1.1
Host: api.easybeam.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "chatId": "chat-67890",
  "reviewScore": 4.5,
  "reviewText": "Great assistance, very helpful!",
  "userId": "user-54321"
}

{
  "status": "success",
  "message": "Review submitted successfully."
}