Review Reply API Specification & Integration Reference
API Endpoint Public API Page

POST Review Reply API

/api/v1/ai/review-reply

Generate a context-aware draft response to a customer review matching your tone and instructions.

Base Billing 1 Credit
Target Latency < 150ms (p50)
Client Timeout 5.0s (recommended)
SLA Guarantee 99.9% Uptime
JSON Contract Deterministic v1

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

1. Strict Timeout Windows

Configure a hard client timeout of 5 to 8 seconds. If network latency spikes, cancel connection to avoid holding open sockets in worker pools.

2. Exponential Backoff with Jitter

Upon receiving 429 Rate Limit or transient 5xx, pause with exponential backoff:
wait = min(max_backoff, base * 2^attempt + jitter).

3. Atomic Pre-Auth Locks

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").
model string Optional Optional AI model to use.

Example Request

This example demonstrates how to draft an empathetic reply for a negative review, providing custom directions.

JSON Request 
{
  "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-trigger.sh cURL 
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.

response.json JSON Response
200 OK 118ms 
{
  "success": true,
  "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": {
    "credits_used": 3,
    "credits_remaining": 984
  }
}

API Request Example

Use the cURL snippet below to test the endpoint.

curl-trigger.sh cURL 
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."
}'

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 (2 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.

Technical Q&A (FAQ)

We recommend setting a client timeout of 5 to 8 seconds. While average latency is under 150ms, large input payloads or complex reasoning models may require additional processing time.

RSFlowHub uses an atomic pre-flight check. Before processing, the gateway validates that your wallet has at least 2 base credits. If the request fails validation (422) or is malformed (400), no credits are charged.

When a 429 is received, your application should respect the 'Retry-After' header and use an exponential backoff retry policy with randomized jitter to prevent thundering herd problems.

Every successful response returns { "success": true, "data": { ... }, "meta": { "credits_used": int, "credits_remaining": int } }.

Ready to build?

Create your free account and make your first API call in minutes.

Get API Key Open Playground