POST Review Reply API
/api/v1/ai/review-reply
Generate a context-aware draft response to a customer review matching your tone and instructions.
Architecture Role & AI Definition
Review Reply 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 |
|---|---|---|---|
review |
string | Required | The raw customer review text (Max: 20,000 characters). |
rating |
integer | Optional | Optional review rating (1 to 5) to align response empathy. |
business_name |
string | Optional | Optional business name to include in signature. |
customer_name |
string | Optional | Optional customer name for greeting. |
tone |
string | Optional | Desired response tone. Allowed: "professional", "friendly", "empathetic", "concise". Default is "professional". |
language |
string | Optional | Optional draft response language. |
instructions |
string | Optional | Optional custom instructions (e.g. "Ask them to contact support at help@company.com"). |
Example Request
This example demonstrates how to draft an empathetic reply for a negative review, providing custom directions.
{
"review": "I bought this product yesterday and it broke within 2 hours. Extremely disappointed.",
"rating": 1,
"business_name": "TechGadgets Inc.",
"customer_name": "Sarah Connor",
"tone": "empathetic",
"instructions": "Tell them support will reach out within 2 hours to ship a free replacement."
}curl -X POST https://rsflowhub.com/api/v1/ai/review-reply \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"review": "I bought this product yesterday and it broke within 2 hours. Extremely disappointed.",
"rating": 1,
"business_name": "TechGadgets Inc.",
"customer_name": "Sarah Connor",
"tone": "empathetic",
"instructions": "Tell them support will reach out within 2 hours to ship a free replacement."
}'Example Response
The response provides the drafted content, tone, and language.
{
"success": true,
"request_id": "req_7f3a9c2d1e4b8a6f",
"data": {
"result": {
"reply_text": "Hi Sarah, we are incredibly sorry to hear that your product broke so quickly. That is definitely not the standard we strive for at TechGadgets Inc. Our support team will reach out to you within the next 2 hours to coordinate shipping a free replacement. Thank you for your patience.",
"language": "en",
"tone": "empathetic"
}
},
"meta": {
"version": "v1",
"timestamp": "2026-09-27T12:34:56+00:00"
}
}API Request Example
Use the cURL snippet below to test the endpoint.
curl -X POST 'https://rsflowhub.com/api/v1/ai/review-reply' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"review": "I bought this product yesterday and it broke within 2 hours. Extremely disappointed.",
"rating": 1,
"business_name": "TechGadgets Inc.",
"customer_name": "Sarah Connor",
"tone": "empathetic",
"instructions": "Tell them support will reach out within 2 hours to ship a free replacement."
}'Want to try it without code? Test this request in the live Playground.
Common Failure Modes & Troubleshooting Matrix
| HTTP Code | Error Code | Root Cause | Recommended Remediation |
|---|---|---|---|
| 401 | API_KEY_MISSING / INVALID_API_KEY |
No key sent, or the key was mistyped or regenerated. | Copy the current key from Dashboard → API Keys and send it as Authorization: Bearer (or X-API-Key). |
| 402 | INSUFFICIENT_CREDITS |
Your balance cannot cover the estimate for this call (base 2 credits plus input/output size). | Buy a plan in Dashboard → Billing. Nothing was charged. |
| 422 | VALIDATION_ERROR |
A field is missing, too long or the wrong type, or the body is not valid JSON. | Read error.details for the field messages and fix the request. Do not retry the same body. |
| 429 | RATE_LIMIT_EXCEEDED |
Your plan-wide or per-endpoint per-minute limit was reached. | Wait the seconds in the Retry-After header, then retry with jitter. Rate limits |
| 502 | AI_PROVIDER_ERROR |
The AI model and its backup both failed. | Retry with backoff and check the status page. Nothing was charged. |