Skip to content

CHANGELOG.md

Latest commit

 

History

History
339 lines (264 loc) · 13.4 KB

CHANGELOG.md

File metadata and controls

339 lines (264 loc) · 13.4 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

The major and minor version numbers reflect changes to the DeepL API (backward-incompatible and backward-compatible, respectively). The patch version number is used only for corrections to the OpenAPI specification, for example: typos, schema fixes, or adding examples.

Unreleased

Added

  • Document X-Trace-ID response header returned by all API endpoints for request tracking and debugging
  • Add new parameters to the text translation API: enable_beta_languages and custom_instructions
  • Add new CRUD endpoints for /v3/style_rules
  • Add new endpoint GET /v3/translation_memories for listing translation memories
  • Add new parameters translation_memory_id and translation_memory_threshold to /v2/translate
  • Add format: uuid to StyleId schema

Fixed

  • Fixes/development changes to the voice API.
    • Changed the voice paths in the voice.asyncapi.* files to use /v3/voice/*
    • Renamed SourceDataChunk and EndOfSourceData to SourceMediaChunk and EndOfSourceMedia
  • Fixes the usage endpoint response object name. Should be key_usages and key_and_day_usages instead of grouped_usage
  • Add all supported languages to Translate API source_lang and target_lang specs
  • Merge redundant SourceLanguageText and TargetLanguageText schemas into SourceLanguage and TargetLanguage to eliminate duplication

Deprecated

  • Removed the openapi_gitbook.yaml file due to redundancy. Please use openapi.yaml going forward

[3.10.0] - 2025-01-27

Added

  • Add speech_to_text_milliseconds field to developer key usage limits in /v2/admin/developer-keys/limits endpoint and ApiKey response schema

3.9.0 - 2025-12-11

Added

  • Add speech_to_text_milliseconds field to usage reports and analytics components
  • Add speech_to_text_milliseconds_count and speech_to_text_milliseconds_limit fields to /v2/usage response for API Pro users
  • Add billing_unit, api_key_unit_count, and account_unit_count fields to product usage items in /v2/usage response

3.8.0 - 2025-11-26

Fixed

  • Fixes/development changes to the voice API. Note that this API is under active develpoment and not yet stable.
    • Change voice path to be /v3/voice/realtime and /v3/voice/realtime/connect
    • Renamed voice parameter from media_content_type to source_media_content_type
    • Allow more formality values on voice endpoints

3.7.0 - 2025-11-10

Added

  • Add new endpoints /v1/voice/realtime (REST) and /v1/voice/realtime/connect (WebSocket) which enable real-time voice transcription and translation via WebSocket streaming
  • Adds AsyncAPI specification - voice.asyncapi.yaml and voice.asyncapi.json - documenting the Voice WebSocket streaming protocol

3.6.1 - 2025-11-06

Changed

  • Hebrew (HE), Thai (TH), and Vietnamese (VI) are now included in the /v2/languages endpoint response as they now support document translation in addition to text translation

3.6.0 - 2025-10-29

Added

  • Add new parameter tag_handling_version to /v2/translate

3.5.0 - 2025-10-27

Added

  • Add new endpoint v2/admin/analytics which enables admins to retrieve usage statistics across their organization

3.4.2 - 2025-10-06

Added

  • Latin American Spanish (ES-419) is now supported as a target language option for Document translation. /v2/languages now includes ES-419 as a valid target language option.

3.4.1 - 2025-07-31

Added

  • Add note for boolean values about how to input for URL-encoded forms

3.4.0 - 2025-07-16

Added

  • Add new endpoints /v2/admin/developer-keys which enables management of developer keys within an organization.

3.3.1 - 2025-07-16

Fixed

  • Added application/x-www-form-urlencoded Content-Type to the replaceDictionary endpoint.

3.3.0 - 2025-06-25

Fixed

  • Updated the possible error responses for the /v2 and /v3 glossary endpoints including:
    • Removing any errors that are not valid responses for the API
    • Updating the QuotaExceededGlossaries description as it is returned when the glossary creation limit has been reached

3.2.0 - 2025-06-03

Added

  • Added updated language support for document translation:
    • Target language variant: Chinese (traditional) (ZH-HANT)
    • Source and target language: Arabic (AR)
  • Added updated language support for text translation for Hebrew (HE), Thai (TH), and Vietnamese (VI). These languages are only supported for text translation, document translation support is coming soon.
  • Added updated source and target for glossaries. All languages supported for text translation are now supported for glossaries now including: Arabic (AR), Bulgarian (BG), Czech (CS), Greek (EL), Estonian (ET), Hebrew (HE), Hungarian (HU), Indonesian (ID), Lithuanian (LT), Latvian (LV), Slovak (SK), Slovenian (SL), Thai (TH), Turkish (TR), Ukrainian (UK), and Vietnamese (VI).

3.1.1 - 2025-05-23

Fixed

  • Fixed incorrect placement of UsageResponse schema.

3.1.0 - 2024-05-20

Changed

  • /v2/usage: Now returns a detailed response for API Pro users, including per-product usage and billing period information. For API users not on the Pro plan, the response remains unchanged and only includes character_count and character_limit.

3.1.0 - 2024-05-20

Fixed

  • Fixed new server URLs to avoid double slash in paths

3.0.1 - 2025-04-24

Fixed

  • Fixed new server URLs to avoid double slash in paths

3.0.0 - 2025-04-24

Added

  • Add new endpoints /v3/glossaries which enables management of new, editable and multilingual glossaries
    • This required renaming some existing components in the spec, hence the major version upgrade. All functionality is backwards compatible.
  • Moved /v2/ and /v3/ from the Server URL into the endpoint paths, as we support multiple versions now

2.18.0 - 2025-01-16

Added

  • Add new endpoint /write/rephrase which enables text corrections and adjustments in selected languages

2.17.0 - 2024-11-15

Added

  • /translate: add model_type request parameter to request the model type (quality_optimized, latency_optimized, or prefer_latency_optimized) to use for translation, and the model_type_used response parameter indicating the model type that used.

2.16.0 - 2024-07-25

Added

  • Add supported target language variant for text translation: Chinese (traditional) (ZH-HANT). Traditional Chinese is currently supported only for text translation; document translation support is coming soon.

Changed

  • The Chinese language codes returned in the /languages response for target languages were changed. While previously only ZH "Chinese (simplified)" was included, ZH-HANS "Chinese (simplified)" is now listed too. Both language codes are supported for text and document translation.

Deprecated

  • The target language code ZH is deprecated; instead ZH-HANS or ZH-HANT should be used.

2.15.0 - 2024-07-03

Added

  • Add supported glossary language: Romanian (ro).

2.14.1 - 2024-06-18

Changed

  • Text translation context parameter is now generally available (was alpha).

2.14.0 - 2024-05-08

Added

  • Added supported glossary languages: Danish ('da'), Norwegian (bokmål) ('nb'), and Swedish ('sv').

2.13.0 - 2024-03-14

Deprecated

  • Remove all properties from /usage except for character_count and character_limit; these are the only two properties included in the API response for the v2 API.

Fixed

  • Fixed some minor issues in specs that were violating OpenAPI specification.

2.12.0 - 2024-02-29

Added

  • Add supported glossary language: Korean (KO).
  • Add supported language for text translation: Arabic (AR). Arabic is currently supported only for text translation; document translation support for Arabic is coming soon.

2.11.0 - 2023-08-03

Added

  • Add supported glossary languages: Portuguese (PT), Russian (RU), and Chinese (ZH).

2.10.0 - 2023-07-13

Added

  • Add JSON-format request bodies to all endpoints except document upload.

2.9.2 - 2023-06-20

Added

  • Japanese (JA) now supports formality.

2.9.1 - 2023-05-26

Fixed

  • Fix typo in /glossaries/{glossary_id} example and spec version number.
  • Move description parameter outside of allOf parameter.

2.9.0

Added

  • Transitive glossaries are now supported, bringing the number of supported glossary pairs from 8 to 28.

Changed

  • Supported XLIFF version 2.1 is now explicitly stated.

2.8.0

Added

  • Add Korean and Norwegian (Bokmål) languages.

2.7.0

Added

  • Add XLIFF to supported document types.

2.6.0

Changed

  • HTML handling is no longer in Beta.
  • Removed limit on text parameters (was 50).

2.5.0

Added

  • Add support for EN (English) ←→ NL (Dutch) glossaries.

2.4.0

Added

  • Add formality options prefer_less and prefer_more.
  • Add note to readme about Swagger UI simulator and CORS restrictions.

2.3.1

Fixed

  • Source and target language were mixed up in glossary example.
  • Fix createGlossary example: remove punctuation.

2.3.0

Added

  • Add Ukrainian source and target languages.

Changed

  • Add request body size limit to translateText description.

Fixed

  • Add "Simplified" label to ZH (Chinese) target language.
  • Fix a typo in an example.
  • Markdown fixes.

2.2.0

Added

  • Add support for EN (English) ←→ PL (Polish) glossaries.

Fixed

  • EN (English) ←→ IT (Italian) was missing from the list of supported glossary language pairs in the JSON OpenAPI spec.

2.1.0

Added

  • Add CSV entries format for creating glossaries.

Changed

  • Rename some tags, reword some descriptions and label default values in descriptions.
  • Add note about glossaries being immutable, and a workaround for modifying glossaries.

2.0.0

Initial release of the OpenAPI specification.