POST Ticket Analyze API
/api/v1/ai/ticket-analyze
Analyze category, intent, sentiment, priority, urgency, department routing, and recommended actions of a customer support ticket.
Architecture Role & AI Definition
Ticket 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 |
|---|---|---|---|
ticket |
string | Required | The customer support ticket message text (Max: 20,000 characters). |
subject |
string | Optional | Optional ticket subject header. |
language |
string | Optional | Optional ticket language identifier. |
customer_context |
string | Optional | Optional customer account details context. |
product_context |
string | Optional | Optional product catalogs or specs context. |
business_context |
string | Optional | Optional support operational policies or rules context. |
previous_messages |
array | Optional | Optional array of previous messages in the ticket conversation thread. |
Example Request
This example demonstrates how to request an analysis of a single login problem support ticket.
{
"ticket": "I cannot log in to my account. It keeps saying invalid password even after resetting it.",
"subject": "Login issue",
"customer_context": "User ID: 12345, Active Premium Subscription."
}curl -X POST https://rsflowhub.com/api/v1/ai/ticket-analyze \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"ticket": "I cannot log in to my account. It keeps saying invalid password even after resetting it.",
"subject": "Login issue",
"customer_context": "User ID: 12345, Active Premium Subscription."
}'Example Response
The response returns intent, category, department recommendations, urgency indicators, and priority level details.
{
"success": true,
"request_id": "req_7f3a9c2d1e4b8a6f",
"data": {
"result": {
"category": "account",
"intent": "restore_access",
"sentiment": "negative",
"priority": "high",
"urgency": "high",
"issue_summary": "Customer is unable to access their account due to password reset failures.",
"key_problem": "Password reset mechanism not restoring account access.",
"requires_human": true,
"suggested_department": "account_support",
"recommended_action": "assign_agent",
"language": "en",
"confidence": 0.96
}
},
"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/ticket-analyze' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"ticket": "I cannot log in to my account. It keeps saying invalid password even after resetting it.",
"subject": "Login issue",
"customer_context": "User ID: 12345, Active Premium Subscription."
}'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 3 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. |