# DeepL Documentation ## Docs - [Quickstart](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/getting-started/quickstart.md) - [About](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/getting-started/about.md) - [SDKs](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/getting-started/client-libraries.md): Using your favorite programming language with the DeepL API - [Languages supported](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/getting-started/supported-languages.md): The DeepL API supports the following languages. - [Language release process](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/resources/language-release-process.md): Here's what API users can expect when DeepL adds translation support for a new language or language variant. - [Translation: a beginner's guide](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/examples-and-guides/translation-beginners-guide.md): An introduction to sending translation requests with the DeepL API - [How to Use the Context Parameter Effectively](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/examples-and-guides/how-to-use-context-parameter.md): Learn when and how to use the context parameter to improve translation accuracy for ambiguous content. - [How to Use Custom Reporting Tags](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/examples-and-guides/how-to-use-custom-reporting-tags.md): Learn how to attach reporting tags to translate requests so you can break down usage by team, project, or category. - [How to Translate Between Language Variants](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/examples-and-guides/translating-between-variants.md): Learn how to translate between language variants, like British English and US English, using the DeepL API. - [How to Apply Customizations to Language Variants](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/examples-and-guides/customizations-for-variants.md): Learn how to apply glossaries and style rules when translating into language variants like FR-CA or EN-GB. - [Mustache placeholder tags](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/examples-and-guides/placeholder-tags.md): An example for working with placeholder tags—in this case, Mustache tags. - [Language detection](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/best-practices/language-detection.md) - [Document translations](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/best-practices/document-translations.md) - [XML handling](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/xml-and-html-handling/xml.md): Learn how to translate XML content with the DeepL API. - [Structured XML content](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/xml-and-html-handling/structured-content.md): Learn how to work with structured XML content with the DeepL API. - [HTML handling](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/xml-and-html-handling/html.md): Learn how to translate HTML content with the DeepL API. - [Customized XML outline detection](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/xml-and-html-handling/customized-xml-outline-detection.md): Learn how to customize XML outline detection with the DeepL API. - [New: XML/HTML handling v2](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/xml-and-html-handling/tag-handling-v2.md): Learn about the benefits of tag handling v2 and how to migrate. - [Glossaries in the real world](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/examples-and-guides/glossaries-in-the-real-world.md): A quick guide to using DeepL glossaries in translations - [Custom instructions](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/best-practices/custom-instructions.md): Learn how to create effective custom instructions to customize your translation behavior - [Translate text using a translation memory](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/examples-and-guides/how-to-use-translation-memories.md): Learn how to retrieve your translation memories and use them in translation requests - [Managing API keys](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/getting-started/managing-api-keys.md): A guide to creating API keys, getting API key-level usage, setting API key-level limits, and scoping keys to specific endpoints. - [Retrieving usage data](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/retrieving-usage-data.md): Learn how to retrieve and monitor your DeepL API usage data. - [Regional API Endpoints](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/getting-started/regional-endpoints.md): Reference documentation for DeepL's regional API endpoints, including endpoint URLs, configuration, and technical specifications. - [Estimating Character Usage](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/best-practices/estimating-character-usage.md): Learn how to estimate your DeepL API character usage to find the right plan. - [Pre-production checklist](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/best-practices/pre-production-checklist.md): Here's what we recommend reviewing to get your DeepL API application ready for production. - [Error handling](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/best-practices/error-handling.md) - [Subscription-level cost control](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/best-practices/cost-control.md) - [CORS requests](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/best-practices/cors-requests.md) - [Usage and limits](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/resources/usage-limits.md) - [Automating Indie Game Localization with the DeepL API and Godot](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/cookbook/automating-indie-game-localization-with-the-deepl-api-and-godot.md): Efficiently translate content for a global audience and widen your game's reach - [Making API calls from client-side JavaScript](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/cookbook/nodejs-proxy.md): Two lightweight local proxies that let you try the DeepL API directly from a website - [Building a Document Translator with the DeepL API](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/cookbook/java-document-translator.md): Streamline document localization workflows with automated translation for businesses and developers - [Usage Analytics Dashboard](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/cookbook/usage-analytics-dashboard.md): A demo dashboard for visualizing DeepL API key usage across an entire account using the Admin API. - [Sending Custom Reporting Tags with Client Libraries](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/cookbook/sending-custom-reporting-tags-from-client-libraries.md): Code snippets for attaching X-DeepL-Reporting-Tag to translate requests using the official DeepL client libraries. - [API Usage Logger](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/cookbook/api-usage-logger.md): Learn how to capture per-request DeepL API usage data and visualize it in a local dashboard. - [DeepL MCP Server: How to build and use translation in LLM applications](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/examples-and-guides/deepl-mcp-server-how-to-build-and-use-translation-in-llm-applications.md): Efficiently translate content with AI-powered translation and enhance your interactions with large language models. - [Project: Google Sheets](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/learning-how-tos/cookbook/google-sheets.md): Open-source example showing how to build a Google Sheets App using the DeepL API. - [DeepL CLI](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/getting-started/deepl-cli.md): Install and use the DeepL CLI to translate text, documents, and more from your terminal. - [DeepL MCP Server](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/getting-started/deepl-mcp-server.md): Use the DeepL MCP Server to add translation capabilities to Claude, Cursor, and other AI agents. - [Docs MCP Server](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/getting-started/docs-mcp-server.md): Connect your AI tools to the DeepL developer documentation for source-grounded answers about the DeepL API. - [Postman](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/getting-started/test-your-api-requests-with-postman.md): Use our official Postman collection to get familiar with and test the DeepL API. - [Developer Community](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/resources/deepl-developer-community.md) - [OpenAPI spec](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/resources/open-api-spec.md): Download the OpenAPI specification for the DeepL API - [API Status Page](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/resources/api-status-page.md): Monitor the operational status and availability of the DeepL API - [Changelog](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/resources/roadmap-and-release-notes.md): The latest features and improvements in the DeepL API, plus what's coming next - [Alpha and beta features](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/resources/alpha-and-beta-features.md): Learn more about alpha and beta features in the DeepL API and how to best make use of them. - [Breaking changes (Change Notices)](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/resources/breaking-changes-change-notices.md) - [July 2024: Deprecation of insecure cipher suites](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/resources/breaking-changes-change-notices/july-2024-deprecation-of-insecure-cipher-suites.md) - [March 2025: Deprecating GET requests to /translate and authenticating with auth_key](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/resources/breaking-changes-change-notices/march-2025-deprecating-get-requests-to-translate-and-authenticating-with-auth_key.md) - [November 2025: Deprecation of query parameter and request body authentication](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/docs/resources/breaking-changes-change-notices/november-2025-deprecation-of-legacy-auth-methods.md) - [Translate Text](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/translate.md): API reference for translating text with the DeepL API. - [Translate text](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/translate/request-translation.md) - [Translate documents](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/document.md) - [Upload and translate a document](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/document/upload-and-translate-a-document.md) - [Check document status](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/document/check-document-status.md) - [Download translated document](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/document/download-translated-document.md) - [Detect Language](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/detect-language/detect-language-beta.md): Detect the language of text using DeepL's language detection service - [Glossaries](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/multilingual-glossaries.md): Manage and use DeepL glossaries - [List language pairs supported for glossaries](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/multilingual-glossaries/list-language-pairs-supported-by-glossaries.md): **Deprecated.** Use `GET /v3/languages?resource=glossary` instead, which returns per-language availability including source and target roles. - [Create a glossary](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/multilingual-glossaries/create-a-glossary.md) - [List all glossaries](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/multilingual-glossaries/list-all-glossaries.md): List all glossaries and their meta-information, but not the glossary entries. - [Retrieve glossary details](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/multilingual-glossaries/retrieve-glossary-details.md): Retrieve meta information for a single glossary, omitting the glossary entries. - [Edit glossary details](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/multilingual-glossaries/edit-glossary-details.md): Edit glossary details, such as name or a dictionary for a source and target language. - [Retrieve glossary entries](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/multilingual-glossaries/retrieve-glossary-entries.md): List the entries of a single glossary in tsv format. - [Delete a glossary](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/multilingual-glossaries/delete-a-glossary.md): Deletes the specified glossary. - [Deletes the dictionary associated with the given language pair with the given glossary ID.](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/multilingual-glossaries/deletes-the-dictionary-associated-with-the-given-language-pair-with-the-given-glossary-id.md) - [Replaces or creates a dictionary in the glossary with the specified entries.](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/multilingual-glossaries/replaces-or-creates-a-dictionary-in-the-glossary-with-the-specified-entries.md) - [Monolingual glossaries (v2 endpoints)](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/glossaries.md): Manage glossaries using the v2 endpoints - [v2 vs v3 endpoints](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/glossaries/v2-vs-v3-endpoints.md) - [Create a glossary](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/glossaries/create-a-glossary.md) - [List all glossaries](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/glossaries/list-all-glossaries.md): List all glossaries and their meta-information, but not the glossary entries. - [Retrieve glossary details](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/glossaries/retrieve-glossary-details.md): Retrieve meta information for a single glossary, omitting the glossary entries. - [Retrieve glossary entries](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/glossaries/retrieve-glossary-entries.md): List the entries of a single glossary in the format specified by the `Accept` header. - [Delete a glossary](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/glossaries/delete-a-glossary.md): Deletes the specified glossary. - [Style rules](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/style-rules.md): Manage a shared list of rules for style, formatting, and more - [Get all style rule lists](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/style-rules/list-all-style-rules.md) - [Create a style rule list](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/style-rules/create-style-rule.md) - [Get a style rule list](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/style-rules/get-style-rule.md) - [Update a style rule list's name](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/style-rules/update-style-rule.md) - [Replace configured rules](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/style-rules/update-configured-rules.md) - [Delete a style rule list](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/style-rules/delete-style-rule.md) - [Create a custom instruction](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/style-rules/create-custom-instruction.md) - [Get a custom instruction](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/style-rules/get-custom-instruction.md) - [Replace a custom instruction](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/style-rules/update-custom-instruction.md) - [Delete a custom instruction](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/style-rules/delete-custom-instruction.md) - [List translation memories](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/translation-memory/list-translation-memories.md): Retrieve translation memories associated with your account, used to store and reuse previously created translations. See [How to use translation memories](/docs/learning-how-tos/examples-and-guides/how-to-use-translation-memories) to use them in translation requests. - [Translate Speech in Realtime](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/voice.md): API reference for real-time voice transcription and translation with the DeepL Voice API. - [Request Session](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/voice/request-session.md) - [WebSocket Streaming](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/voice/websocket-streaming.md): WebSocket channel for streaming audio and receiving transcriptions and translations. Messages are exchanged in JSON or MessagePack format. WebSocket messages are exchanged in TEXT frames when using JSON format and in BINARY frames when using MessagePack format. Sending the wrong frame type will resu… - [Reconnect Session](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/voice/reconnect-session.md) - [Improve text](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/improve-text.md) - [Improve text](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/improve-text/request-text-improvement.md): Improves text by correcting spelling and grammar and rewriting for a target writing style or tone. - [Correct text](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/improve-text/correct-text.md): Fixes spelling and grammar errors with minimal changes to wording. - [Retrieve supported languages by resource](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/languages/retrieve-supported-languages-by-resource.md): Learn how to retrieve supported language and feature data across all DeepL API resources - [Common use cases](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/languages/language-feature-use-cases.md): Pseudocode examples for common language and feature lookup patterns using the v3/languages endpoints. - [Retrieve languages](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/languages/retrieve-languages-by-resource.md): Returns languages supported by the specified DeepL API resource. Each language indicates whether it can be used as a source language, a target language, or both, along with the features it supports for that resource. - [Retrieve language resources](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/languages/retrieve-resources.md): Learn how to retrieve the list of DeepL API resources and their supported language features. - [Migrating from v2/languages](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/languages/migrate-from-v2-languages.md): How to migrate from the v2/languages endpoint to the v3/languages endpoints. - [v3/languages changelog](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/languages/v3-languages-changelog.md): Changes to the v3/languages endpoints, including the GA release and prior breaking changes. - [Retrieve languages (v2)](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/languages.md): Reference for the deprecated v2/languages endpoint. Migrate to v3/languages for new integrations. - [Retrieve supported languages (v2)](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/languages/retrieve-supported-languages.md): **Deprecated.** Use `GET /v3/languages?resource=translate_text` (or the appropriate resource) instead. See the [migration guide](https://developers.deepl.com/api-reference/languages/migrate-from-v2-languages) for details. - [Admin API](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/admin-api.md): Explore DeepL API offering designed for admins - [Managing admin API keys](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/admin-api/managing-admin-keys.md): Learn how admins can create and manage admin API keys. - [Managing developer API keys](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/admin-api/managing-developer-keys.md): Learn how admins can create and manage developer API keys. - [Create a developer key](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/admin-api/managing-developer-keys/create-key.md) - [Get developer keys](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/admin-api/managing-developer-keys/get-keys.md) - [Deactivate a developer key](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/admin-api/managing-developer-keys/deactivate-key.md) - [Rename a developer key](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/admin-api/managing-developer-keys/rename-key.md) - [Set developer key limits](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/admin-api/managing-developer-keys/set-usage-limits.md) - [Retrieve usage and quota](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/usage-and-quota.md): API reference for retrieving usage and quota for the current billing period with the DeepL API. - [Check usage and limits](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/usage-and-quota/check-usage-and-limits.md) - [Accessing usage analytics](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/admin-api/organization-usage-analytics.md): Learn how admins can retrieve and analyze usage data across their organization. - [Get usage analytics](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/admin-api/get-usage-analytics.md): Retrieve usage statistics for the organization within a specified date range. Optionally group the results by API key or by API key and day. - [Get custom tag usage analytics](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/admin-api/get-custom-tag-usage-analytics.md): Retrieve usage statistics broken down by custom tags within a specified date range. Optionally aggregate results by day or over the entire period. Results are paginated; use the `page` parameter with the `next_page` value from a previous response to retrieve subsequent pages. ## OpenAPI Specs - [openapi](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/openapi.yaml) ## AsyncAPI Specs - [voice.asyncapi](https://deepl-c950b784-docs-style-rules-tm-language-expansion.mintlify.site/api-reference/voice/voice.asyncapi.yaml)