# Linguix Integration via LowCodeAPI

## Overview

Linguix is an AI writing assistant that provides grammar checking, spell checking, and style suggestions to improve your writing quality.

## Base Endpoint

```
https://api.lowcodeapi.com/linguix/
```

## Authentication

LowCodeAPI handles authentication automatically. You only need to:

1. **Sign up** at https://linguix.com/
2. **Connect your account** in LowCodeAPI dashboard
3. **Use your `api_token`** in all requests

The `api_token` is your LowCodeAPI authentication token. LowCodeAPI will automatically:
- Fetch your Linguix API key from database
- Apply it to each request with proper Bearer token header

**Auth Type**: `API Key` (Bearer Token)

## API Categories

- Utilities
- Linguix API

## Common Endpoints

### Category: Linguix API

#### Check Text

**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects`

**Full URL**:
```
https://api.lowcodeapi.com/linguix/v1/projects?api_token={api_token}
```

**Description**: Analyze text for grammar, spelling, and style issues. Returns alerts with suggestions and text statistics.

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_token` | string | Yes | Your LowCodeAPI authentication token |

**Request Body Parameters**:

Provide your text content in the request body. The API will analyze the text and return:
- Grammar and spelling errors with suggested corrections
- Style suggestions for improving readability
- Text statistics (word count, character count, reading time, etc.)

**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/linguix/v1/projects?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "She upload the file to the cloud, so she can access it anywhere."
  }'
```

**Example Response**:
```json
{
  "data": {
    "alerts": [
      {
        "length": 6,
        "offset": 4,
        "message": "Possible grammar mistake found.",
        "category": "Noun Number",
        "replacements": ["uploads"]
      },
      {
        "length": 3,
        "offset": 32,
        "message": "Use a comma before 'so' if it connects two independent clauses.",
        "category": "Punctuation",
        "replacements": [", so"]
      }
    ],
    "stats": {
      "wordsCount": 16,
      "charsCount": 70,
      "sentencesCount": 2,
      "avgWordLength": 4.38,
      "avgSentenceLength": 8,
      "fleschIndex": 75.5,
      "readingTimeSeconds": 5,
      "speakingTimeSeconds": 8,
      "textScore": 85
    }
  }
}
```

**Official Documentation**: https://help.linguix.com/docs/linguix-api/linguix-checker-rest-api/

---

## Usage Examples

### Example 1: Grammar Check a Blog Post

Check your blog content for errors before publishing.

```bash
# Analyze blog post for grammar and style issues
# Returns corrections and readability score
curl -X POST "https://api.lowcodeapi.com/linguix/v1/projects?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Content marketing are essential for buisnesses who want to grow there online presence. It helps build trust and authority in your industry."
  }'
```

### Example 2: Check Email Communication

Ensure professional email communications.

```bash
# Proofread important emails before sending
# Catches grammar mistakes and suggests improvements
curl -X POST "https://api.lowcodeapi.com/linguix/v1/projects?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Dear Team, I wanted to thankyou for your hard work on the recent project. The client was very impress with the results. Lets continue this momentum into the next quater."
  }'
```

### Example 3: Get Document Statistics

Analyze text complexity and reading time.

```bash
# Get detailed text statistics for content planning
# Returns word count, reading time, and readability score
curl -X POST "https://api.lowcodeapi.com/linguix/v1/projects?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "This is a sample article that we want to analyze for reading time and complexity. Understanding these metrics helps us optimize content for our target audience."
  }'
```

## Response Details

### Alert Object

Each alert in the response contains:

- `length`: Number of characters in the error
- `offset`: Character position where the error starts
- `message`: Description of the issue
- `category`: Type of error (Grammar, Spelling, Punctuation, Style)
- `replacements`: Array of suggested corrections

### Statistics Object

- `wordsCount`: Total number of words
- `charsCount`: Total number of characters
- `sentencesCount`: Number of sentences
- `avgWordLength`: Average word length
- `avgSentenceLength`: Average sentence length
- `fleschIndex`: Readability score (0-100, higher = easier to read)
- `readingTimeSeconds`: Estimated reading time in seconds
- `speakingTimeSeconds`: Estimated speaking time in seconds
- `textScore`: Overall quality score (0-100)

## Complete Endpoint Reference

For a complete list of all endpoints and their parameters, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/linguix/definition`
- **Official Provider Documentation**: https://help.linguix.com/docs/linguix-api/linguix-checker-rest-api/

## Rate Limits & Best Practices

- Break long texts into manageable sections for best results
- Review all suggestions before applying them
- Use the readability score to target appropriate complexity level for your audience

## Error Handling

Standard HTTP status codes apply. Check that your API key is valid and properly formatted in the request headers.