Skip to content

Commit bec45f4

Browse files
JanEbbingshirgoldbirdBriannaDelgado
authored
Update Write API docs for new capabilities (#283)
* Update Write API docs for new capabilities Co-authored-by: Shir Goldberg <3937986+shirgoldbird@users.noreply.github.com> Co-authored-by: Brianna Delgado <brianna.delgado@deepl.com>
1 parent 0328171 commit bec45f4

3 files changed

Lines changed: 31 additions & 9 deletions

File tree

api-reference/improve-text.mdx

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,20 +60,21 @@ curl -X POST 'https://api.deepl.com/v2/write/rephrase' \
6060

6161
<ParamField body="text" type="array[string]" required>
6262
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.
63-
64-
All texts **must** be in the same language.
6563
</ParamField>
6664
<ParamField body="target_lang" type="string">
67-
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:
65+
The language of the improved text. A list of supported languages have not yet been added to the `/languages` endpoint. Currently, the following languages are supported:
6866

6967
* `de` (German)
7068
* `en-GB` (British English)
7169
* `en-US` (American English)
7270
* `es` (Spanish)
7371
* `fr` (French)
7472
* `it` (Italian)
73+
* `ja` (Japanese)
74+
* `ko` (Korean)
7575
* `pt-BR` (Brazilian Portuguese)
7676
* `pt-PT` (Portuguese)
77+
* `zh`/`zh-Hans` (simplified Chinese)
7778

7879
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).
7980

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

100-
* `de`
101-
* `en-GB`
102-
* `en-US`
101+
* `de` (German)
102+
* `en-GB` (British English)
103+
* `en-US` (American English)
104+
* `es` (Spanish)
105+
* `fr` (French)
106+
* `it` (Italian)
107+
* `pt-BR` (Brazilian Portuguese)
108+
* `pt-PT` (Portuguese)
109+
103110

104111
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.
105112

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

125132
Currently supported for the following target languages:
126133

127-
* `de`
128-
* `en-GB`
129-
* `en-US`
134+
* `de` (German)
135+
* `en-GB` (British English)
136+
* `en-US` (American English)
137+
* `es` (Spanish)
138+
* `fr` (French)
139+
* `it` (Italian)
140+
* `pt-BR` (Brazilian Portuguese)
141+
* `pt-PT` (Portuguese)
130142

131143
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.
132144

api-reference/openapi.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5068,9 +5068,13 @@ components:
50685068
- es
50695069
- fr
50705070
- it
5071+
- ja
5072+
- ko
50715073
- pt
50725074
- pt-BR
50735075
- pt-PT
5076+
- zh
5077+
- zh-Hans
50745078
example: de
50755079
UsageResponse:
50765080
type: object

docs/resources/roadmap-and-release-notes.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ rss: true
1111
</Update>
1212

1313
<Update label="March 2026">
14+
## March 31 - Write API Improvements
15+
- Improved overall quality of the models used in [DeepL API for Write](/api-reference/improve-text/)
16+
- Expanded Write `target_lang` support to Japanese (`JA`), Korean (`KO`) and simplified Chinese (`ZH` or `zh-Hans`)
17+
- Expanded Write support for `writing_style` and `tone` to Spanish (`ES`), Italian (`IT`), French (`FR`), Portuguese (`pt-PT`) and Brazilian Portuguese (`pt-BR`)
18+
- Allow sending Write texts in multiple source languages in the same request when no `target_lang` is set
19+
1420
## March 26 - Expanded Style Rules API
1521
- Added 5 new endpoints for style rule list operations: `POST /v3/style_rules`, `GET /v3/style_rules/{style_id}`, `PATCH /v3/style_rules/{style_id}`, `DELETE /v3/style_rules/{style_id}`, and `PUT /v3/style_rules/{style_id}/configured_rules`.
1622
- Added 4 new endpoints for managing custom instructions within style rule lists: `POST /v3/style_rules/{style_id}/custom_instructions`, `GET /v3/style_rules/{style_id}/custom_instructions/{instruction_id}`, `PUT /v3/style_rules/{style_id}/custom_instructions/{instruction_id}`, and `DELETE /v3/style_rules/{style_id}/custom_instructions/{instruction_id}`.

0 commit comments

Comments
 (0)