README

Content Proofread Grammar API for PHP

📝 Proofread text and check grammar using AI

Check the full documentation on the Content Proofread Grammar API for PHP API page.

Quick Links

Resource	Link
Main API Documentation	Authorization, Webhooks, Polling & More
Postman Documentation	View Docs
Product Details	SharpAPI.com
SDK Libraries	GitHub - SharpAPI SDKs

Requirements

PHP >= 8.0

Installation

Step 1. Install the package via Composer:

composer require sharpapi/php-content-proofread-grammar

Step 2. Visit SharpAPI 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

require __DIR__ . '/vendor/autoload.php';

use SharpAPI\ContentProofread\ProofreadGrammarClient;
use GuzzleHttp\Exception\GuzzleException;

$apiKey = 'your_api_key_here';
$client = new ProofreadGrammarClient(apiKey: $apiKey);

try {
    $statusUrl = $client->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

{
    "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 for more information on what has changed recently.

Credits

A2Z WEB LTD
Dawid Makowski
Boost your PHP AI capabilities!

License

The MIT License (MIT). Please see License File for more information.

Social Media

🚀 For the latest news, tutorials, and case studies, don't forget to follow us on:

sharpapi / php-content-proofread-grammar

Maintainers

Details