DeepL

DeepL API

The DeepL API provides programmatic access to DeepL’s language AI technology. Note: this OpenAPI spec is embedded into our API documentation and has shortened…

AI & machine learning#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The DeepL API provides programmatic access to DeepL’s language AI technology.

Note: this OpenAPI spec is embedded into our API documentation and has shortened descriptions.

Endpoints 66

TranslateText

  • POSTRequest Translation/v2/translateTranslate one or more text strings into a target language. Send multiple strings in a single request, within the request size limit, and specify formatting,…

TranslateDocuments

  • POSTUpload and Translate a Document/v2/documentUpload a document for translation and receive a document_id and document_key. Use them to poll the document status and download the translated file.…
  • POSTCheck Document Status/v2/document/:document_idRetrieve the translation status of an uploaded document. Poll this endpoint until the status is done, then download the result. The response includes an…
  • POSTDownload Translated Document/v2/document/:document_id/resultDownload a translated document. The document must have a status of done. Each document can be downloaded only once: after a successful download DeepL deletes…

RephraseText

  • POSTImprove text/v2/write/rephraseRewrite one or more texts to improve fluency and readability, optionally targeting a specific writing style or tone. Use the correct endpoint instead when you…

CorrectText

  • POSTCorrect text/v2/write/correctFix spelling and grammar errors in one or more texts. Unlike /v2/write/rephrase, this endpoint applies a minimal-change correction pass and does not rewrite…

ManageSpokenTerms

  • GETList all Spoken Terms collections/v3/spoken-termsList all Spoken Terms collections and their metadata, but not the actual terms.
  • POSTCreate Spoken Terms collection/v3/spoken-termsCreate a new Spoken Terms collection with one or more term lists. Each term list contains terms for a single language. The number of collections per account…
  • GETRetrieve Spoken Terms collection details/v3/spoken-terms/:spoken_terms_idRetrieve metadata for a Spoken Terms collection, including term list information but not the actual terms.
  • DELETEDelete Spoken Terms collection/v3/spoken-terms/:spoken_terms_idDelete the entire Spoken Terms collection.
  • PATCHEdit Spoken Terms collection details/v3/spoken-terms/:spoken_terms_idUpdate the name of a Spoken Terms collection or merge new entries into an existing term list.
  • GETRetrieve Spoken Terms entries/v3/spoken-terms/:spoken_terms_id/entries?lang=enRetrieve the actual terms for a specific language from a Spoken Terms collection.
  • PUTReplace or create a term list/v3/spoken-terms/:spoken_terms_id/term-listsReplace an existing term list for a language, or create a new one if it doesn't exist.
  • DELETEDelete a term list/v3/spoken-terms/:spoken_terms_id/term-lists?lang=enDelete a term list for a specific language from the Spoken Terms collection.

ManageMultilingualGlossaries

  • GETList all Glossaries/v3/glossariesList all glossaries and their meta-information, but not the glossary entries.
  • POSTCreate a Glossary/v3/glossariesCreate a glossary containing one or more dictionaries, each holding entries for a single source and target language pair. Use the returned glossary_id with…
  • GETRetrieve Glossary Details/v3/glossaries/:glossary_idRetrieve meta information for a single glossary, omitting the glossary entries.
  • DELETEDelete a Glossary/v3/glossaries/:glossary_idDeletes the specified glossary.
  • PATCHEdit glossary details/v3/glossaries/:glossary_idEdit glossary details, such as name or a dictionary for a source and target language.
  • GETRetrieve Glossary Entries/v3/glossaries/:glossary_id/entries?source_lang=en&target_lang=deList the entries of a single glossary in tsv format.
  • PUTReplaces or creates a dictionary in the glossary with the specified entries./v3/glossaries/:glossary_id/dictionariesReplace all entries in the dictionary for a source and target language pair, or create the dictionary if it does not exist yet. Entries not included in the…
  • DELETEDeletes the dictionary associated with the given language pair with the given glossary ID./v3/glossaries/:glossary_id/dictionaries?source_lang=en&target_lang=deDelete the dictionary for a single source and target language pair from a glossary, leaving the glossary and its other dictionaries in place.

ManageGlossaries

  • GETList Language Pairs Supported by Glossaries/v2/glossary-language-pairsDeprecated. Deprecated. Use GET /v3/languages?resource=glossary instead, which returns per-language availability including source and target roles. Retrieve…
  • GETList all Glossaries/v2/glossariesList all glossaries and their meta-information, but not the glossary entries.
  • POSTCreate a Glossary/v2/glossariesFor new integrations we recommend POST /v3/glossaries, which supports multiple language pairs in a single glossary. Create a glossary for one source and…
  • GETRetrieve Glossary Details/v2/glossaries/:glossary_idRetrieve meta information for a single glossary, omitting the glossary entries.
  • DELETEDelete a Glossary/v2/glossaries/:glossary_idDeletes the specified glossary.
  • GETRetrieve Glossary Entries/v2/glossaries/:glossary_id/entriesList the entries of a single glossary in the format specified by the Accept header.

ManageStyleProfiles

  • GETList style profiles/v3/style_profilesRetrieve a list of style profiles available to the authenticated account, newest first. The list includes style profiles that have been shared with the…
  • POSTCreate a style profile/v3/style_profilesCreate a style profile. Only name is required. If any of the component IDs cannot be used, the request fails and no style profile is created. Requires an API…
  • GETRetrieve a style profile/v3/style_profiles/:style_profile_idRetrieve a single style profile by its ID, including the components it links and its timestamps. Requires an API key with the style_profiles:read scope.
  • DELETEDelete a style profile/v3/style_profiles/:style_profile_idDelete a style profile. Only the account that owns a style profile can delete it. A style profile that was shared with your account returns 404 Not Found. The…
  • PATCHUpdate a style profile/v3/style_profiles/:style_profile_idUpdate a style profile you own or that was shared with you for editing. Fields you leave out of the request body are not changed. A component list you send…

MetaInformation

  • GETCheck Usage and Limits/v2/usageRetrieve character and minute usage for the current billing period together with the corresponding account limits. Poll this endpoint to track consumption and…
  • GETRetrieve Supported Languages/v2/languagesDeprecated. Deprecated. Use GET /v3/languages?resource=translate_text (or the appropriate resource) instead. See the migration guide for details.
  • GETRetrieve Language Resources/v3/languages/resourcesReturns all DeepL API resources and the features they support. For each feature, the response indicates which languages must support it for the feature to be…
  • GETRetrieve Languages/v3/languages?resource=translate_textReturns languages supported by the specified DeepL API resource. Each language indicates whether it can be used as a source language, a target language, or…

TranslationMemories

  • GETList translation memories/v3/translation_memoriesRetrieve a list of translation memories associated with the authenticated account.
  • POSTImport a translation memory/v3/translation_memories/importCreate a translation memory by importing a TMX file. This endpoint does not accept the file itself. It returns a short-lived upload_url, and you upload the…
  • GETRetrieve an import or export job/v3/translation_memories/jobs/:job_idRetrieve the status of a translation memory import or export job. Poll this endpoint after creating a job. The operation field tells you which kind of job it…
  • GETRetrieve a translation memory/v3/translation_memories/:translation_memory_idRetrieve a single translation memory by its ID, including its languages and segment count. To read the stored segments themselves, use List translation memory…
  • DELETEDelete a translation memory/v3/translation_memories/:translation_memory_idDelete a translation memory and all of its segments. Deletion is permanent and cannot be undone. Export the translation memory first if you need a copy of its…
  • GETList translation memory segments/v3/translation_memories/:translation_memory_id/segmentsList the segments stored in a translation memory, one page at a time. Each entry is a source segment with its translations in every target language. This…
  • POSTExport a translation memory/v3/translation_memories/:translation_memory_id/exportExport a translation memory as a TMX file. The export runs as a background job. Poll Retrieve an import or export job until the status is completed, then…

VoiceAPI

  • GETRequest Reconnection/v3/voice/realtime?token=VGhpcyBpcyBhIGZha2UgdG9rZW4KExchange a session token for a fresh WebSocket URL and token so a client can rejoin a voice session after the connection drops. Session options are carried…
  • POSTGet Streaming URL/v3/voice/realtimeCreate a real-time voice session and return the WebSocket URL and ephemeral token used to stream audio. Session options such as languages, message format, and…

VoiceTranslateJob

  • POSTCreate a voice translation job/v1/jobs/voice/translateCreates an async voice translation job. The response includes an upload URL for the source audio file.
  • GETGet voice translation job status/v1/jobs/voice/translate/:job_idReturns the current status of a voice translation job, including per-target result statuses. When a target's status is complete, the response includes a…

AdminApi

  • GETGet usage statistics as an admin/v2/admin/analytics?start_date=2025-09-29&end_date=2025-10-01Retrieve usage statistics for the organization within a specified date range. Optionally group the results by API key or by API key and day.
  • GETGet custom tag usage statistics as an admin/v2/admin/analytics/custom-tags?start_date=2026-05-17&end_date=2026-05-18Retrieve usage statistics broken down by custom tags within a specified date range. Optionally aggregate results by day or over the entire period. Results are…
  • GETGet all developer keys as an admin/v2/admin/developer-keysList every developer key in your organization, including labels, creation and deactivation timestamps, and any configured usage limits. Requires an Admin API…
  • POSTCreate a developer key as an admin/v2/admin/developer-keysCreate a developer key in your organization with the given label and return its metadata, including the key_id. Requires an Admin API key.
  • PUTDeactivate a developer key as an admin/v2/admin/developer-keys/deactivateDeactivate a developer key so it can no longer authenticate API requests. Deactivation is permanent: create a new key to restore access. Requires an Admin API…
  • PUTRename a developer key as an admin/v2/admin/developer-keys/labelChange the label of a developer key. Labels are for your own bookkeeping and do not affect the key's permissions. Requires an Admin API key.
  • PUTSet developer key usage limits as an admin/v2/admin/developer-keys/limitsSet per-key usage limits for characters, speech-to-text milliseconds, and speech-to-speech milliseconds. Requests made with the key fail with HTTP 456 once a…

QualityEvaluation

  • GETPoll for the evaluation result/v1/quality-evaluations/:job_idReturns the current state of a quality evaluation. While the evaluation is in progress the response carries only status information; once it completes, the…
  • GETRetrieve style rule lists/v3/style_rulesList the style rule lists in your account. Results are paginated. Set detailed to include each list's configured rules and custom instructions.
  • POSTCreate a style rule list/v3/style_rulesCreate a style rule list for a single language, optionally with its configured rules and custom instructions. The language can be a root code such as de or a…
  • GETGet a style rule list/v3/style_rules/:style_idRetrieve a single style rule list, including its configured rules and custom instructions.
  • DELETEDelete a style rule list/v3/style_rules/:style_idDelete a style rule list and its custom instructions. Requests that reference the deleted style_id fail afterwards.
  • PATCHUpdate a style rule list's name/v3/style_rules/:style_idRename a style rule list. This does not change its configured rules or custom instructions.
  • PUTReplace configured rules for a style rule list/v3/style_rules/:style_id/configured_rulesReplace the full set of configured rules on a style rule list. Rules not included in the request are removed, so send the complete set you want to keep.
  • POSTCreate a custom instruction/v3/style_rules/:style_id/custom_instructionsAdd a custom instruction to a style rule list to express a style preference that the predefined rules do not cover. Instructions apply to text in the given…
  • GETGet a custom instruction/v3/style_rules/:style_id/custom_instructions/:instruction_idRetrieve a single custom instruction from a style rule list.
  • PUTReplace a custom instruction/v3/style_rules/:style_id/custom_instructions/:instruction_idReplace a custom instruction. Send every field you want to keep, because omitted fields are overwritten.
  • DELETEDelete a custom instruction/v3/style_rules/:style_id/custom_instructions/:instruction_idDelete a custom instruction from a style rule list. The rest of the list is unchanged.

API details

Base URL
https://api.deepl.com
https://api-free.deepl.com
Authentication
An API key in the Authorization header
Operations
66 operations on 45 pathsGET 29POST 17DELETE 9PUT 7PATCH 4
2 marked deprecated
Main resources
ManageMultilingualGlossaries 8ManageSpokenTerms 8AdminApi 7TranslationMemories 7ManageGlossaries 6ManageStyleProfiles 5MetaInformation 4TranslateDocuments 3VoiceAPI 2VoiceTranslateJob 2
Response formats
application/json application/octet-stream text/tab-separated-values
Description format
OpenAPI 3.0.3, API version 3.14.0

How to test the DeepL API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the DeepL API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Request Translation” (POST /v2/translate), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the DeepL API?

The DeepL API provides programmatic access to DeepL’s language AI technology. Note: this OpenAPI spec is embedded into our API documentation and has shortened… It is listed under AI & machine learning and has 66 endpoints.

Who publishes the DeepL API?

It is listed from DeepL's public API description (an OpenAPI document), not published by DeepL on Swastik Codes. Anyone who controls deepl.com can claim the profile by adding a DNS TXT record.

What is the base URL of the DeepL API?

Its description lists 2 base URLs: https://api.deepl.com, https://api-free.deepl.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the DeepL API?

With an API key in the Authorization header.

How many endpoints does the DeepL API have?

66 operations on 45 paths (29 GET, 17 POST, 9 DELETE, 7 PUT, 4 PATCH). The largest groups are ManageMultilingualGlossaries, ManageSpokenTerms, AdminApi, TranslationMemories.

Is forking the DeepL API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.