---
title: "TranslationsByText (DeepL)"
description: "Translations"
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/deepl/DeepL.Translate.TranslationsByText
original: https://documentation.invantive.eu/en/datamodels/deepl/DeepL.Translate.TranslationsByText
updated: 2026-11-01T16:36:06Z
license: https://documentation.invantive.eu/en/
---

# TranslationsByText: DeepL Translations

`read only` `REST`

- Catalog: `DeepL`
- Schema: `Translate`
- Label: Translations

Can only retrieve data.

## Summary

The translation of one text. Billed per character on every execution.

## API Source

- Endpoint: `/v2/translate`

## Performance Characteristics

| Characteristic | Value |
|---|---:|
| Average access latency (ms) | 31 |

## Parameters

| Name | Data Type | Required | Default | Documentation |
|---|---|:---:|---|---|
| `context` | `varchar2` | [ ] |  | Text that influences the translation without being translated itself. Not billed. |
| `custom_instructions` | `varchar2` | [ ] |  | JSON array of up to 10 instructions of at most 300 characters. |
| `formality` | `varchar2` | [ ] |  | default, more, less, prefer_more or prefer_less. |
| `glossary_id` | `varchar2` | [ ] |  | The glossary to apply; requires source_lang. |
| `glossary_ids` | `varchar2` | [ ] |  | Comma-separated list of up to 5 glossaries; excludes glossary_id. |
| `ignore_tags` | `varchar2` | [ ] |  | Comma-separated XML tags whose content is not translated. |
| `model_type` | `varchar2` | [ ] |  | quality_optimized, prefer_quality_optimized or latency_optimized. |
| `non_splitting_tags` | `varchar2` | [ ] |  | Comma-separated XML tags which never split sentences. |
| `outline_detection` | `boolean` | [ ] |  | False disables the automatic detection of the XML structure. |
| `preserve_formatting` | `boolean` | [ ] |  | Whether DeepL keeps the formatting even where it would correct it. |
| `reporting_tag` | `varchar2` | [ ] |  | Custom reporting tag of the request; overrides the connection attribute reporting-tag. |
| `source_lang` | `varchar2` | [ ] |  | Language of the text. When absent, DeepL detects it; a glossary requires it. |
| `split_sentences` | `varchar2` | [ ] |  | 0 (no splitting), 1 (default) or nonewlines. |
| `splitting_tags` | `varchar2` | [ ] |  | Comma-separated XML tags which always split sentences. |
| `style_id` | `varchar2` | [ ] |  | The style rule list to apply. |
| `tag_handling` | `varchar2` | [ ] |  | xml or html. |
| `tag_handling_version` | `varchar2` | [ ] |  | v1 or v2. |
| `target_lang` | `varchar2` | [x] |  | The language to translate into, such as NL, DE or EN-GB. |
| `text` | `varchar2` | [x] |  | The text to translate. |
| `translation_memory_id` | `varchar2` | [ ] |  | The translation memory to apply. |
| `translation_memory_threshold` | `int32` | [ ] |  | Minimum matching percentage of a translation memory segment; below 50 is 50. |

## Table Columns

The columns of the table `TranslationsByText` are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|:---:|---|---|
| `billed_characters` | `int32` | itgen_dpl_billed_characters | [ ] | filters on the platform, writable | The characters DeepL billed for the text in this execution; 0 when the translation came from the cache. |
| `detected_source_language` | `varchar2` | itgen_dpl_detected_source_language | [ ] | filters on the platform, writable | The source language, as given or as detected. |
| `model_type_used` | `varchar2` | itgen_dpl_model_type_used | [ ] | filters on the platform, writable | The model used; only when a model type was requested. |
| `tag_handling_version` | `varchar2` | itgen_dpl_tag_handling_version | [ ] | filters on the platform, writable | The tag handling algorithm used; only with tag handling. |
| `translated_text` | `varchar2` | itgen_dpl_translated_text | [ ] | filters on the platform, writable | The translated text. |

## Sample Queries

```sql
select trn.translated_text
,      trn.billed_characters
from   DeepL.Translate.TranslationsByText('The licence key is invalid.', 'NL', source_lang => 'EN') trn
```

