Request text improvement

POST /v2/write/rephrase

Request text improvement

cURL

curl --request POST \
  --url https://api.deepl.com/v2/write/rephrase \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": [
    "this is a example sentence to imprve"
  ],
  "target_lang": "de",
  "writing_style": "academic",
  "tone": "confident"
}
'

200

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

Authorizations

Authorization · string · header · default: DeepL-Auth-Key · required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme. Example: DeepL-Auth-Key <api-key>

Body

application/jsonapplication/x-www-form-urlencoded

text · string[] · required

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

target_lang · enum<string>

The language for the text improvement.

Available options: de, en, en-GB, en-US, es, fr, it, ja, ko, pt, pt-BR, pt-PT, zh, zh-Hans

Example:

"de"

writing_style · enum<string>

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: academic, business, casual, default, simple, prefer_academic, prefer_business, prefer_casual, prefer_simple

tone · enum<string>

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: confident, default, diplomatic, enthusiastic, friendly, prefer_confident, prefer_diplomatic, prefer_enthusiastic, prefer_friendly

Response

200 - application/json

Successful text improvement.

improvements · object[]

Minimum array length: 1

Show child attributes