Intento

**Intento Glossary API**

This API provides comprehensive management of glossaries for the Intento Translation platform, including:
- Creating and managing glossaries
- Adding, updating, and deleting glossary terms
- Supporting DNT (Do Not Translate) and Unidirectional term types
- CSV import/export functionality
- Publishing changes to routing tables
- Integration with native provider glossaries

For more details, visit the [Intento Documentation](https://developers.inten.to/).

**Key Features:**
- Support for DNT (Do Not Translate) and Unidirectional glossaries
- Custom case sensitivity settings
- Bulk operations via CSV import/export
- Draft and published term states
- Multi-provider glossary support (Amazon, DeepL, Google, Microsoft, ModernMT, Systran)

**Authentication:**
All API requests require authentication using an API key. To obtain your API key:
1. Register for an account at [Intento Console](https://console.inten.to)
2. Navigate to the API section in your account dashboard
3. Get an API key
4. Include this key in the 'apikey' header with all your requests

**Terminology:**
- **Intento Source glossary** - implementation of glossaries for Microsoft, ModernMT providers
- **Native providers' glossary** - implementation of glossaries on provider side (Amazon, DeepL, Google, Systran)
- **DNT (Do Not Translate)** - terms that should not be translated
- **Unidirectional** - terms with source-to-target translation mapping


Intento Glossary API

Authentication

Obtains a Bearer token for authenticating with Studio API endpoints.
This token is required for publishing glossaries and CSV operations.


Obtain authentication token

Glossaries

Creates a new glossary with specified type and configuration.
Supports DNT (Do Not Translate) and Unidirectional glossary types.


Create a new glossary

Retrieves a list of all glossaries for the authenticated user.


Get list of glossaries

Retrieves detailed information about a specific glossary including its terms.


Get a specific glossary

Add or delete terms in a glossary. Supports both DNT and Unidirectional term types.

**How to calculate flgs variable value:**

The flgs field uses bitwise operations with predefined masks:
- PREDEFINED_UPPER_MASK = 1 (converts 'My Term' to 'MY TERM')
- PREDEFINED_LOWER_MASK = 2 (converts 'My Term' to 'my term')
- PREDEFINED_REGULAR_MASK = 4 (converts 'My Term' to 'My term')

**Python example:**
```python
source = 'my term'
as_typed_source = source

PREDEFINED_UPPER_MASK = 1   # 'My Term' -> 'MY TERM'
PREDEFINED_LOWER_MASK = 2   # 'My Term' -> 'my term'
PREDEFINED_REGULAR_MASK = 4 # 'My Term' -> 'My term'

flags = 0

is_lower = True
is_upper = False
is_regular = True

if source != as_typed_source.lower() and is_lower:
    flags |= PREDEFINED_LOWER_MASK
if source != as_typed_source.upper() and is_upper:
    flags |= PREDEFINED_UPPER_MASK
if source != as_typed_source.capitalize() and is_regular:
    flags |= PREDEFINED_REGULAR_MASK
```

**JavaScript example:**
```javascript
let source = 'my term';
let as_typed_source = source;

const PREDEFINED_UPPER_MASK = 1;   // 'My Term' -> 'MY TERM'
const PREDEFINED_LOWER_MASK = 2;   // 'My Term' -> 'my term'
const PREDEFINED_REGULAR_MASK = 4; // 'My Term' -> 'My term'

let flags = 0;

let is_lower = true;
let is_upper = false;
let is_regular = true;

if (source !== as_typed_source.toLowerCase() && is_lower) {
    flags |= PREDEFINED_LOWER_MASK;
}
if (source !== as_typed_source.toUpperCase() && is_upper) {
    flags |= PREDEFINED_UPPER_MASK;
}
if (source !== as_typed_source.charAt(0).toUpperCase() + as_typed_source.slice(1) && is_regular) {
    flags |= PREDEFINED_REGULAR_MASK;
}
```


Update glossary terms

Imports terms into a glossary from preprocessed CSV data.
This is step 2 of the CSV upload process.


Import terms from CSV data

Routing

Retrieves a list of available routing tables for glossary publishing.


Get routing tables list

Publishing

Publishes glossary changes with recompilation to native providers' glossaries.
Requires both API key and Bearer token authentication.


Publish glossary changes

CSV Operations

Downloads glossary terms in CSV format.
Supports options for including draft terms and expanding custom variants.


Download glossary as CSV

Uploads a CSV file and preprocesses it for glossary import.
This is step 1 of the CSV upload process.


Upload CSV file for preprocessing

Intento Glossaries API

Production server

Authentication server

Studio API server

<p class="slate-p " ><strong class="slate-bold">Intento Glossary API</strong></p><p class="slate-p " >This API provides comprehensive management of glossaries for the Intento Translation platform, including:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Creating and managing glossaries</div></li><li class="slate-li " ><div style="position:relative">Adding, updating, and deleting glossary terms</div></li><li class="slate-li " ><div style="position:relative">Supporting DNT (Do Not Translate) and Unidirectional term types</div></li><li class="slate-li " ><div style="position:relative">CSV import/export functionality</div></li><li class="slate-li " ><div style="position:relative">Publishing changes to routing tables</div></li><li class="slate-li " ><div style="position:relative">Integration with native provider glossaries</div></li></ul><p class="slate-p " >For more details, visit the <a href="https://developers.inten.to/" target="_self">Intento Documentation</a>.</p><p class="slate-p " ><strong class="slate-bold">Key Features:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Support for DNT (Do Not Translate) and Unidirectional glossaries</div></li><li class="slate-li " ><div style="position:relative">Custom case sensitivity settings</div></li><li class="slate-li " ><div style="position:relative">Bulk operations via CSV import/export</div></li><li class="slate-li " ><div style="position:relative">Draft and published term states</div></li><li class="slate-li " ><div style="position:relative">Multi-provider glossary support (Amazon, DeepL, Google, Microsoft, ModernMT, Systran)</div></li></ul><p class="slate-p " ><strong class="slate-bold">Authentication:</strong>
All API requests require authentication using an API key. To obtain your API key:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Register for an account at <a href="https://console.inten.to" target="_self">Intento Console</a></div></li><li class="slate-li " ><div style="position:relative">Navigate to the API section in your account dashboard</div></li><li class="slate-li " ><div style="position:relative">Get an API key</div></li><li class="slate-li " ><div style="position:relative">Include this key in the &apos;apikey&apos; header with all your requests</div></li></ol><p class="slate-p " ><strong class="slate-bold">Terminology:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Intento Source glossary</strong> - implementation of glossaries for Microsoft, ModernMT providers</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Native providers&apos; glossary</strong> - implementation of glossaries on provider side (Amazon, DeepL, Google, Systran)</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">DNT (Do Not Translate)</strong> - terms that should not be translated</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Unidirectional</strong> - terms with source-to-target translation mapping</div></li></ul><p class="slate-p " ></p>

This API provides comprehensive management of glossaries for the Intento Translation platform, including:


All API requests require authentication using an API key. To obtain your API key:

Glossary type:
- 1: Regular (deprecated, do not use)
- 2: DNT (Do Not Translate)
- 3: Unidirectional


type

Case sensitivity configuration:
- 1: Regular and upper (deprecated, do not use)
- 2: Upper case (deprecated, do not use)
- 3: As is (deprecated, do not use)
- 4: Custom Case Sensitivity
- 5: Custom Case Sensitivity


cs_type

name

origin

language_pairs

cs_lower

cs_upper

cs_regular

labels

apikey

status

count

message

success

glossaries

glossaryId

draft

terms

license_id

has_draft

terms_source

entries_count

created_at

created_at_epoch_secs

created_client_key_id

updated_at

updated_at_epoch_secs

Client key ID that last updated the glossary

updated_client_key_id

published_at

published_at_epoch_secs

Client key ID that published the glossary

published_client_key_id

languages

<p class="slate-p " >Add or delete terms in a glossary. Supports both DNT and Unidirectional term types.</p><p class="slate-p " ><strong class="slate-bold">How to calculate flgs variable value:</strong></p><p class="slate-p " >The flgs field uses bitwise operations with predefined masks:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">PREDEFINED_UPPER_MASK = 1 (converts &apos;My Term&apos; to &apos;MY TERM&apos;)</div></li><li class="slate-li " ><div style="position:relative">PREDEFINED_LOWER_MASK = 2 (converts &apos;My Term&apos; to &apos;my term&apos;)</div></li><li class="slate-li " ><div style="position:relative">PREDEFINED_REGULAR_MASK = 4 (converts &apos;My Term&apos; to &apos;My term&apos;)</div></li></ul><p class="slate-p " ><strong class="slate-bold">Python example:</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-python keep-markup drop-tokens"><div class="slate-code_line">source = &apos;my term&apos;</div><div class="slate-code_line">
as_typed_source = source</div><div class="slate-code_line"></div><div class="slate-code_line">PREDEFINED_UPPER_MASK = 1 # ‘My Term’ -&gt; ‘MY TERM’
PREDEFINED_LOWER_MASK = 2 # ‘My Term’ -&gt; ‘my term’
PREDEFINED_REGULAR_MASK = 4 # ‘My Term’ -&gt; ‘My term’</div><div class="slate-code_line"></div><div class="slate-code_line">flags = 0</div><div class="slate-code_line">is_lower = True
is_upper = False
is_regular = True</div><div class="slate-code_line"></div><div class="slate-code_line">if source != as_typed_source.lower() and is_lower:
    flags |= PREDEFINED_LOWER_MASK</div><div class="slate-code_line">
if source != as_typed_source.upper() and is_upper:
    flags |= PREDEFINED_UPPER_MASK</div><div class="slate-code_line">
if source != as_typed_source.capitalize() and is_regular:
    flags |= PREDEFINED_REGULAR_MASK</div></code></pre></div><p class="slate-p " ><strong class="slate-bold">JavaScript example:</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">let source = &apos;my term&apos;;</div><div class="slate-code_line">
let as_typed_source = source;</div><div class="slate-code_line"></div><div class="slate-code_line">const PREDEFINED_UPPER_MASK = 1; // ‘My Term’ -&gt; ‘MY TERM’
const PREDEFINED_LOWER_MASK = 2; // ‘My Term’ -&gt; ‘my term’
const PREDEFINED_REGULAR_MASK = 4; // ‘My Term’ -&gt; ‘My term’</div><div class="slate-code_line"></div><div class="slate-code_line">let flags = 0;</div><div class="slate-code_line">let is_lower = true;
let is_upper = false;
let is_regular = true;</div><div class="slate-code_line"></div><div class="slate-code_line">if (source !== as_typed_source.toLowerCase() &amp;&amp; is_lower) {
    flags |= PREDEFINED_LOWER_MASK;
}</div><div class="slate-code_line">
if (source !== as_typed_source.toUpperCase() &amp;&amp; is_upper) {
    flags |= PREDEFINED_UPPER_MASK;
}</div><div class="slate-code_line">
if (source !== as_typed_source.charAt(0).toUpperCase() + as_typed_source.slice(1) &amp;&amp; is_regular) {
    flags |= PREDEFINED_REGULAR_MASK;
}</div></code></pre></div><p class="slate-p " ></p>

Add or delete terms in a glossary. Supports both DNT and Unidirectional term types.

The flgs field uses bitwise operations with predefined masks:

Sections