DeepLearnAI
Developer Platform
Get API Key

Proof Read Text

POST https://api.deep-learn.ai/v1/text/proofread

Given some source text, the DeepLearn model will proofread and correct the text. It will also provide a summary of changes made.

Request body

text
string
Required

The text to be proofread and corrected.

learnerDescription
string
Optional

A description of the learner. For example: "A beginner learning about machine learning."

learnerLanguageLevel
string
Optional
Defaults to "adult"

The language level of the learner, such as "adult", "English as a second language".

Returns

correctedText
string

The proofread and corrected text.

changes
string

A summary of changes made to the text during proofreading.

success
boolean

Indicates if the request was successful.

errorCode
number or null

The error code if the request was not successful.

errorMessage
string or null

The error message if the request was not successful.