Authorization
header of your requestsHeader | Value | Description |
---|---|---|
Authorization | Bearer {your-api-token} | Your organization’s API token |
Content-Type | application/json | Required for JSON request body |
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
targetLanguage | string | ✅ | - | The language code to translate to (e.g., “fr-FR”, “es-ES”, “de-DE”) |
sourceLanguage | string | ✅ | - | The language code of the source text (e.g., “en-US”, “fr-FR”, “es-ES”) |
textsToTranslate | string[] | ✅ | - | Array of text strings to translate |
useOrgDescription | boolean | ❌ | true | Use organization description for context |
useGlossary | boolean | ❌ | true | Use organization glossary for consistent terminology |
useSimilarity | boolean | ❌ | true | Use similarity matching for better translations |
useCustomInstructions | boolean | ❌ | true | Use custom translation instructions |
instructionsSource | string | ❌ | "github" | Source of custom instructions |
instructionsBundle | string | ❌ | "" | Bundle name for instructions |
instructionsRepository | string | ❌ | "" | Repository name for instructions |
additionalInstructions | string | ❌ | "" | Additional custom instructions |
useOrgDescription
is enabled, the translation engine uses your organization’s description to provide better context and maintain brand consistency.
useGlossary
is enabled, the system automatically extracts terms from your source texts and applies consistent translations based on your organization’s glossary.
useSimilarity
is enabled, the system leverages previously translated similar content to improve translation quality and consistency.
useCustomInstructions
is enabled, you can specify: