POST Comment Analyze API
/api/v1/ai/comment-analyze
Analyze sentiment, intent category, topics, reply requirements, recommended actions, and priority of a single social media comment.
Architecture Role & AI Definition
Comment Analyze 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). |
language |
string | Optional | Optional comment language identifier. |
platform |
string | Optional | Optional platform name (e.g. "Instagram", "Facebook", "YouTube", "LinkedIn"). |
post_context |
string | Optional | Optional post content or media brief context. |
business_context |
string | Optional | Optional business, product, or account rules context. |
author_context |
string | Optional | Optional commenter context details. |
Example Request
This example demonstrates how to request an analysis of a single Instagram comment with post and business contexts.
curl -X POST https://rsflowhub.com/api/v1/ai/comment-analyze \
-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!",
"platform": "Instagram",
"post_context": "Photo of our new handcrafted leather boots collection",
"business_context": "We are an artisanal e-commerce shop delivering worldwide. Shipping is free within India."
}'Example Response
The response details comment intent classification, reply requirements, recommended priority, and action recommendation.
{
"success": true,
"request_id": "req_7f3a9c2d1e4b8a6f",
"data": {
"result": {
"sentiment": "positive",
"intent": "purchase_interest",
"language": "en",
"topics": [
"shipping",
"Mumbai",
"order interest"
],
"requires_reply": true,
"priority": "high",
"recommended_action": "reply",
"confidence": 0.98
}
},
"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-analyze' \
-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!",
"platform": "Instagram",
"post_context": "Photo of our new handcrafted leather boots collection",
"business_context": "We are an artisanal e-commerce shop delivering worldwide. Shipping is free within India."
}'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. |