API Endpoint

POST Email Analyze API

/api/v1/ai/email-analyze

Analyze incoming emails using AI to extract structured insights such as category, intent, priority, sentiment, language, entities, and summary.

Request Body Parameters

Field	Type	Required	Description
`email_content`	string	Required	The main body of the email to analyze (Max: 20,000 characters).
`subject`	string	Optional	Optional email subject line. Providing this increases analysis accuracy.
`allowed_categories`	array of strings	Optional	Optional list of allowed categories. If provided, the AI forces the output category into one of these buckets.
`allowed_intents`	array of strings	Optional	Optional list of allowed intents. If provided, the AI forces the output intent into one of these buckets.
`custom_instructions`	string	Optional	Optional specific guidelines to customize the analysis or extraction process.
`model`	string	Optional	Optional AI model to use.

Recommended API Pipeline

RsFlowHub email automation APIs are designed to work together sequentially. In a typical flow, you first Analyze the email, then generate a tailored Reply based on the analysis, and finally determine the Workflow routing decision.

1. 🧠 Email Analyze API — Understand category, intent, priority, sentiment, entities, and summary.

2. ✍️ Email Reply API — Draft the best response (with context, tones, and knowledge rules).

3. 🔀 Email Workflow API — Decide target routing, departments, or escalation path.

Example Request

Send an email body with optional lists of expected categories and intents to get structured analysis data.

JSON Request

{
  "subject": "Double charged on my last invoice!",
  "email_content": "Hello, I was looking at my bank statement and I was charged twice for my Pro subscription this month. Please refund one of the charges immediately as this is unacceptable.",
  "allowed_categories": ["support", "billing", "spam", "sales"],
  "allowed_intents": ["refund_request", "cancellation", "login_issue"]
}

cURL

curl -X POST https://rsflowhub.com/api/v1/ai/email-analyze \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Double charged on my last invoice!",
    "email_content": "Hello, I was looking at my bank statement and I was charged twice for my Pro subscription this month. Please refund one of the charges immediately as this is unacceptable.",
    "allowed_categories": ["support", "billing", "spam", "sales"],
    "allowed_intents": ["refund_request", "cancellation", "login_issue"]
  }'

Example Response

The API analyzes the text using AI and returns high-accuracy structured insights.

JSON Response

{
  "success": true,
  "data": {
    "result": {
      "category": "billing",
      "intent": "refund_request",
      "priority": "high",
      "sentiment": "negative",
      "language": "en",
      "entities": {
        "charge_amount": "$49",
        "billing_cycle": "monthly"
      },
      "summary": "The customer was double charged for their Pro subscription and is demanding an immediate refund."
    }
  },
  "meta": {
    "credits_used": 2,
    "credits_remaining": 998
  }
}

API Request Example

Use the cURL snippet below to test the endpoint.