About this endpoint
What it does
Submits text content for proofreading and grammar checking as an async job. The response returns a job identifier and a status URL that you can use to check progress and retrieve the result later.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| content | String | Yes | Provide the content to proofread. |
Response
Returns a JSON object with job_id and status_url string fields. job_id is the unique identifier of the submitted job, and status_url is the URL to poll for the job's status and result.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| job_id | String | No | The unique identifier of the submitted job. |
| status_url | String | No | URL to poll for the job's status and result. |
Notes
This endpoint kicks off an async job and returns immediately with a job identifier; the actual work runs in the background. Pair this call with the corresponding job_check endpoint — poll that until the status reaches a terminal state to retrieve the result. Use job_id to identify the submitted job, and status_url to poll for its status.