Skip to content
Writing

Get Correction Types

GET https://api.copyleaks.com/v1/writing-feedback/correction-types/{language_code}

Get a list of correction types supported within the Writing Assistant API. Correction types apply to all supported languages. The supplied language code for this request is used to determine the language of the texts returned.

language_code string required

The language for the returned texts to be in. Language codes are in ISO 639-1 standard. Supported Values: en - English

Authorization: Bearer YOUR_LOGIN_TOKEN
200 OK

The command was executed.

Example Response

A typical response from this endpoint:

Show full example (242 lines)
{
"correctionTypes": [
{
"title": "General",
"description": "A general correction detected.",
"message": "A general correction detected",
"id": 1,
"category": 2
},
{
"title": "Subject Verb Disagreement",
"description": "The subject and verb do not agree in number.",
"message": "Subject-verb disagreement detected",
"id": 2,
"category": 2
// ... truncated
400 Bad Request

Bad request. Language not supported.

Example Response

A typical response from this endpoint:

{
"ErrorMessage": "Language not supported",
"ErrorCode": "unsupported-lang"
}
correctionTypes array[object]

List of correction types and corresponding user interface information.

title string

Shortened capitalized name of the correction.

message string

A short explanation of the correction.

description string

A longer, more explicit explanation of the correction.

id integer

An identifier for the correction type.

category integer

Unsigned Integer


Category of the correction type.



Available Values:


1 : Sentence Structure


2 : Grammar


3 : Word Choice


4 : Mechanics



>= 1

GET https://api.copyleaks.com/v1/writing-feedback/correction-types/en
Authorization: Bearer YOUR_LOGIN_TOKEN