Proofread Text + Grammar Check API - ApyHub
apyhub-logo
FusionPlatformAPI CatalogPricingBlog

Proofread Text + Grammar Check API

Artificial IntelligenceData ExtractionMarketing#check#content#text
job
SharpAPI
SharpAPI
verified icon
1000 atoms
AI tier

About

The Proofreading and Grammar Check API ensures the provided text is grammatically correct and polished by automatically proofreading and checking for errors.
This API is perfect for developers working on writing tools, content management systems, or educational applications. It automates the proofreading process, ensuring text is grammatically correct and polished. Use cases include enhancing document editing software, improving content quality for blogs and articles, and providing grammar checking features in educational platforms.
Apy Jobs are long running calls which are split into two actions:
1. Submitting the job
2. Checking the status of the job and receiving the response on successful completion of the job.
Select API Endpoints
Input(s)

API Playground

API Documentation

Proofread Text + Grammar Check Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/content/proofread

Request example

1
```cURL
2


3
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/content/proofread' \
4
--header 'apy-token: {{token}}' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
    "content": "Red Bulls Max Verstappen says this weekends 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 citys famous Strip. \n\n Other leading drivers were more equivocal about the hype.\n\n Aston Martins 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 light rain by being lifted into view on hydraulic platforms under a sound-and-light show. \n\n Lewis Hamilton said: Its 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. Youll 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]. Dont 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."
8
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
contentStringYesProvide the content to proofread
Sample Response
1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/content/proofread/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
3
  "job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
4
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
202The job was submitted successfully.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - if the file is invalid or corrupted
500If any unexpected error occurs while submitting the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles