Skip to content

Update Write API docs for new capabilities #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JanEbbing merged 8 commits into from
Mar 31, 2026
Merged

Update Write API docs for new capabilities #283

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
aaae446
Update Write API docs for new capabilities
JanEbbing Mar 27, 2026
e969acb
docs: Add write api release to release doc
JanEbbing Mar 27, 2026
7c7bcf4
Revise Write API release notes
shirgoldbird Mar 27, 2026
a82dffe
nitpick
shirgoldbird Mar 27, 2026
b3d34fe
Apply suggestion from @shirgoldbird
shirgoldbird Mar 27, 2026
e5df32b
review comment: update write target languages
JanEbbing Mar 30, 2026
88fa09d
nit: fix casing
JanEbbing Mar 30, 2026
206b609
fix: Fix write api release date
JanEbbing Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions api-reference/improve-text.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,21 @@ curl -X POST 'https://api.deepl.com/v2/write/rephrase' \

<ParamField body="text" type="array[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. Each of the parameter values may contain multiple sentences.

All texts **must** be in the same language.
</ParamField>
<ParamField body="target_lang" type="string">
The language of the improved text. A list of supported languages have not yet been added to the `/languages` endpoint. At the time of the beta, the following languages are supported:
The language of the improved text. A list of supported languages have not yet been added to the `/languages` endpoint. As of March 2026, the following languages are supported:
Comment thread
shirgoldbird marked this conversation as resolved.
Outdated

* `de` (German)
* `en-GB` (British English)
* `en-US` (American English)
* `es` (Spanish)
* `fr` (French)
* `it` (Italian)
* `ja` (Japanese)
* `ko` (Korean)
* `pt-BR` (Brazilian Portuguese)
* `pt-PT` (Portuguese)
* `ZH`/`zh-Hans` (simplified Chinese)

The language of the source texts sent in the `text` parameter must match the target language (translating and improving text simultaneously is not yet supported).

Expand All @@ -97,9 +98,15 @@ curl -X POST 'https://api.deepl.com/v2/write/rephrase' \
</Expandable>
Currently supported for the following target languages:

* `de`
* `en-GB`
* `en-US`
* `de` (German)
* `en-GB` (British English)
* `en-US` (American English)
* `es` (Spanish)
* `fr` (French)
* `it` (Italian)
* `pt-BR` (Brazilian Portuguese)
* `pt-PT` (Portuguese)


Styles prefixed with `prefer_` will fall back to the `default` style when used with a language that does not support styles (this is recommended for cases where no `target_lang` is set), the non-prefixed writing styles (except `default`) will return a HTTP 400 error in that case.

Expand All @@ -124,9 +131,14 @@ curl -X POST 'https://api.deepl.com/v2/write/rephrase' \

Currently supported for the following target languages:

* `de`
* `en-GB`
* `en-US`
* `de` (German)
* `en-GB` (British English)
* `en-US` (American English)
* `es` (Spanish)
* `fr` (French)
* `it` (Italian)
* `pt-BR` (Brazilian Portuguese)
* `pt-PT` (Portuguese)

Tones prefixed with `prefer_` will fall back to the `default` tone when used with a language that does not support tones (this is recommended for cases where no `target_lang` is set), the non-prefixed tones (except `default`) will return a HTTP 400 error in that case.

Expand Down