API Endpoint
POST Review Analyze API
/api/v1/ai/review-analyze
Analyze sentiment, category, key topics, emotions, and urgency of a single customer review.
Request Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
review |
string | Required | The customer review text (Max: 20,000 characters). |
rating |
integer | Optional | Optional customer numeric rating (between 1 and 5). |
language |
string | Optional | Optional review language identifier. |
context |
string | Optional | Optional product, business, or category context. |
model |
string | Optional | Optional AI model to use. |
Example Request
This example demonstrates how to request an analysis of a single customer review with rating and business context.
JSON Request
{
"review": "The food was absolutely delicious and the service was amazing! However, it was a bit overpriced.",
"rating": 4,
"context": "Italian restaurant in downtown New York"
}
cURL
curl -X POST https://rsflowhub.com/api/v1/ai/review-analyze \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"review": "The food was absolutely delicious and the service was amazing! However, it was a bit overpriced.",
"rating": 4,
"context": "Italian restaurant in downtown New York"
}'
Example Response
The response provides structured analysis, categorizing review type, sentiment, urgency, and highlighting positives/negatives.
JSON Response
{
"success": true,
"data": {
"result": {
"sentiment": "mixed",
"confidence": 0.95,
"language": "en",
"category": "mixed",
"emotions": [
"delight",
"slight disappointment"
],
"key_topics": [
"food quality",
"service speed",
"pricing"
],
"positive_points": [
"Food was absolutely delicious",
"Service was amazing"
],
"negative_points": [
"Overpriced food"
],
"pain_points": [
"High cost of the dishes"
],
"suggestions": [],
"urgency": "low",
"attention_recommended": false
}
},
"meta": {
"credits_used": 2,
"credits_remaining": 990
}
}
API Request Example
Use the cURL snippet below to test the endpoint.
cURL
curl -X POST 'https://rsflowhub.com/api/v1/ai/review-analyze' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"review": "The food was absolutely delicious and the service was amazing! However, it was a bit overpriced.",
"rating": 4,
"context": "Italian restaurant in downtown New York"
}'