Skip to content

Commit cdbe25d

Browse files
Daniel Jonesclaude
andcommitted
docs(v3-languages): promote to GA, deprecate v2/languages and v2/glossary-language-pairs
- Remove BETA tags and notices from all v3/languages docs - Rename retrieve-products.mdx to retrieve-resources.mdx - Restructure Languages nav: v3 pages promoted to primary, v2 moved to DEPRECATED subgroup - Add deprecated: true to GET /v2/languages and GET /v2/glossary-language-pairs in OpenAPI spec - Add deprecation Warning to v2/languages overview and auto-generated reference page - Add deprecation note to v2 glossaries overview for /v2/glossary-language-pairs - Add May 5 release notes entry covering all GA changes and deprecations - Remove v3/languages from "In active development" list Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 958b74b commit cdbe25d

13 files changed

Lines changed: 82 additions & 85 deletions

api-reference/glossaries.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ description: "Manage glossaries using the v2 endpoints"
99
This page documents `v2` glossary endpoints, legacy endpoints that let you create and manage glossaries for a single language pair.
1010

1111
[See here](/api-reference/multilingual-glossaries) for information on current `v3` endpoints. Using `v3` allows you to create, manage, and edit glossaries with entries in multiple language pairs, while still supporting monolingual functionality. [See here](/api-reference/glossaries/v2-vs-v3-endpoints) for an overview of the difference.
12+
13+
The `/v2/glossary-language-pairs` endpoint is also deprecated. Use [`GET /v3/languages?resource=glossary`](/api-reference/languages/retrieve-supported-languages-by-resource) instead.
1214
</Info>
1315

1416
This page describes how to use the `v2` endpoints to work with _monolingual_ glossaries - glossaries that map phrases in one language to phrases in another language. If you're new to glossaries, we suggest you use `v3` instead.

api-reference/languages.mdx

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
---
2-
title: "Retrieve languages"
2+
title: "Retrieve languages (v2)"
33
sidebarTitle: "Overview"
4-
description: "API reference for retrieving supported languages with the DeepL API."
4+
description: "Reference for the deprecated v2/languages endpoint. Migrate to v3/languages for new integrations."
55
---
66

7-
Get all currently supported source and target languages that can be used for text and document translation.
7+
<Warning>
8+
**`/v2/languages` is deprecated.** Use [`GET /v3/languages`](/api-reference/languages/retrieve-supported-languages-by-resource) instead, which covers all DeepL API resources and provides richer feature information. See the [migration guide](/api-reference/languages/migrate-from-v2-languages) for details.
9+
</Warning>
810

9-
<Info>
10-
As of April 2025, supported languages for [text improvement](/api-reference/improve-text) (DeepL API for Write) have not yet been added to the `/languages` endpoint; we'll be extending the `/languages` endpoint in the near future to include this information.
11-
</Info>
12-
<Info>
13-
To get languages available for glossaries, please see [here](/api-reference/multilingual-glossaries).
14-
</Info>
15-
We also provide a spec that is auto-generated from DeepL's OpenAPI file. [You can find it here](/api-reference/languages/retrieve-supported-languages).
11+
`GET /v2/languages` returns the source and target languages supported for text and document translation. New integrations should use `/v3/languages`, which exposes the same translation languages along with feature support for glossaries, voice, write, and other resources.
1612

17-
To understand how we'll update the `/languages` endpoint when we add translation support for a new language or language variant, please see [this article](/docs/resources/language-release-process).
13+
For background on how DeepL adds new translation languages and language variants, see [the language release process](/docs/resources/language-release-process). For the auto-generated reference spec for this endpoint, see [Retrieve supported languages](/api-reference/languages/retrieve-supported-languages).
1814

1915
<Tabs>
2016
<Tab title="cURL">

api-reference/languages/language-feature-use-cases.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: 'Common use cases'
3-
tag: "BETA"
43
description: "Pseudocode examples for common language and feature lookup patterns using the v3/languages endpoints."
54
---
65

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
---
22
openapi: get /v3/languages
33
title: "Retrieve languages"
4-
tag: "BETA"
54
---
65

7-
<Info>
8-
This endpoint is available for testing in BETA. Breaking changes may be pushed with little or no advance notice, and we provide no guarantees of stability.
9-
</Info>
Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
---
22
openapi: get /v3/languages/resources
33
title: "Retrieve language resources"
4-
tag: "BETA"
54
description: "Learn how to retrieve the list of DeepL API resources and their supported language features."
65
---
76

8-
<Info>
9-
This endpoint is available for testing in BETA. Breaking changes may be pushed with little or no advance notice, and we provide no guarantees of stability.
10-
</Info>
11-

api-reference/languages/retrieve-supported-languages-by-resource.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
---
22
title: 'Retrieve supported languages by resource'
3-
tag: "BETA"
43
sidebarTitle: 'Overview'
54
description: "Learn how to retrieve supported language and feature data across all DeepL API resources using the v3/languages endpoints."
65
---
76

87
Get information about all currently supported languages across all DeepL API resources.
98

109
<Info>
11-
These **BETA** endpoints replace `/v2/languages` and `/v2/glossary-language-pairs` (see the [migration guide](/api-reference/languages/migrate-from-v2-languages)). Do not use them in production; breaking changes may be pushed without advance notice (see the [changelog](/api-reference/languages/v3-languages-changelog)).
10+
The `/v3/languages` endpoints replace the deprecated `/v2/languages` and `/v2/glossary-language-pairs` endpoints. If you're currently using either, see the [migration guide](/api-reference/languages/migrate-from-v2-languages) for differences and code examples.
1211
</Info>
1312

1413
We also provide auto-generated API specs from DeepL's OpenAPI file, for use with API clients and code generation tools:
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
---
22
openapi: get /v2/languages
3-
title: "Retrieve supported languages"
3+
title: "Retrieve supported languages (v2)"
4+
tag: "DEPRECATED"
45
---
6+
7+
<Warning>
8+
**`/v2/languages` is deprecated.** Use [`GET /v3/languages`](/api-reference/languages/retrieve-supported-languages-by-resource) instead. See the [migration guide](/api-reference/languages/migrate-from-v2-languages) for details.
9+
</Warning>
10+

api-reference/languages/v3-languages-changelog.mdx

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22
title: 'v3/languages changelog'
3-
tag: "BETA"
43
sidebarTitle: 'Changelog'
5-
description: 'Changes and planned updates to the v3/languages endpoints during the beta period.'
4+
description: 'Changes to the v3/languages endpoints, including the GA release and prior breaking changes.'
65
---
76

8-
<Info>
9-
These endpoints are in **BETA**. We will try to announce breaking changes here before they land, but cannot guarantee
10-
advance notice. Do not use these endpoints in production.
11-
</Info>
12-
137
## Changes since the initial beta release
148

15-
This section lists dated changes to the API since the initial beta release.
9+
This section lists dated changes to the API.
10+
11+
### 5 May 2026 — General Availability
12+
13+
`/v3/languages` is now generally available. The endpoint replaces the deprecated `/v2/languages` and `/v2/glossary-language-pairs`. See the [migration guide](/api-reference/languages/migrate-from-v2-languages) for differences and code examples.
14+
15+
The breaking changes listed below were applied alongside the GA release.
1616

1717
### 5 May 2026
1818

@@ -111,17 +111,3 @@ from `GET /v3/languages` are sufficient to determine feature support for all pai
111111
### 19 March 2026
112112

113113
Initial beta release.
114-
115-
---
116-
117-
## Possible additions
118-
119-
These are under consideration and may or may not land before GA.
120-
121-
- **`native_name` field** on language objects — the language's name in that language (e.g. `"Deutsch"` for German).
122-
123-
---
124-
125-
## Current beta state
126-
127-
For the current API contract, see the [overview](/api-reference/languages/retrieve-supported-languages-by-resource) and the auto-generated reference pages linked there.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
---
22
openapi: "get /v2/glossary-language-pairs"
33
title: "List language pairs supported for glossaries"
4+
tag: "DEPRECATED"
45
playground: none
56
---
67

8+
<Warning>
9+
**`/v2/glossary-language-pairs` is deprecated.** Use [`GET /v3/languages?resource=glossary`](/api-reference/languages/retrieve-supported-languages-by-resource) instead. See the [migration guide](/api-reference/languages/migrate-from-v2-languages) for details.
10+
</Warning>
11+
712
<Info>This endpoint returns all possible language pairs for glossaries.
813
[This list of supported languages](/docs/getting-started/supported-languages) may also be useful.</Info>

api-reference/openapi.yaml

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -438,10 +438,10 @@ paths:
438438
example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
439439
style_id:
440440
description: |-
441-
Specify the [style rule list](/api-reference/style-rules) to use for the translation.
441+
Specify the [style rule list](/api-reference/style-rules) to use for the translation.
442+
443+
**Important:** The target language has to match the language of the style rule list.
442444
443-
**Important:** The target language has to match the language of the style rule list.
444-
445445
**Note:** Any request with the `style_id` parameter enabled will use `quality_optimized` models. Requests combining `style_id` and `model_type: latency_optimized` will be rejected.
446446
type: string
447447
example: 7ff9bfd6-cd85-4190-8503-d6215a321519
@@ -928,10 +928,15 @@ paths:
928928
- auth_header: [ ]
929929
/v2/glossary-language-pairs:
930930
get:
931+
deprecated: true
931932
tags:
932933
- ManageGlossaries
933934
summary: List Language Pairs Supported by Glossaries
934-
description: Retrieve the list of language pairs supported by the glossary feature.
935+
description: |-
936+
**Deprecated.** Use `GET /v3/languages?resource=glossary` instead, which returns per-language
937+
availability including source and target roles.
938+
939+
Retrieve the list of language pairs supported by the glossary feature.
935940
operationId: listGlossaryLanguages
936941
responses:
937942
200:
@@ -1830,10 +1835,15 @@ paths:
18301835
- auth_header: [ ]
18311836
/v2/languages:
18321837
get:
1838+
deprecated: true
18331839
tags:
18341840
- MetaInformation
18351841
summary: Retrieve Supported Languages
1836-
operationId: getLanguages
1842+
description: |-
1843+
**Deprecated.** Use `GET /v3/languages?resource=translate_text` (or the appropriate resource)
1844+
instead. See the [migration guide](https://developers.deepl.com/api-reference/languages/migrate-from-v2-languages)
1845+
for details.
1846+
operationId: getLanguagesV2
18371847
parameters:
18381848
- name: type
18391849
in: query
@@ -1970,8 +1980,6 @@ paths:
19701980
get:
19711981
tags:
19721982
- MetaInformation
1973-
- beta
1974-
x-beta: true
19751983
summary: Retrieve Language Resources
19761984
operationId: getLanguageResources
19771985
description: |-
@@ -2075,8 +2083,6 @@ paths:
20752083
get:
20762084
tags:
20772085
- MetaInformation
2078-
- beta
2079-
x-beta: true
20802086
summary: Retrieve Languages
20812087
operationId: getLanguages
20822088
description: |-
@@ -3247,8 +3253,8 @@ components:
32473253
auth_header:
32483254
type: apiKey
32493255
description: >
3250-
Authentication with `Authorization` header and
3251-
`DeepL-Auth-Key` authentication scheme. Example:
3256+
Authentication with `Authorization` header and
3257+
`DeepL-Auth-Key` authentication scheme. Example:
32523258
`DeepL-Auth-Key <api-key>`
32533259
name: Authorization
32543260
in: header
@@ -4662,8 +4668,8 @@ components:
46624668
Formality:
46634669
description: |-
46644670
Sets whether the translated text should lean towards formal or informal language.
4665-
This feature is only available for certain target languages. Setting this parameter
4666-
with a target language that does not support formality will fail, unless one of the
4671+
This feature is only available for certain target languages. Setting this parameter
4672+
with a target language that does not support formality will fail, unless one of the
46674673
`prefer_...` options are used.
46684674
Possible options are:
46694675
* `default` (default)
@@ -4893,15 +4899,15 @@ components:
48934899
$ref: '#/components/schemas/GlossaryEntryCount'
48944900
OutlineDetectionOption:
48954901
description: |-
4896-
Disable the automatic detection of XML structure by setting the `outline_detection` parameter
4897-
to `false` and selecting the tags that should be considered structure tags. This will split sentences
4902+
Disable the automatic detection of XML structure by setting the `outline_detection` parameter
4903+
to `false` and selecting the tags that should be considered structure tags. This will split sentences
48984904
using the `splitting_tags` parameter.
48994905
type: boolean
49004906
default: true
49014907
OutlineDetectionOptionStr:
49024908
description: |-
4903-
Disable the automatic detection of XML structure by setting the `outline_detection` parameter
4904-
to `false` and selecting the tags that should be considered structure tags. This will split sentences
4909+
Disable the automatic detection of XML structure by setting the `outline_detection` parameter
4910+
to `false` and selecting the tags that should be considered structure tags. This will split sentences
49054911
using the `splitting_tags` parameter.
49064912
type: string
49074913
default: '1'
@@ -4919,13 +4925,13 @@ components:
49194925
$ref: '#/components/schemas/GlossaryDictionary'
49204926
PreserveFormattingOption:
49214927
description: |-
4922-
Sets whether the translation engine should respect the original formatting, even if it would usually
4928+
Sets whether the translation engine should respect the original formatting, even if it would usually
49234929
correct some aspects.
49244930
type: boolean
49254931
default: false
49264932
PreserveFormattingOptionStr:
49274933
description: |-
4928-
Sets whether the translation engine should respect the original formatting, even if it would usually
4934+
Sets whether the translation engine should respect the original formatting, even if it would usually
49294935
correct some aspects.
49304936
type: string
49314937
enum:
@@ -4934,12 +4940,12 @@ components:
49344940
default: '0'
49354941
ShowBilledCharacters:
49364942
description: |-
4937-
When true, the response will include the billed_characters parameter, giving the
4943+
When true, the response will include the billed_characters parameter, giving the
49384944
number of characters from the request that will be counted by DeepL for billing purposes.
49394945
type: boolean
49404946
SplitSentencesOption:
49414947
description: |-
4942-
Sets whether the translation engine should first split the input into sentences.
4948+
Sets whether the translation engine should first split the input into sentences.
49434949
49444950
Possible values are:
49454951
* 0 - no splitting at all, whole input is treated as one sentence
@@ -4958,7 +4964,7 @@ components:
49584964
Language of the text to be translated. If this parameter is omitted, the API will attempt to
49594965
detect the language of the text and translate it.
49604966
4961-
For the full list of supported source languages, see [supported languages](https://developers.deepl.com/docs/getting-started/supported-languages) or query the [`GET /v3/languages` endpoint](https://developers.deepl.com/api-reference/languages/retrieve-supported-languages-by-resource) (beta).
4967+
For the full list of supported source languages, see [supported languages](https://developers.deepl.com/docs/getting-started/supported-languages) or query the [`GET /v3/languages` endpoint](https://developers.deepl.com/api-reference/languages/retrieve-supported-languages-by-resource).
49624968
example: EN
49634969
TranslationMemory:
49644970
type: object
@@ -5130,7 +5136,7 @@ components:
51305136
description: |-
51315137
The language into which the text should be translated.
51325138
5133-
For the full list of supported target languages, see [supported languages](https://developers.deepl.com/docs/getting-started/supported-languages) or query the [`GET /v3/languages` endpoint](https://developers.deepl.com/api-reference/languages/retrieve-supported-languages-by-resource) (beta).
5139+
For the full list of supported target languages, see [supported languages](https://developers.deepl.com/docs/getting-started/supported-languages) or query the [`GET /v3/languages` endpoint](https://developers.deepl.com/api-reference/languages/retrieve-supported-languages-by-resource).
51345140
example: DE
51355141
TargetLanguageWrite:
51365142
type: string

0 commit comments

Comments
 (0)