OpenAPI spec for text improvement

This page contains only a set of guides that is auto-generated from DeepL's OpenAPI file.

For more detail about text improvement, including information about request parameters, please see the Improve text entry.

Request text improvement

post

Authorizations

Body

application/jsonapplication/x-www-form-urlencoded

textstring[]required

Text to be improved. Only UTF-8-encoded plain text is supported. Improvements are returned in the same order as they are requested.

Example: this is a example sentence to imprve

target_langstring · enumoptional

The language for the text improvement.

Example: deAvailable options:

writing_stylestring · enumoptional

Specify a style to rephrase your text in a way that fits your audience and goals. The prefer_ prefix allows falling back to the default style if the language does not yet support styles.

Available options:

tonestring · enumoptional

Specify the desired tone for your text. The prefer_ prefix allows falling back to the default tone if the language does not yet support tones.

Available options:

Responses

application/json

200

200

{
  "improvements": [
    {
      "detected_source_language": "en",
      "text": "This is a sample sentence to improve."
    }
  ]
}

Successful text improvement.