⭐Reviews & Score

Overview

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

After each interaction with the Portals/Workflows 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 portal / workflow 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

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

POSThttps://api.easybeam.ai/v1/review

Authorization

BearerAuth

Body

application/json

Review details submitted by the user

chatId*string

The ID of the chat being reviewed

Example: "chat-67890"

reviewTextnullable string

Textual content of the review

Example: "Great assistance, very helpful!"

reviewScore*number (double)

Numerical score of the review

Example: 4.5

userIdnullable string

ID of the user submitting the review

Example: "user-54321"

Response

200400

Review submitted successfully

Body

application/json

statusstring

Status of the operation

Example: "success"

messagestring

Informational message about the operation

Example: "Review submitted successfully."

Request

JavaScriptCurlPython

const response = await fetch('https://api.easybeam.ai/v1/review', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chatId": "chat-67890",
      "reviewScore": 4.5,
      "reviewText": "Great assistance, very helpful!",
      "userId": "user-54321"
    }),
});
const data = await response.json();

Response

200400

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