POST Sentiment Analysis API
/api/v1/ai/sentiment-analysis
Analyze the emotional tone of text to identify positive, negative, neutral, or mixed sentiments.
Architecture Role & AI Definition
Sentiment Analysis 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 |
|---|---|---|---|
text |
string | Required | The text content you want to analyze (Max: 5,000 characters). |
aspects |
array of strings | Optional | Optional list of specific topics to analyze sentiment for (e.g., ["UI", "billing", "speed"]). Max 10 items. |
model |
string | Optional | Optional. AI model to use for classification. Defaults to platform optimal model. |
Example Request (Basic)
{
"text": "The new dashboard is incredibly fast and looks amazing!"
}curl -X POST https://rsflowhub.com/api/v1/ai/sentiment-analysis \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"text": "The new dashboard is incredibly fast and looks amazing!"
}'Example Response (Basic)
The API guarantees the sentiment string will be one of: positive, negative, neutral, or mixed.
{
"success": true,
"data": {
"result": {
"sentiment": "positive",
"confidence": 0.98
}
},
"meta": {
"credits_used": 1,
"credits_remaining": 999
}
}Advanced Example (Aspect-Based Sentiment)
Provide an aspects array to get targeted sentiment scores for specific subjects mentioned in the text.
{
"text": "The dashboard is really fast, but the billing page is confusing and support took too long.",
"aspects": ["dashboard", "billing", "support"]
}{
"success": true,
"data": {
"result": {
"sentiment": "mixed",
"confidence": 0.85,
"aspect_sentiments": [
{
"aspect": "dashboard",
"sentiment": "positive",
"confidence": 0.95
},
{
"aspect": "billing",
"sentiment": "negative",
"confidence": 0.92
},
{
"aspect": "support",
"sentiment": "negative",
"confidence": 0.88
}
]
}
},
"meta": {
"credits_used": 1,
"credits_remaining": 998
}
}API Request Example
Use the cURL snippet below to test the endpoint.
curl -X POST 'https://rsflowhub.com/api/v1/ai/sentiment-analysis' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"text": "The dashboard is really fast, but the billing page is confusing.",
"aspects": [
"dashboard",
"billing"
]
}'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 (1 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. |