POST Review Summary API
/api/v1/ai/review-summary
Summarize multiple customer reviews to extract recurring positive/negative themes, complaints, and key takeaways.
Architecture Role & AI Definition
Review Summary API provides low-latency, deterministic REST execution for production engineering workflows. It processes structured payloads with strict schema validation, returns uniform JSON envelopes, and is secured via SHA-256 API key authentication with atomic credit pre-authorization locks.
Production Reliability Guidelines
Configure a hard client timeout of 5 to 8 seconds. If network latency spikes, cancel connection to avoid holding open sockets in worker pools.
Upon receiving 429 Rate Limit or transient 5xx, pause with exponential backoff:
wait = min(max_backoff, base * 2^attempt + jitter).
RSFlowHub acquires an atomic lock verifying base credits before model invocation. If validation fails, zero credits are deducted.
Request Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
reviews |
array | Required | Required array of customer reviews (Min: 1, Max: 50). Each review can be a raw text string or an object with text/review details. |
model |
string | Optional | Optional AI model to use. |
Example Request
This example demonstrates how to pass an array of customer review strings to extract batch insights.
{
"reviews": [
"I love this app, it has changed my life. Best UX ever!",
"Decent app, but it crashes on launch sometimes on my Android device.",
"The subscription is way too expensive for what it offers. Cancelled.",
"Helpful customer support, they resolved my issue within 10 minutes."
]
}curl -X POST https://rsflowhub.com/api/v1/ai/review-summary \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"reviews": [
"I love this app, it has changed my life. Best UX ever!",
"Decent app, but it crashes on launch sometimes on my Android device.",
"The subscription is way too expensive for what it offers. Cancelled.",
"Helpful customer support, they resolved my issue within 10 minutes."
]
}'Example Response
The response details overall summary, positive/negative themes, recurring pain points, and actionable takeaways.
{
"success": true,
"data": {
"result": {
"summary": "Customers generally like the UX and find support helpful, but there are complaints about high subscription costs and app crashes on Android.",
"overall_sentiment": "mixed",
"total_analyzed": 4,
"positive_themes": [
"User experience",
"Responsive support"
],
"negative_themes": [
"Android crashes",
"High subscription pricing"
],
"common_praise": [
"Best UX ever",
"Support resolved issue in 10 minutes"
],
"common_complaints": [
"Crashes on Android launch",
"Too expensive subscription"
],
"recurring_pain_points": [
"App crash blocking access",
"High cost barrier"
],
"common_suggestions": [],
"important_patterns": [
"Android users encounter stability issues",
"Pricing causes subscriber churn"
],
"key_takeaways": [
"Investigate Android boot crash immediately",
"Consider reviewing pricing tiers or value delivery"
]
}
},
"meta": {
"credits_used": 3,
"credits_remaining": 987
}
}API Request Example
Use the cURL snippet below to test the endpoint.
curl -X POST 'https://rsflowhub.com/api/v1/ai/review-summary' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"reviews": [
"I love this app, it has changed my life. Best UX ever!",
"Decent app, but it crashes on launch sometimes on my Android device.",
"The subscription is way too expensive for what it offers. Cancelled.",
"Helpful customer support, they resolved my issue within 10 minutes."
]
}'Common Failure Modes & Troubleshooting Matrix
| HTTP Code | Error Code | Root Cause | Recommended Remediation |
|---|---|---|---|
| 400 | bad_request |
Malformed JSON syntax or missing required top-level parameters. | Validate JSON payload with Content-Type: application/json and ensure all required fields are present. |
| 401 | unauthorized |
Missing, revoked, or incorrectly formatted x-api-key header. |
Verify API key exists in Dashboard → API Keys and pass in x-api-key or Authorization: Bearer. |
| 402 | insufficient_credits |
Account credit balance is lower than the base required credits (3 credits). | Top up credits in billing settings or enable auto-recharge to prevent pipeline interruption. |
| 422 | validation_error |
Input failed parameter constraints (e.g., character length exceeded or invalid array types). | Review parameters table above and adjust payload length, types, or structure accordingly. |
| 429 | rate_limit_exceeded |
Concurrency limit (60 requests/minute default) reached for this endpoint key. | Back off and retry using the timestamp in Retry-After response header, or batch requests. |