POST Comment Reply API
/api/v1/ai/comment-reply
Generate a contextual, engaging, and professional response to a social media comment using available contexts without inventing missing details.
Architecture Role & AI Definition
Comment 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 |
|---|---|---|---|
comment |
string | Required | The social media comment text (Max: 5,000 characters). |
business_name |
string | Optional | Optional business name to include in greeting or signature. |
business_context |
string | Optional | Optional business operational details context. |
post_context |
string | Optional | Optional post text context. |
product_context |
string | Optional | Optional product catalogs, details, or context. |
platform |
string | Optional | Optional social media platform name. |
tone |
string | Optional | Response tone. Options: "professional", "friendly", "casual", "empathetic", "concise". Default is "professional". |
language |
string | Optional | Optional response language. |
instructions |
string | Optional | Optional custom instructions to follow. |
model |
string | Optional | Optional AI model to use. |
Example Request
This example demonstrates how to generate a reply on Instagram based on business context and instructions.
curl -X POST https://rsflowhub.com/api/v1/ai/comment-reply \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"comment": "Do you ship to Mumbai? I would love to order this today!",
"business_name": "ArtisanFootwear",
"business_context": "We are an artisanal e-commerce shop delivering worldwide. Shipping is free within India.",
"platform": "Instagram",
"tone": "friendly",
"instructions": "Include a call to action to visit the link in bio."
}'Example Response
The response returns the drafted reply, tone, and language.
{
"success": true,
"request_id": "req_7f3a9c2d1e4b8a6f",
"data": {
"result": {
"reply_text": "Hi there! Yes, we absolutely ship to Mumbai! Shipping is completely free within India. Feel free to order yours today by visiting the link in our bio! 😊",
"language": "en",
"tone": "friendly"
}
},
"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/comment-reply' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"comment": "Do you ship to Mumbai? I would love to order this today!",
"business_name": "ArtisanFootwear",
"business_context": "We are an artisanal e-commerce shop delivering worldwide. Shipping is free within India.",
"platform": "Instagram",
"tone": "friendly",
"instructions": "Include a call to action to visit the link in bio."
}'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 |
|---|---|---|---|
| 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. |