An open API service indexing awesome lists of open source software.

https://github.com/sharpapi/php-content-proofread-grammar

SharpAPI PHP Client - php-content-proofread-grammar
https://github.com/sharpapi/php-content-proofread-grammar

Last synced: 9 days ago
JSON representation

SharpAPI PHP Client - php-content-proofread-grammar

Awesome Lists containing this project

README

          

![SharpAPI GitHub cover](https://sharpapi.com/sharpapi-github-laravel-bg.jpg "SharpAPI PHP Client")

# Content Proofread Grammar API for PHP

## 📝 Proofread text and check grammar using AI

[![Latest Version on Packagist](https://img.shields.io/packagist/v/sharpapi/php-content-proofread-grammar.svg?style=flat-square)](https://packagist.org/packages/sharpapi/php-content-proofread-grammar)
[![Total Downloads](https://img.shields.io/packagist/dt/sharpapi/php-content-proofread-grammar.svg?style=flat-square)](https://packagist.org/packages/sharpapi/php-content-proofread-grammar)

Check the full documentation on the [Content Proofread Grammar API for PHP API](https://sharpapi.com/en/catalog/ai/content-marketing-automation/proofread-grammar-checker) page.

---

## Quick Links

| Resource | Link |
|----------|------|
| **Main API Documentation** | [Authorization, Webhooks, Polling & More](https://documenter.getpostman.com/view/31106842/2s9Ye8faUp) |
| **Postman Documentation** | [View Docs](https://documenter.getpostman.com/view/31106842/2sBXVeGsVi) |
| **Product Details** | [SharpAPI.com](https://sharpapi.com/en/catalog/ai/content-marketing-automation/proofread-grammar-checker) |
| **SDK Libraries** | [GitHub - SharpAPI SDKs](https://github.com/sharpapi) |

---

## Requirements

- PHP >= 8.0

---

## Installation

### Step 1. Install the package via Composer:

```bash
composer require sharpapi/php-content-proofread-grammar
```

### Step 2. Visit [SharpAPI](https://sharpapi.com/) to get your API key.

---
## Laravel Integration

Building a Laravel application? Check the Laravel package version for better integration.

---

## What it does

Proofread text and check grammar using AI

---

## Usage
```php
proofreadText(
content: 'Your text content here',
language: 'English'
);

// Optional: Configure polling
$client->setApiJobStatusPollingInterval(10);
$client->setApiJobStatusPollingWait(180);

// Fetch results (polls automatically)
$result = $client->fetchResults($statusUrl);
$resultData = $result->getResultJson();

echo $resultData;
} catch (GuzzleException $e) {
echo "API error: " . $e->getMessage();
}
```

---

## Example Response
```json

{
"data": {
"type": "api_job_result",
"id": "2432f9ee-528a-4709-9916-2ab031df27ab",
"attributes": {
"status": "success",
"type": "content_proofread",
"result": "Red Bull's Max Verstappen says this weekend's Las Vegas Grand Prix is \"99% show and 1% sporting event\". \n\n The triple world champion said he is \"not looking forward\" to the razzmatazz around the race, the first time Formula 1 cars have raced down the city's famous Strip. \n\n Other leading drivers were more equivocal about the hype.\n\n Aston Martin's Fernando Alonso said: \"With the investment that has been made and the place we are racing, it deserves a little bit [of] different treatment and extra show.\" \n\n The weekend was kick-started on Wednesday evening with a lavish opening ceremony.\n\n It featured performances from several music stars, including Kylie Minogue and Journey, and culminated in the drivers being introduced to a sparsely populated crowd in rain by being lifted into view on hydraulic platforms under a sound-and-light show. \n\n Lewis Hamilton said: \"It's amazing to be here. It is exciting - such an incredible place, so many lights, a great energy, a great buzz. \n\n \"This is one of the most iconic cities there is. It is a big show, for sure. It is never going to be like Silverstone [in terms of history and purity]. But maybe over time the people in the community here will grow to love the sport.\" \n\n Hamilton added: \"It is a business, ultimately. You'll still see good racing here. \n\n \"Maybe the track will be good, maybe it will be bad. It was so-so on the [simulator]. Don't knock it 'til you try it. I hear there are a lot of people complaining about the direction [F1 president] Stefano [Domenicali] and [owners] Liberty have been going [but] I think they have been doing an amazing job.\""
}
}
}

```
---

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

---

## Credits

- [A2Z WEB LTD](https://github.com/a2zwebltd)
- [Dawid Makowski](https://github.com/makowskid)
- Boost your [PHP AI](https://sharpapi.com/) capabilities!

---

## License

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE.md)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

---

## Social Media

🚀 For the latest news, tutorials, and case studies, don't forget to follow us on:
- [SharpAPI X (formerly Twitter)](https://x.com/SharpAPI)
- [SharpAPI YouTube](https://www.youtube.com/@SharpAPI)
- [SharpAPI Vimeo](https://vimeo.com/SharpAPI)
- [SharpAPI LinkedIn](https://www.linkedin.com/products/a2z-web-ltd-sharpapicom-automate-with-aipowered-api/)
- [SharpAPI Facebook](https://www.facebook.com/profile.php?id=61554115896974)