API Endpoint

POST Grammar Fix API

/api/v1/ai/grammar-fix

Automatically correct spelling, grammar, and punctuation while giving developers full control over tone and dialect.

Request Body Parameters

Field	Type	Required	Description
`text`	string	Required	The raw text to be corrected (Max: 5,000 characters).
`tone`	string	Optional	Desired tone of the corrected text (e.g., "professional", "casual", "academic"). Default is "auto" (keeps original tone).
`dialect`	string	Optional	Target English dialect (e.g., "US", "UK", "AU"). Adjusts localized spellings like color vs colour. Default is "US".
`return_explanations`	boolean	Optional	Optional. If true, the API will return an array detailing exactly what was changed and why (similar to Grammarly).
`model`	string	Optional	Optional AI model to use.

Example Request (with Explanations)

This example demonstrates how to pass poorly written text and receive a heavily corrected version back with detailed explanations.

JSON Request

{
  "text": "I went to the store yesterday bcuz I need milk. the cashier was rude to me.",
  "tone": "professional",
  "dialect": "US",
  "return_explanations": true
}

cURL

curl -X POST https://rsflowhub.com/api/v1/ai/grammar-fix \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "I went to the store yesterday bcuz I need milk. the cashier was rude to me.",
    "tone": "professional",
    "dialect": "US",
    "return_explanations": true
  }'

Example Response

The response provides the cleanly rewritten text alongside the `explanations` array, which maps out every single grammar and tonal fix.

JSON Response

{
  "success": true,
  "data": {
    "result": {
      "corrected_text": "I went to the store yesterday because I needed milk. The cashier was impolite to me.",
      "changes_made": true,
      "explanations": [
        {
          "original": "bcuz",
          "corrected": "because",
          "reason": "Corrected informal slang to standard spelling."
        },
        {
          "original": "need",
          "corrected": "needed",
          "reason": "Adjusted verb tense to match the past tense context of 'yesterday'."
        },
        {
          "original": "the",
          "corrected": "The",
          "reason": "Capitalized the first letter of the sentence."
        },
        {
          "original": "rude",
          "corrected": "impolite",
          "reason": "Adjusted vocabulary to sound more professional."
        }
      ]
    }
  },
  "meta": {
    "credits_used": 1,
    "credits_remaining": 990
  }
}

API Request Example

Use the cURL snippet below to test the endpoint.