> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DeepL

> How to set up the DeepL connector, plus the actions that are available.

![DeepL](https://stackone-logos.com/api/deepl/filled/svg)

Previewv0.1.0[See changelog](https://docs.stackone.com/connectors/deepl/changelog.md)

[57 actions](#actions) · 1 auth method

Translation

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> **[Connector Profile · API Key](https://docs.stackone.com/connectors/deepl/guides/connector-profile/api-key.md)**
>
> Works with both DeepL API Free and DeepL API Pro keys. Translation memories, style rules, spoken terms and voice need a...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> **[Link Account · API Key](https://docs.stackone.com/connectors/deepl/guides/link-account/api-key.md)**

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

57 actions

ActionDescription

Get Admin Usage Analytics`deepl_get_admin_usage_analytics`

Retrieve usage statistics for the organization within a specified date range.

Get Admin Custom Tag Analytics`deepl_get_admin_custom_tag_analytics`

Retrieve usage statistics broken down by custom tags within a specified date range.

Create Developer Key`deepl_create_developer_key`

Create a developer key in your organization with the given label and return its metadata, including the key\_id.

List Developer Keys`deepl_list_developer_keys`

List every developer key in your organization, including labels, creation and deactivation timestamps, and any configure...

Deactivate Developer Key`deepl_deactivate_developer_key`

Deactivate a developer key so it can no longer authenticate API requests.

Rename Developer Key`deepl_rename_developer_key`

Change the label of a developer key.

Set Developer Key Usage Limits`deepl_set_developer_key_usage_limits`

Set per-key usage limits for characters, speech-to-text milliseconds, and speech-to-speech milliseconds.

Upload Document For Translation`deepl_upload_document_for_translation`

Upload a document for translation and receive a document\_id and document\_key.

Get Document Translation Status`deepl_get_document_translation_status`

Retrieve the translation status of an uploaded document.

Download Translated Document`deepl_download_translated_document`

Download a translated document.

Create Glossary`deepl_create_glossary`

Create a glossary containing one or more dictionaries, each holding entries for a single source and target language pair...

List Glossaries`deepl_list_glossaries`

List all glossaries and their meta-information, but not the glossary entries.

Get Glossary`deepl_get_glossary`

Retrieve meta information for a single glossary, omitting the glossary entries.

Update Glossary`deepl_update_glossary`

Edit glossary details, such as name or a dictionary for a source and target language.

Delete Glossary`deepl_delete_glossary`

Deletes the specified glossary.

Get Glossary Entries`deepl_get_glossary_entries`

List the entries of a single glossary in tsv format.

Delete Glossary Dictionary`deepl_delete_glossary_dictionary`

Delete the dictionary for a single source and target language pair from a glossary, leaving the glossary and its other d...

Replace Glossary Dictionary`deepl_replace_glossary_dictionary`

Replace all entries in the dictionary for a source and target language pair, or create the dictionary if it does not exi...

List Language Resources`deepl_list_language_resources`

Returns all DeepL API resources and the features they support.

List Languages`deepl_list_languages`

Returns languages supported by the specified DeepL API resource.

Get Quality Evaluation`deepl_get_quality_evaluation`

Returns the current state of a quality evaluation; poll until the evaluation completes to get the full report.

Create Spoken Terms`deepl_create_spoken_terms`

Create a new Spoken Terms collection with one or more term lists.

List Spoken Terms`deepl_list_spoken_terms`

List all Spoken Terms collections and their metadata, but not the actual terms.

Get Spoken Terms`deepl_get_spoken_terms`

Retrieve metadata for a Spoken Terms collection, including term list information but not the actual terms.

Update Spoken Terms`deepl_update_spoken_terms`

Update the name of a Spoken Terms collection or merge new entries into an existing term list.

Delete Spoken Terms`deepl_delete_spoken_terms`

Delete the entire Spoken Terms collection.

Get Spoken Terms Entries`deepl_get_spoken_terms_entries`

Retrieve the actual terms for a specific language from a Spoken Terms collection.

Replace Spoken Terms List`deepl_replace_spoken_terms_list`

Replace an existing term list for a language, or create a new one if it doesn't exist.

Delete Spoken Terms List`deepl_delete_spoken_terms_list`

Delete a term list for a specific language from the Spoken Terms collection.

List Style Profiles`deepl_list_style_profiles`

Retrieve a list of style profiles available to the authenticated account, newest first.

Create Style Profile`deepl_create_style_profile`

Create a style profile.

Get Style Profile`deepl_get_style_profile`

Retrieve a single style profile by its ID, including the components it links and its timestamps.

Update Style Profile`deepl_update_style_profile`

Update a style profile you own or that was shared with you for editing.

Delete Style Profile`deepl_delete_style_profile`

Delete a style profile.

List Style Rule Lists`deepl_list_style_rule_lists`

List the style rule lists in your account.

Create Style Rule List`deepl_create_style_rule_list`

Create a style rule list for a single language, optionally with its configured rules and custom instructions.

Get Style Rule List`deepl_get_style_rule_list`

Retrieve a single style rule list, including its configured rules and custom instructions.

Update Style Rule List`deepl_update_style_rule_list`

Rename a style rule list.

Delete Style Rule List`deepl_delete_style_rule_list`

Delete a style rule list and its custom instructions.

Update Style Rule Configured Rules`deepl_update_style_rule_configured_rules`

Replace the full set of configured rules on a style rule list.

Create Custom Instruction`deepl_create_custom_instruction`

Add a custom instruction to a style rule list to express a style preference that the predefined rules do not cover.

Get Custom Instruction`deepl_get_custom_instruction`

Retrieve a single custom instruction from a style rule list.

Update Custom Instruction`deepl_update_custom_instruction`

Replace a custom instruction.

Delete Custom Instruction`deepl_delete_custom_instruction`

Delete a custom instruction from a style rule list.

List Translation Memories`deepl_list_translation_memories`

Retrieve a list of translation memories associated with the authenticated account.

Import Translation Memory`deepl_import_translation_memory`

Create a translation memory by importing a TMX file.

Get Translation Memory Job`deepl_get_translation_memory_job`

Retrieve the status of a translation memory import or export job.

Get Translation Memory`deepl_get_translation_memory`

Retrieve a single translation memory by its ID, including its languages and segment count.

Delete Translation Memory`deepl_delete_translation_memory`

Delete a translation memory and all of its segments.

List Translation Memory Segments`deepl_list_translation_memory_segments`

List the segments stored in a translation memory, one page at a time.

Export Translation Memory`deepl_export_translation_memory`

Export a translation memory as a TMX file.

Translate Text`deepl_translate_text`

Translate one or more text strings into a target language.

Get Usage`deepl_get_usage`

Retrieve character and minute usage for the current billing period together with the corresponding account limits.

Create Voice Translation Job`deepl_create_voice_translation_job`

Creates an async voice translation job.

Get Voice Translation Job`deepl_get_voice_translation_job`

Returns the current status of a voice translation job, including per-target result statuses.

Rephrase Text`deepl_rephrase_text`

Rewrite one or more texts to improve fluency and readability, optionally targeting a specific writing style or tone.

Correct Text`deepl_correct_text`

Fix spelling and grammar errors in one or more texts.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.