TM GraphQL API
Translation Memory Manager (TMM) GraphQL API. Stores and retrieves translated content, and applies leverage (matching against existing translations) to new translation requests.
Terms of Service
API Endpoints
https://api.smartling.com/tm-graphql-api/v2/accounts/{accountUid}/graphqlHeaders
Authorization: Bearer <YOUR_TOKEN_HERE>Queries
browseStringSearch
Description
Returns a page of the strings captured by a previous createStringSearch, together with aggregate counts
Response
Returns a BrowseStringSearchResult
Arguments
| Name | Description |
|---|---|
browseStringSearchFilter - BrowseStringSearchFilter!
|
Example
Query
query browseStringSearch($browseStringSearchFilter: BrowseStringSearchFilter!) {
browseStringSearch(browseStringSearchFilter: $browseStringSearchFilter) {
tmStrings {
...TmStringFragment
}
stringCount
wordCount
asyncActionResult {
...AsyncActionResultFragment
}
affectsBulkActionsBySearch {
...AffectedBulkActionsBySearchFragment
}
}
}
Variables
{"browseStringSearchFilter": BrowseStringSearchFilter}
Response
{
"data": {
"browseStringSearch": {
"tmStrings": [TmString],
"stringCount": 123,
"wordCount": 987,
"asyncActionResult": AsyncActionResult,
"affectsBulkActionsBySearch": AffectedBulkActionsBySearch
}
}
}
browseStrings
Description
Returns a page of the strings captured by a previous createStringSearch
Response
Returns [TmString]
Arguments
| Name | Description |
|---|---|
browseStringsFilter - BrowseStringsFilter!
|
Example
Query
query browseStrings($browseStringsFilter: BrowseStringsFilter!) {
browseStrings(browseStringsFilter: $browseStringsFilter) {
tmStringUid
tm {
...TMFragment
}
stringMetadata {
...StringMetadataFragment
}
sourceLocaleId
translationLocaleId
sourceText
translationText
sourceNonPluralText
translationNonPluralText
sourceZeroText
sourceOneText
sourceTwoText
sourceFewText
sourceManyText
sourceOtherText
translationZeroText
translationOneText
translationTwoText
translationFewText
translationManyText
translationOtherText
tmStringIcf {
...TmStringIcfFragment
}
lastModificationDate
stringMetadataCount
leverageType
wordCount
highlightedSourceText
highlightedTranslationText
}
}
Variables
{"browseStringsFilter": BrowseStringsFilter}
Response
{
"data": {
"browseStrings": [
{
"tmStringUid": "2z68632hdvw2",
"tm": TM,
"stringMetadata": [StringMetadata],
"sourceLocaleId": "en-US",
"translationLocaleId": "ja",
"sourceText": "Hola",
"translationText": "Hola",
"sourceNonPluralText": "Hola",
"translationNonPluralText": "Hola",
"sourceZeroText": "Hola",
"sourceOneText": "Hola",
"sourceTwoText": "Hola",
"sourceFewText": "Hola",
"sourceManyText": "Hola",
"sourceOtherText": "Hola",
"translationZeroText": "Hola",
"translationOneText": "Hola",
"translationTwoText": "Hola",
"translationFewText": "Hola",
"translationManyText": "Hola",
"translationOtherText": "Hola",
"tmStringIcf": TmStringIcf,
"lastModificationDate": "2026-06-17T00:09:44Z",
"stringMetadataCount": 123,
"leverageType": "PUBLISHED",
"wordCount": 123,
"highlightedSourceText": "Hola",
"highlightedTranslationText": "Hola"
}
]
}
}
bulkExportTmStringsStatus
Description
Checks the progress of a bulkExportTmStrings action
Response
Returns a StringsExportAsyncActionResult
Arguments
| Name | Description |
|---|---|
actionUid - ID!
|
Example
Query
query bulkExportTmStringsStatus($actionUid: ID!) {
bulkExportTmStringsStatus(actionUid: $actionUid) {
actionUid
totalCount
processedCount
errorCount
executionComplete
tmxDownloadKey
expired
actionStatus
}
}
Variables
{"actionUid": "2z68632hdvw2"}
Response
{
"data": {
"bulkExportTmStringsStatus": {
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 987,
"processedCount": 987,
"errorCount": 123,
"executionComplete": false,
"tmxDownloadKey": "Hola",
"expired": true,
"actionStatus": "QUEUEING"
}
}
}
bulkQcsSearch
Description
Runs a QCS search for multiple phrases at once, returning each phrase's matches separately
Response
Returns [QCSSearchBulkResult]
Arguments
| Name | Description |
|---|---|
qcsSearchFilter - QcsSearchFilter!
|
Example
Query
query bulkQcsSearch($qcsSearchFilter: QcsSearchFilter!) {
bulkQcsSearch(qcsSearchFilter: $qcsSearchFilter) {
phraseUid
strings {
...QCSSearchResultStringFragment
}
}
}
Variables
{"qcsSearchFilter": QcsSearchFilter}
Response
{
"data": {
"bulkQcsSearch": [
{
"phraseUid": "Hola",
"strings": [QCSSearchResultString]
}
]
}
}
bulkSearchAndReplaceCount
Description
Starts an asynchronous count of how many matches a search-and-replace would affect, scoped to a previously created string search
Response
Returns an AsyncActionResult
Arguments
| Name | Description |
|---|---|
bulkSearchAndReplaceCountFilter - BulkSearchAndReplaceCountFilter!
|
Example
Query
query bulkSearchAndReplaceCount($bulkSearchAndReplaceCountFilter: BulkSearchAndReplaceCountFilter!) {
bulkSearchAndReplaceCount(bulkSearchAndReplaceCountFilter: $bulkSearchAndReplaceCountFilter) {
actionUid
totalCount
processedCount
errorCount
executionComplete
actionStatus
}
}
Variables
{
"bulkSearchAndReplaceCountFilter": BulkSearchAndReplaceCountFilter
}
Response
{
"data": {
"bulkSearchAndReplaceCount": {
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 987,
"processedCount": 987,
"errorCount": 987,
"executionComplete": false,
"actionStatus": "QUEUEING"
}
}
}
bulkSearchAndReplaceCountStatus
Description
Checks the progress of a bulkSearchAndReplaceCount action
Response
Returns a SearchAndReplaceCountAsyncActionResult
Arguments
| Name | Description |
|---|---|
actionUid - ID!
|
Example
Query
query bulkSearchAndReplaceCountStatus($actionUid: ID!) {
bulkSearchAndReplaceCountStatus(actionUid: $actionUid) {
actionUid
totalCount
processedCount
errorCount
executionComplete
stringCount
phraseCount
}
}
Variables
{"actionUid": "2z68632hdvw2"}
Response
{
"data": {
"bulkSearchAndReplaceCountStatus": {
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 123,
"processedCount": 987,
"errorCount": 987,
"executionComplete": false,
"stringCount": 987,
"phraseCount": 123
}
}
}
bulkSearchAndReplaceStatus
Description
Checks the progress of a bulkSearchAndReplace action
Response
Returns a SearchAndReplaceAsyncActionResult
Arguments
| Name | Description |
|---|---|
actionUid - ID!
|
Example
Query
query bulkSearchAndReplaceStatus($actionUid: ID!) {
bulkSearchAndReplaceStatus(actionUid: $actionUid) {
actionUid
totalCount
processedCount
errorCount
executionComplete
editedStringCount
replacedPhraseCount
propagatedStringCount
}
}
Variables
{"actionUid": "2z68632hdvw2"}
Response
{
"data": {
"bulkSearchAndReplaceStatus": {
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 987,
"processedCount": 123,
"errorCount": 123,
"executionComplete": true,
"editedStringCount": 987,
"replacedPhraseCount": 123,
"propagatedStringCount": 123
}
}
}
concordanceSearch
Description
Searches translated content across one or more leverages for a single phrase
Response
Returns [ConcordanceSearchResult]
Arguments
| Name | Description |
|---|---|
concordanceSearchFilter - ConcordanceSearchFilter!
|
Example
Query
query concordanceSearch($concordanceSearchFilter: ConcordanceSearchFilter!) {
concordanceSearch(concordanceSearchFilter: $concordanceSearchFilter) {
sourceIcf
translationIcf
sourceText
translationText
highlightedSourceText
highlightedTranslationText
published
tmSourceName
lastTranslatedDate
translator {
...UserFragment
}
}
}
Variables
{"concordanceSearchFilter": ConcordanceSearchFilter}
Response
{
"data": {
"concordanceSearch": [
{
"sourceIcf": "Hola",
"translationIcf": "Hola",
"sourceText": "Hola",
"translationText": "Hola",
"highlightedSourceText": "Hola",
"highlightedTranslationText": "Hola",
"published": false,
"tmSourceName": "Hola",
"lastTranslatedDate": "2026-06-17T00:09:44Z",
"translator": User
}
]
}
}
environment
Description
The caller's account or user-scoped environment, including configuration and summary counts
Response
Returns an Environment
Example
Query
query environment {
environment {
environmentUid
environmentType
name
configuration {
...ConfigurationFragment
}
tmSummary {
...TmSummaryFragment
}
leverageSummary {
...LeverageSummaryFragment
}
}
}
Response
{
"data": {
"environment": {
"environmentUid": "2z68632hdvw2",
"environmentType": "ACCOUNT",
"name": "Hola",
"configuration": Configuration,
"tmSummary": TmSummary,
"leverageSummary": LeverageSummary
}
}
}
highlightSearch
Description
Highlights keyword matches within an explicit list of strings without modifying them
Response
Returns a SearchHighlightingResult
Arguments
| Name | Description |
|---|---|
highlightSearchFilter - HighlightSearchFilter
|
Example
Query
query highlightSearch($highlightSearchFilter: HighlightSearchFilter) {
highlightSearch(highlightSearchFilter: $highlightSearchFilter) {
highlightedStrings {
...HighlightedStringFragment
}
highlightedStringCount
highlightedPhraseCount
boundaryChars
}
}
Variables
{"highlightSearchFilter": HighlightSearchFilter}
Response
{
"data": {
"highlightSearch": {
"highlightedStrings": [HighlightedString],
"highlightedStringCount": 123,
"highlightedPhraseCount": 123,
"boundaryChars": "Hola"
}
}
}
leverage
Description
Retrieves a single leverage configuration by UID
Example
Query
query leverage($leverageUid: ID!) {
leverage(leverageUid: $leverageUid) {
leverageUid
sourceLanguageId
name
description
leverageShares {
...LeverageShareFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
leverageSnapshotUid
}
}
Variables
{"leverageUid": "2z68632hdvw2"}
Response
{
"data": {
"leverage": {
"leverageUid": "2z68632hdvw2",
"sourceLanguageId": "en",
"name": "Hola",
"description": "Hola",
"leverageShares": [LeverageShare],
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"leverageSnapshotUid": "Hola"
}
}
}
leverageHistory
Description
Retrieves the configuration change history for a leverage
Response
Returns a LeverageHistory
Arguments
| Name | Description |
|---|---|
leverageHistoryFilter - LeverageHistoryFilter!
|
Example
Query
query leverageHistory($leverageHistoryFilter: LeverageHistoryFilter!) {
leverageHistory(leverageHistoryFilter: $leverageHistoryFilter) {
leverageUid
historyRecords {
...LeverageHistoryRecordFragment
}
}
}
Variables
{"leverageHistoryFilter": LeverageHistoryFilter}
Response
{
"data": {
"leverageHistory": {
"leverageUid": "2z68632hdvw2",
"historyRecords": [LeverageHistoryRecord]
}
}
}
leverageSearch
Description
Lists leverage configurations matching a filter, together with a total count
Response
Returns a LeverageSearchResult
Arguments
| Name | Description |
|---|---|
leverageFilter - LeverageFilter!
|
Example
Query
query leverageSearch($leverageFilter: LeverageFilter!) {
leverageSearch(leverageFilter: $leverageFilter) {
leverages {
...LeverageFragment
}
totalCount
}
}
Variables
{"leverageFilter": LeverageFilter}
Response
{
"data": {
"leverageSearch": {
"leverages": [Leverage],
"totalCount": 123
}
}
}
projects
Description
Looks up projects by UID
Example
Query
query projects($projectUids: [String]!) {
projects(projectUids: $projectUids) {
projectUid
name
}
}
Variables
{"projectUids": ["Hola"]}
Response
{
"data": {
"projects": [
{
"projectUid": "2z68632hdvw2",
"name": "Hola"
}
]
}
}
qcsSearch
Description
Searches translated content across one or more leverages for a single phrase, in QCS's lighter-weight result shape
Response
Returns [QCSSearchResult]
Arguments
| Name | Description |
|---|---|
concordanceSearchFilter - ConcordanceSearchFilter!
|
Example
Query
query qcsSearch($concordanceSearchFilter: ConcordanceSearchFilter!) {
qcsSearch(concordanceSearchFilter: $concordanceSearchFilter) {
sourceText
translationText
published
}
}
Variables
{"concordanceSearchFilter": ConcordanceSearchFilter}
Response
{
"data": {
"qcsSearch": [
{
"sourceText": "Hola",
"translationText": "Hola",
"published": false
}
]
}
}
searchAndReplaceCount
Description
Counts how many matches a search-and-replace would affect, scoped to an explicit list of strings
Response
Returns a SearchAndReplaceCountResult
Arguments
| Name | Description |
|---|---|
searchAndReplaceCountFilter - SearchAndReplaceCountFilter!
|
Example
Query
query searchAndReplaceCount($searchAndReplaceCountFilter: SearchAndReplaceCountFilter!) {
searchAndReplaceCount(searchAndReplaceCountFilter: $searchAndReplaceCountFilter) {
stringCount
phraseCount
}
}
Variables
{
"searchAndReplaceCountFilter": SearchAndReplaceCountFilter
}
Response
{"data": {"searchAndReplaceCount": {"stringCount": 123, "phraseCount": 987}}}
searchAuthorizers
Description
Autocompletes authorizer names known within the given TMs
Response
Returns [User]
Arguments
| Name | Description |
|---|---|
searchFieldFilter - SearchFieldFilter!
|
Example
Query
query searchAuthorizers($searchFieldFilter: SearchFieldFilter!) {
searchAuthorizers(searchFieldFilter: $searchFieldFilter) {
userUid
name
}
}
Variables
{"searchFieldFilter": SearchFieldFilter}
Response
{
"data": {
"searchAuthorizers": [
{
"userUid": "2z68632hdvw2",
"name": "Hola"
}
]
}
}
searchDomains
Description
Autocompletes domain values known within the given TMs
Response
Returns [String]
Arguments
| Name | Description |
|---|---|
searchFieldFilter - SearchFieldFilter!
|
Example
Query
query searchDomains($searchFieldFilter: SearchFieldFilter!) {
searchDomains(searchFieldFilter: $searchFieldFilter)
}
Variables
{"searchFieldFilter": SearchFieldFilter}
Response
{"data": {"searchDomains": ["Hola"]}}
searchEditors
Description
Autocompletes editor names known within the given TMs
Response
Returns [User]
Arguments
| Name | Description |
|---|---|
searchFieldFilter - SearchFieldFilter!
|
Example
Query
query searchEditors($searchFieldFilter: SearchFieldFilter!) {
searchEditors(searchFieldFilter: $searchFieldFilter) {
userUid
name
}
}
Variables
{"searchFieldFilter": SearchFieldFilter}
Response
{
"data": {
"searchEditors": [
{
"userUid": "2z68632hdvw2",
"name": "Hola"
}
]
}
}
searchFileNames
Description
Autocompletes source file names known within the given TMs
Response
Returns [String]
Arguments
| Name | Description |
|---|---|
searchFieldFilter - SearchFieldFilter!
|
Example
Query
query searchFileNames($searchFieldFilter: SearchFieldFilter!) {
searchFileNames(searchFieldFilter: $searchFieldFilter)
}
Variables
{"searchFieldFilter": SearchFieldFilter}
Response
{"data": {"searchFileNames": ["Hola"]}}
searchKeys
Description
Autocompletes string keys known within the given TMs
Response
Returns [String]
Arguments
| Name | Description |
|---|---|
searchFieldFilter - SearchFieldFilter!
|
Example
Query
query searchKeys($searchFieldFilter: SearchFieldFilter!) {
searchKeys(searchFieldFilter: $searchFieldFilter)
}
Variables
{"searchFieldFilter": SearchFieldFilter}
Response
{"data": {"searchKeys": ["Hola"]}}
searchLeverages
Description
Lists leverage configurations matching a filter
Response
Returns [Leverage]
Arguments
| Name | Description |
|---|---|
leverageFilter - LeverageFilter!
|
Example
Query
query searchLeverages($leverageFilter: LeverageFilter!) {
searchLeverages(leverageFilter: $leverageFilter) {
leverageUid
sourceLanguageId
name
description
leverageShares {
...LeverageShareFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
leverageSnapshotUid
}
}
Variables
{"leverageFilter": LeverageFilter}
Response
{
"data": {
"searchLeverages": [
{
"leverageUid": "2z68632hdvw2",
"sourceLanguageId": "en",
"name": "Hola",
"description": "Hola",
"leverageShares": [LeverageShare],
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"leverageSnapshotUid": "Hola"
}
]
}
}
searchProjects
Description
Autocompletes project names known within the given TMs
Response
Returns [Project]
Arguments
| Name | Description |
|---|---|
searchFieldFilter - SearchFieldFilter!
|
Example
Query
query searchProjects($searchFieldFilter: SearchFieldFilter!) {
searchProjects(searchFieldFilter: $searchFieldFilter) {
projectUid
name
}
}
Variables
{"searchFieldFilter": SearchFieldFilter}
Response
{
"data": {
"searchProjects": [
{
"projectUid": "2z68632hdvw2",
"name": "Hola"
}
]
}
}
searchReviewers
Description
Autocompletes reviewer names known within the given TMs
Response
Returns [User]
Arguments
| Name | Description |
|---|---|
searchFieldFilter - SearchFieldFilter!
|
Example
Query
query searchReviewers($searchFieldFilter: SearchFieldFilter!) {
searchReviewers(searchFieldFilter: $searchFieldFilter) {
userUid
name
}
}
Variables
{"searchFieldFilter": SearchFieldFilter}
Response
{
"data": {
"searchReviewers": [
{
"userUid": "2z68632hdvw2",
"name": "Hola"
}
]
}
}
searchSourceGroups
Description
Lists source groups matching a filter
Response
Returns [SourceGroup]
Arguments
| Name | Description |
|---|---|
sourceGroupFilter - SourceGroupFilter!
|
Example
Query
query searchSourceGroups($sourceGroupFilter: SourceGroupFilter!) {
searchSourceGroups(sourceGroupFilter: $sourceGroupFilter) {
sourceGroupUid
sourceLanguageId
name
description
tms {
...TMFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
}
}
Variables
{"sourceGroupFilter": SourceGroupFilter}
Response
{
"data": {
"searchSourceGroups": [
{
"sourceGroupUid": "2z68632hdvw2",
"sourceLanguageId": "en",
"name": "Hola",
"description": "Hola",
"tms": [TM],
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z"
}
]
}
}
searchTargetLocales
Description
Lists the target locales reachable from a given source language
Response
Returns [Locale!]!
Arguments
| Name | Description |
|---|---|
targetLocaleFilter - TargetLocaleFilter!
|
Example
Query
query searchTargetLocales($targetLocaleFilter: TargetLocaleFilter!) {
searchTargetLocales(targetLocaleFilter: $targetLocaleFilter) {
localeId
localeDescription
rtlLanguage
wordSpacing
}
}
Variables
{"targetLocaleFilter": TargetLocaleFilter}
Response
{
"data": {
"searchTargetLocales": [
{
"localeId": "en-US",
"localeDescription": "Hola",
"rtlLanguage": false,
"wordSpacing": false
}
]
}
}
searchTms
Description
Lists translation memories matching a filter
Response
Returns [TM]
Arguments
| Name | Description |
|---|---|
searchTmFilter - SearchTmFilter!
|
Example
Query
query searchTms($searchTmFilter: SearchTmFilter!) {
searchTms(searchTmFilter: $searchTmFilter) {
tmUid
name
description
sourceLocaleId
sourceLocale {
...LocaleFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
localeSummary {
...LocaleSummaryFragment
}
translationQuality
managedWordsEnabled
}
}
Variables
{"searchTmFilter": SearchTmFilter}
Response
{
"data": {
"searchTms": [
{
"tmUid": "2z68632hdvw2",
"name": "Hola",
"description": "Hola",
"sourceLocaleId": "en-US",
"sourceLocale": Locale,
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"localeSummary": [LocaleSummary],
"translationQuality": "TRANSLATION",
"managedWordsEnabled": true
}
]
}
}
searchTmxFileNames
Description
Autocompletes TMX file names known within the given TMs
Response
Returns [String]
Arguments
| Name | Description |
|---|---|
searchFieldFilter - SearchFieldFilter!
|
Example
Query
query searchTmxFileNames($searchFieldFilter: SearchFieldFilter!) {
searchTmxFileNames(searchFieldFilter: $searchFieldFilter)
}
Variables
{"searchFieldFilter": SearchFieldFilter}
Response
{"data": {"searchTmxFileNames": ["Hola"]}}
searchTmxImports
Description
Lists TMX imports matching a filter
Response
Returns a TmxImportsSearchResult
Arguments
| Name | Description |
|---|---|
tmxFilter - TmxFilter!
|
Example
Query
query searchTmxImports($tmxFilter: TmxFilter!) {
searchTmxImports(tmxFilter: $tmxFilter) {
tmxImports {
...TMXFragment
}
totalCount
}
}
Variables
{"tmxFilter": TmxFilter}
Response
{
"data": {
"searchTmxImports": {
"tmxImports": [TMX],
"totalCount": 987
}
}
}
searchTranslationMemories
Description
Lists translation memories matching a filter, together with a total count
Response
Returns a TranslationMemories
Arguments
| Name | Description |
|---|---|
searchTmFilter - SearchTmFilter!
|
Example
Query
query searchTranslationMemories($searchTmFilter: SearchTmFilter!) {
searchTranslationMemories(searchTmFilter: $searchTmFilter) {
translationMemories {
...TMFragment
}
totalCount
}
}
Variables
{"searchTmFilter": SearchTmFilter}
Response
{
"data": {
"searchTranslationMemories": {
"translationMemories": [TM],
"totalCount": 987
}
}
}
searchTranslators
Description
Autocompletes translator names known within the given TMs
Response
Returns [User]
Arguments
| Name | Description |
|---|---|
searchFieldFilter - SearchFieldFilter!
|
Example
Query
query searchTranslators($searchFieldFilter: SearchFieldFilter!) {
searchTranslators(searchFieldFilter: $searchFieldFilter) {
userUid
name
}
}
Variables
{"searchFieldFilter": SearchFieldFilter}
Response
{
"data": {
"searchTranslators": [
{
"userUid": "2z68632hdvw2",
"name": "Hola"
}
]
}
}
searchTranslatorsByLeverage
Description
Autocompletes translator names known within a single leverage and locale
Response
Returns [User]
Arguments
| Name | Description |
|---|---|
searchFieldByLeverageFilter - SearchFieldByLeverageFilter!
|
Example
Query
query searchTranslatorsByLeverage($searchFieldByLeverageFilter: SearchFieldByLeverageFilter!) {
searchTranslatorsByLeverage(searchFieldByLeverageFilter: $searchFieldByLeverageFilter) {
userUid
name
}
}
Variables
{
"searchFieldByLeverageFilter": SearchFieldByLeverageFilter
}
Response
{
"data": {
"searchTranslatorsByLeverage": [
{
"userUid": "2z68632hdvw2",
"name": "Hola"
}
]
}
}
searchUrls
Description
Autocompletes source URLs known within the given TMs
Response
Returns [String]
Arguments
| Name | Description |
|---|---|
searchFieldFilter - SearchFieldFilter!
|
Example
Query
query searchUrls($searchFieldFilter: SearchFieldFilter!) {
searchUrls(searchFieldFilter: $searchFieldFilter)
}
Variables
{"searchFieldFilter": SearchFieldFilter}
Response
{"data": {"searchUrls": ["Hola"]}}
searchVariants
Description
Autocompletes plural variant identifiers known within the given TMs
Response
Returns [String]
Arguments
| Name | Description |
|---|---|
searchFieldFilter - SearchFieldFilter!
|
Example
Query
query searchVariants($searchFieldFilter: SearchFieldFilter!) {
searchVariants(searchFieldFilter: $searchFieldFilter)
}
Variables
{"searchFieldFilter": SearchFieldFilter}
Response
{"data": {"searchVariants": ["Hola"]}}
smartMatchEnabled
Description
Checks whether SmartMatch is enabled for a leverage/locale pair. When enabled, an exact TM match is applied automatically, skipping the translation step
Response
Returns a SmartMatchEnabledResult
Arguments
| Name | Description |
|---|---|
smartMatchEnabledFilter - SmartMatchEnabledFilter!
|
Example
Query
query smartMatchEnabled($smartMatchEnabledFilter: SmartMatchEnabledFilter!) {
smartMatchEnabled(smartMatchEnabledFilter: $smartMatchEnabledFilter) {
enabled
}
}
Variables
{"smartMatchEnabledFilter": SmartMatchEnabledFilter}
Response
{"data": {"smartMatchEnabled": {"enabled": false}}}
smartMatchLeverage
Description
Retrieves the SmartMatch leverage configuration for a TM/locale pair
Response
Returns [SmartMatchLeverage]
Arguments
| Name | Description |
|---|---|
smartMatchLeverageFilter - SmartMatchLeverageFilter!
|
Example
Query
query smartMatchLeverage($smartMatchLeverageFilter: SmartMatchLeverageFilter!) {
smartMatchLeverage(smartMatchLeverageFilter: $smartMatchLeverageFilter) {
leverageUid
localeIds
locales {
...LeverageLocaleFragment
}
}
}
Variables
{"smartMatchLeverageFilter": SmartMatchLeverageFilter}
Response
{
"data": {
"smartMatchLeverage": [
{
"leverageUid": "2z68632hdvw2",
"localeIds": ["de-DE"],
"locales": [LeverageLocale]
}
]
}
}
sourceGroup
Description
Retrieves a single source group by UID
Response
Returns a SourceGroup
Arguments
| Name | Description |
|---|---|
sourceGroupUid - ID!
|
Example
Query
query sourceGroup($sourceGroupUid: ID!) {
sourceGroup(sourceGroupUid: $sourceGroupUid) {
sourceGroupUid
sourceLanguageId
name
description
tms {
...TMFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
}
}
Variables
{"sourceGroupUid": "2z68632hdvw2"}
Response
{
"data": {
"sourceGroup": {
"sourceGroupUid": "2z68632hdvw2",
"sourceLanguageId": "en",
"name": "Hola",
"description": "Hola",
"tms": [TM],
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z"
}
}
}
stringEditAsyncStatus
Description
Checks the progress of an editStringAsync action
Response
Returns a StringEditAsyncActionResult
Arguments
| Name | Description |
|---|---|
actionUid - ID!
|
Example
Query
query stringEditAsyncStatus($actionUid: ID!) {
stringEditAsyncStatus(actionUid: $actionUid) {
actionUid
totalCount
processedCount
executionComplete
editedStringCount
propagatedStringCount
tmUid
tmStringUid
resultedTmStringUid
}
}
Variables
{"actionUid": "2z68632hdvw2"}
Response
{
"data": {
"stringEditAsyncStatus": {
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 987,
"processedCount": 987,
"executionComplete": false,
"editedStringCount": 123,
"propagatedStringCount": 123,
"tmUid": "2z68632hdvw2",
"tmStringUid": "Hola",
"resultedTmStringUid": "Hola"
}
}
}
stringHistory
Description
Retrieves translation history for a set of strings in a single locale
Response
Returns [TranslationHistoryRecord!]!
Arguments
| Name | Description |
|---|---|
stringHistoryFilter - StringHistoryFilter!
|
Example
Query
query stringHistory($stringHistoryFilter: StringHistoryFilter!) {
stringHistory(stringHistoryFilter: $stringHistoryFilter) {
hashcode
projectUid
targetLocaleId
translator {
...UserFragment
}
translationDate
sourceText
translationText
}
}
Variables
{"stringHistoryFilter": StringHistoryFilter}
Response
{
"data": {
"stringHistory": [
{
"hashcode": "Hola",
"projectUid": "Hola",
"targetLocaleId": "de-DE",
"translator": User,
"translationDate": "2026-06-17T00:09:44Z",
"sourceText": "Hola",
"translationText": "Hola"
}
]
}
}
tm
Description
Retrieves a single translation memory by UID
Example
Query
query tm($tmUid: ID!) {
tm(tmUid: $tmUid) {
tmUid
name
description
sourceLocaleId
sourceLocale {
...LocaleFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
localeSummary {
...LocaleSummaryFragment
}
translationQuality
managedWordsEnabled
}
}
Variables
{"tmUid": "2z68632hdvw2"}
Response
{
"data": {
"tm": {
"tmUid": "2z68632hdvw2",
"name": "Hola",
"description": "Hola",
"sourceLocaleId": "en-US",
"sourceLocale": Locale,
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"localeSummary": [LocaleSummary],
"translationQuality": "TRANSLATION",
"managedWordsEnabled": false
}
}
}
tmStats
Description
Retrieves locale-level string and word count statistics
Response
Returns [LocaleSummary]
Arguments
| Name | Description |
|---|---|
tmStatsFilter - TmStatsFilter!
|
Example
Query
query tmStats($tmStatsFilter: TmStatsFilter!) {
tmStats(tmStatsFilter: $tmStatsFilter) {
translationLocaleId
translationLocale {
...LocaleFragment
}
stringCount
wordCount
}
}
Variables
{"tmStatsFilter": TmStatsFilter}
Response
{
"data": {
"tmStats": [
{
"translationLocaleId": "de-DE",
"translationLocale": Locale,
"stringCount": 987,
"wordCount": 987
}
]
}
}
tmString
Description
Retrieves a single TM string by UID
Example
Query
query tmString(
$tmUid: ID!,
$tmStringUid: ID!
) {
tmString(
tmUid: $tmUid,
tmStringUid: $tmStringUid
) {
tmStringUid
tm {
...TMFragment
}
stringMetadata {
...StringMetadataFragment
}
sourceLocaleId
translationLocaleId
sourceText
translationText
sourceNonPluralText
translationNonPluralText
sourceZeroText
sourceOneText
sourceTwoText
sourceFewText
sourceManyText
sourceOtherText
translationZeroText
translationOneText
translationTwoText
translationFewText
translationManyText
translationOtherText
tmStringIcf {
...TmStringIcfFragment
}
lastModificationDate
stringMetadataCount
leverageType
wordCount
highlightedSourceText
highlightedTranslationText
}
}
Variables
{
"tmUid": "2z68632hdvw2",
"tmStringUid": "2z68632hdvw2"
}
Response
{
"data": {
"tmString": {
"tmStringUid": "2z68632hdvw2",
"tm": TM,
"stringMetadata": [StringMetadata],
"sourceLocaleId": "en-US",
"translationLocaleId": "ja",
"sourceText": "Hola",
"translationText": "Hola",
"sourceNonPluralText": "Hola",
"translationNonPluralText": "Hola",
"sourceZeroText": "Hola",
"sourceOneText": "Hola",
"sourceTwoText": "Hola",
"sourceFewText": "Hola",
"sourceManyText": "Hola",
"sourceOtherText": "Hola",
"translationZeroText": "Hola",
"translationOneText": "Hola",
"translationTwoText": "Hola",
"translationFewText": "Hola",
"translationManyText": "Hola",
"translationOtherText": "Hola",
"tmStringIcf": TmStringIcf,
"lastModificationDate": "2026-06-17T00:09:44Z",
"stringMetadataCount": 987,
"leverageType": "PUBLISHED",
"wordCount": 123,
"highlightedSourceText": "Hola",
"highlightedTranslationText": "Hola"
}
}
}
tmx
Description
Retrieves a single TMX import record by file name
Example
Query
query tmx(
$tmUid: ID!,
$tmxFileName: String!
) {
tmx(
tmUid: $tmUid,
tmxFileName: $tmxFileName
) {
tmxFileName
complete
errors {
...TmxErrorFragment
}
requestCount
processedCount
skippedCount
tmxUid
tm {
...TMFragment
}
localeSummary {
...LocaleSummaryFragment
}
creator {
...UserFragment
}
created
}
}
Variables
{
"tmUid": "2z68632hdvw2",
"tmxFileName": "Hola"
}
Response
{
"data": {
"tmx": {
"tmxFileName": "Hola",
"complete": true,
"errors": [TmxError],
"requestCount": 987,
"processedCount": 123,
"skippedCount": 987,
"tmxUid": "Hola",
"tm": TM,
"localeSummary": [LocaleSummary],
"creator": User,
"created": "2026-06-17T00:09:44Z"
}
}
}
translationLocales
Description
Lists every source and translation locale available in the account
Response
Returns a TranslationLocales
Example
Query
query translationLocales {
translationLocales {
translationLocales {
...LocaleFragment
}
totalCount
}
}
Response
{
"data": {
"translationLocales": {
"translationLocales": [Locale],
"totalCount": 123
}
}
}
translationMemories
Description
Retrieves multiple translation memories by UID
Example
Query
query translationMemories($tmUids: [ID!]!) {
translationMemories(tmUids: $tmUids) {
tmUid
name
description
sourceLocaleId
sourceLocale {
...LocaleFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
localeSummary {
...LocaleSummaryFragment
}
translationQuality
managedWordsEnabled
}
}
Variables
{"tmUids": ["2z68632hdvw2"]}
Response
{
"data": {
"translationMemories": [
{
"tmUid": "2z68632hdvw2",
"name": "Hola",
"description": "Hola",
"sourceLocaleId": "en-US",
"sourceLocale": Locale,
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"localeSummary": [LocaleSummary],
"translationQuality": "TRANSLATION",
"managedWordsEnabled": false
}
]
}
}
tuTranslationQualityDictionary
Description
Lookup table of human-readable labels for TuTranslationQualityType values
Response
Example
Query
query tuTranslationQualityDictionary {
tuTranslationQualityDictionary {
value
label
}
}
Response
{
"data": {
"tuTranslationQualityDictionary": [
{"value": "HUMAN", "label": "Hola"}
]
}
}
users
Description
Looks up users by UID
Mutations
bulkExportTmStrings
Description
Asynchronously exports every string matched by a previously created search. Every matched string's TM must belong to the caller's account
Response
Returns an AsyncActionResult
Arguments
| Name | Description |
|---|---|
bulkExportTmStrings - BulkExportTmStrings!
|
Example
Query
mutation bulkExportTmStrings($bulkExportTmStrings: BulkExportTmStrings!) {
bulkExportTmStrings(bulkExportTmStrings: $bulkExportTmStrings) {
actionUid
totalCount
processedCount
errorCount
executionComplete
actionStatus
}
}
Variables
{"bulkExportTmStrings": BulkExportTmStrings}
Response
{
"data": {
"bulkExportTmStrings": {
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 123,
"processedCount": 987,
"errorCount": 123,
"executionComplete": false,
"actionStatus": "QUEUEING"
}
}
}
bulkSearchAndReplace
Description
Asynchronously searches and replaces text within every string matched by a previously created search
Response
Returns an AsyncActionResult
Arguments
| Name | Description |
|---|---|
bulkSearchAndReplaceFilter - BulkSearchAndReplaceFilter!
|
Example
Query
mutation bulkSearchAndReplace($bulkSearchAndReplaceFilter: BulkSearchAndReplaceFilter!) {
bulkSearchAndReplace(bulkSearchAndReplaceFilter: $bulkSearchAndReplaceFilter) {
actionUid
totalCount
processedCount
errorCount
executionComplete
actionStatus
}
}
Variables
{"bulkSearchAndReplaceFilter": BulkSearchAndReplaceFilter}
Response
{
"data": {
"bulkSearchAndReplace": {
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 123,
"processedCount": 123,
"errorCount": 123,
"executionComplete": true,
"actionStatus": "QUEUEING"
}
}
}
createLeverage
Description
Creates a new leverage configuration
Response
Returns a Leverage
Arguments
| Name | Description |
|---|---|
createLeverage - CreateLeverage!
|
Example
Query
mutation createLeverage($createLeverage: CreateLeverage!) {
createLeverage(createLeverage: $createLeverage) {
leverageUid
sourceLanguageId
name
description
leverageShares {
...LeverageShareFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
leverageSnapshotUid
}
}
Variables
{"createLeverage": CreateLeverage}
Response
{
"data": {
"createLeverage": {
"leverageUid": "2z68632hdvw2",
"sourceLanguageId": "en",
"name": "Hola",
"description": "Hola",
"leverageShares": [LeverageShare],
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"leverageSnapshotUid": "Hola"
}
}
}
createSourceGroup
Description
Creates a new source group
Response
Returns a SourceGroup
Arguments
| Name | Description |
|---|---|
createSourceGroup - CreateSourceGroup!
|
Example
Query
mutation createSourceGroup($createSourceGroup: CreateSourceGroup!) {
createSourceGroup(createSourceGroup: $createSourceGroup) {
sourceGroupUid
sourceLanguageId
name
description
tms {
...TMFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
}
}
Variables
{"createSourceGroup": CreateSourceGroup}
Response
{
"data": {
"createSourceGroup": {
"sourceGroupUid": "2z68632hdvw2",
"sourceLanguageId": "en",
"name": "Hola",
"description": "Hola",
"tms": [TM],
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z"
}
}
}
createStringSearch
Description
Creates and indexes a string search for later browsing, reporting, or bulk operations
Response
Returns a CreateStringSearchResult
Arguments
| Name | Description |
|---|---|
createStringSearchFilter - CreateStringSearchFilter!
|
Example
Query
mutation createStringSearch($createStringSearchFilter: CreateStringSearchFilter!) {
createStringSearch(createStringSearchFilter: $createStringSearchFilter) {
searchUid
stringCount
wordCount
duplicateStrings {
...DuplicateStringFragment
}
duplicateSearch
actionUid
offlineReportUid
}
}
Variables
{"createStringSearchFilter": CreateStringSearchFilter}
Response
{
"data": {
"createStringSearch": {
"searchUid": "2z68632hdvw2",
"stringCount": 987,
"wordCount": 123,
"duplicateStrings": [DuplicateString],
"duplicateSearch": true,
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"offlineReportUid": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22"
}
}
}
createTm
Description
Creates a new translation memory
Example
Query
mutation createTm($createTm: CreateTm!) {
createTm(createTm: $createTm) {
tmUid
name
description
sourceLocaleId
sourceLocale {
...LocaleFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
localeSummary {
...LocaleSummaryFragment
}
translationQuality
managedWordsEnabled
}
}
Variables
{"createTm": CreateTm}
Response
{
"data": {
"createTm": {
"tmUid": "2z68632hdvw2",
"name": "Hola",
"description": "Hola",
"sourceLocaleId": "en-US",
"sourceLocale": Locale,
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"localeSummary": [LocaleSummary],
"translationQuality": "TRANSLATION",
"managedWordsEnabled": true
}
}
}
editStringAsync
Description
Asynchronously edits a TM string's translation text and plural variants
Response
Returns an AsyncActionResult
Arguments
| Name | Description |
|---|---|
editString - EditString!
|
Example
Query
mutation editStringAsync($editString: EditString!) {
editStringAsync(editString: $editString) {
actionUid
totalCount
processedCount
errorCount
executionComplete
actionStatus
}
}
Variables
{"editString": EditString}
Response
{
"data": {
"editStringAsync": {
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 987,
"processedCount": 987,
"errorCount": 987,
"executionComplete": true,
"actionStatus": "QUEUEING"
}
}
}
searchAndReplace
Description
Synchronously searches and replaces text within an explicit list of strings
Response
Returns a SearchAndReplaceResult
Arguments
| Name | Description |
|---|---|
searchAndReplaceFilter - SearchAndReplaceFilter!
|
Example
Query
mutation searchAndReplace($searchAndReplaceFilter: SearchAndReplaceFilter!) {
searchAndReplace(searchAndReplaceFilter: $searchAndReplaceFilter) {
actionUid
isAsync
editedStringCount
replacedPhraseCount
propagatedStringCount
}
}
Variables
{"searchAndReplaceFilter": SearchAndReplaceFilter}
Response
{
"data": {
"searchAndReplace": {
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"isAsync": true,
"editedStringCount": 123,
"replacedPhraseCount": 123,
"propagatedStringCount": 987
}
}
}
searchAndReplaceAsync
Description
Asynchronously searches and replaces text within an explicit list of strings
Response
Returns an AsyncActionResult
Arguments
| Name | Description |
|---|---|
searchAndReplaceFilter - SearchAndReplaceFilter!
|
Example
Query
mutation searchAndReplaceAsync($searchAndReplaceFilter: SearchAndReplaceFilter!) {
searchAndReplaceAsync(searchAndReplaceFilter: $searchAndReplaceFilter) {
actionUid
totalCount
processedCount
errorCount
executionComplete
actionStatus
}
}
Variables
{"searchAndReplaceFilter": SearchAndReplaceFilter}
Response
{
"data": {
"searchAndReplaceAsync": {
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 987,
"processedCount": 123,
"errorCount": 987,
"executionComplete": true,
"actionStatus": "QUEUEING"
}
}
}
updateLeverage
Description
Renames or re-describes an existing leverage configuration
Response
Returns a Leverage
Arguments
| Name | Description |
|---|---|
updateLeverage - UpdateLeverage!
|
Example
Query
mutation updateLeverage($updateLeverage: UpdateLeverage!) {
updateLeverage(updateLeverage: $updateLeverage) {
leverageUid
sourceLanguageId
name
description
leverageShares {
...LeverageShareFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
leverageSnapshotUid
}
}
Variables
{"updateLeverage": UpdateLeverage}
Response
{
"data": {
"updateLeverage": {
"leverageUid": "2z68632hdvw2",
"sourceLanguageId": "en",
"name": "Hola",
"description": "Hola",
"leverageShares": [LeverageShare],
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"leverageSnapshotUid": "Hola"
}
}
}
updateSourceGroup
Description
Renames, re-describes, or changes the TM membership of a source group
Response
Returns a SourceGroup
Arguments
| Name | Description |
|---|---|
updateSourceGroup - UpdateSourceGroup!
|
Example
Query
mutation updateSourceGroup($updateSourceGroup: UpdateSourceGroup!) {
updateSourceGroup(updateSourceGroup: $updateSourceGroup) {
sourceGroupUid
sourceLanguageId
name
description
tms {
...TMFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
}
}
Variables
{"updateSourceGroup": UpdateSourceGroup}
Response
{
"data": {
"updateSourceGroup": {
"sourceGroupUid": "2z68632hdvw2",
"sourceLanguageId": "en",
"name": "Hola",
"description": "Hola",
"tms": [TM],
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z"
}
}
}
updateTm
Description
Renames or re-describes an existing translation memory
Example
Query
mutation updateTm($updateTm: UpdateTm!) {
updateTm(updateTm: $updateTm) {
tmUid
name
description
sourceLocaleId
sourceLocale {
...LocaleFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
localeSummary {
...LocaleSummaryFragment
}
translationQuality
managedWordsEnabled
}
}
Variables
{"updateTm": UpdateTm}
Response
{
"data": {
"updateTm": {
"tmUid": "2z68632hdvw2",
"name": "Hola",
"description": "Hola",
"sourceLocaleId": "en-US",
"sourceLocale": Locale,
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"localeSummary": [LocaleSummary],
"translationQuality": "TRANSLATION",
"managedWordsEnabled": true
}
}
}
updateTmManagedWordsEnabled
Description
Enables or disables managed words on a translation memory
Response
Returns a TM
Arguments
| Name | Description |
|---|---|
updateTmManagedWordsEnabled - UpdateTmManagedWordsEnabled!
|
Example
Query
mutation updateTmManagedWordsEnabled($updateTmManagedWordsEnabled: UpdateTmManagedWordsEnabled!) {
updateTmManagedWordsEnabled(updateTmManagedWordsEnabled: $updateTmManagedWordsEnabled) {
tmUid
name
description
sourceLocaleId
sourceLocale {
...LocaleFragment
}
creator {
...UserFragment
}
created
lastModifier {
...UserFragment
}
lastModified
localeSummary {
...LocaleSummaryFragment
}
translationQuality
managedWordsEnabled
}
}
Variables
{
"updateTmManagedWordsEnabled": UpdateTmManagedWordsEnabled
}
Response
{
"data": {
"updateTmManagedWordsEnabled": {
"tmUid": "2z68632hdvw2",
"name": "Hola",
"description": "Hola",
"sourceLocaleId": "en-US",
"sourceLocale": Locale,
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"localeSummary": [LocaleSummary],
"translationQuality": "TRANSLATION",
"managedWordsEnabled": false
}
}
}
Types
AffectedBulkActionsBySearch
Description
Warning about bulk actions in progress that may affect the strings in a search
Fields
| Field Name | Description |
|---|---|
message - String
|
Human-readable warning message, if any bulk actions are affected |
Example
{"message": "Hola"}
AsyncActionResult
Description
Progress and outcome of a long-running asynchronous action
Fields
| Field Name | Description |
|---|---|
actionUid - ID!
|
Unique identifier for this action, used to poll its status |
totalCount - Int!
|
Total number of items the action expects to process |
processedCount - Int!
|
Number of items processed so far |
errorCount - Int!
|
Number of items that failed to process |
executionComplete - Boolean!
|
Whether the action has fully completed |
actionStatus - AsyncActionStatus!
|
Current lifecycle status of the action |
Example
{
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 987,
"processedCount": 987,
"errorCount": 987,
"executionComplete": false,
"actionStatus": "QUEUEING"
}
AsyncActionStatus
Description
Lifecycle status of a long-running asynchronous action
Values
| Enum Value | Description |
|---|---|
|
|
Waiting to start |
|
|
Currently running |
|
|
Finished without errors |
|
|
Finished with at least one error |
|
|
Canceled by a caller before completion. Results may be partial |
|
|
Stopped before completion for a reason other than cancellation or failure |
Example
"QUEUEING"
Boolean
Description
The Boolean scalar type represents true or false
Example
true
BrowseStringSearchFilter
Description
Pagination and count filter for browseStringSearch
Fields
| Input Field | Description |
|---|---|
searchUid - ID!
|
UID of the search to browse, returned by createStringSearch |
duplicateKey - String
|
Restrict to strings sharing this duplicate-detection key |
includeCounts - Boolean
|
Include aggregate string and word counts in the result. Default = false |
first - Int
|
Maximum number of strings to return. Default = 50 |
offset - Int
|
Number of strings to skip before returning results. Default = 0 |
Example
{
"searchUid": "2z68632hdvw2",
"duplicateKey": "Hola",
"includeCounts": true,
"first": 987,
"offset": 987
}
BrowseStringSearchResult
Description
Result of browsing a previously created string search, including aggregate counts
Fields
| Field Name | Description |
|---|---|
tmStrings - [TmString!]!
|
Page of matched TM strings |
stringCount - Int
|
Total number of strings matched, when includeCounts was requested |
wordCount - Int
|
Total number of words matched, when includeCounts was requested |
asyncActionResult - AsyncActionResult
|
Status of the async action still indexing this search, if indexing has not yet finished |
affectsBulkActionsBySearch - AffectedBulkActionsBySearch
|
Bulk actions currently in progress that may affect strings in this search |
Example
{
"tmStrings": [TmString],
"stringCount": 123,
"wordCount": 987,
"asyncActionResult": AsyncActionResult,
"affectsBulkActionsBySearch": AffectedBulkActionsBySearch
}
BrowseStringsFilter
Description
Pagination filter for browsing the strings captured by a previous createStringSearch
Fields
| Input Field | Description |
|---|---|
searchUid - ID!
|
UID of the search to browse, returned by createStringSearch |
duplicateKey - String
|
Restrict to strings sharing this duplicate-detection key |
first - Int
|
Maximum number of strings to return. Default = 50 |
offset - Int
|
Number of strings to skip before returning results. Default = 0 |
Example
{
"searchUid": "2z68632hdvw2",
"duplicateKey": "Hola",
"first": 987,
"offset": 987
}
BulkExportTmStrings
Description
Input for exporting every string matched by a previously created search. Every matched string's TM must belong to the caller's account
Fields
| Input Field | Description |
|---|---|
searchUid - ID!
|
UID of the search whose matches should be exported, returned by createStringSearch |
extendedMetadata - Boolean
|
Include extended metadata such as first/last translation info in the export |
extendedMetadataType - ExtendedExportMetadataType
|
Which end of the translation history extended metadata should describe |
includeAllVariants - Boolean
|
Include every plural variant of each exported string |
Example
{
"searchUid": "2z68632hdvw2",
"extendedMetadata": true,
"extendedMetadataType": "FIRST_TRANSLATED_STRINGS",
"includeAllVariants": true
}
BulkSearchAndReplaceCountFilter
Description
Filter for counting how many matches a search-and-replace would affect, scoped to a previously created string search
Fields
| Input Field | Description |
|---|---|
searchUid - ID!
|
UID of the search to run the count against, returned by createStringSearch |
searchPhrase - String!
|
Phrase to search for. Must not be blank |
matchCase - Boolean!
|
Match letter case exactly |
wholeWord - Boolean!
|
Require the phrase to match on whole-word boundaries |
Example
{
"searchUid": "2z68632hdvw2",
"searchPhrase": "Hola",
"matchCase": false,
"wholeWord": true
}
BulkSearchAndReplaceFilter
Description
Filter for a bulk search-and-replace scoped to a previously created string search
Fields
| Input Field | Description |
|---|---|
searchUid - ID!
|
UID of the search to run the replacement against, returned by createStringSearch |
searchPhrase - String!
|
Phrase to search for. Must not be blank |
replacePhrase - String!
|
Replacement text. Must not be blank; a blank value would delete every matched fragment instead of replacing it |
matchCase - Boolean!
|
Match letter case exactly |
wholeWord - Boolean!
|
Require the phrase to match on whole-word boundaries |
propagate - Boolean!
|
Apply the same replacement to every plural variant of a matched string |
Example
{
"searchUid": "2z68632hdvw2",
"searchPhrase": "Hola",
"replacePhrase": "Hola",
"matchCase": true,
"wholeWord": false,
"propagate": true
}
ConcordanceSearchFilter
Description
Filter for a single-phrase concordance search within one leverage and locale
Fields
| Input Field | Description |
|---|---|
leverageUid - ID!
|
Leverage to search within |
translationLocaleId - String!
|
Target locale ID to search within |
phrase - String!
|
Phrase to search for |
translationDateRangeStart - Date
|
Restrict to matches translated on or after this date |
translationDateRangeEnd - Date
|
Restrict to matches translated on or before this date |
translatorUids - [String]
|
Restrict to matches translated by one of these user UIDs |
searchOptions - ConcordanceSearchOptions
|
Options controlling how the search matches and reports results |
Example
{
"leverageUid": "2z68632hdvw2",
"translationLocaleId": "Hola",
"phrase": "Hola",
"translationDateRangeStart": "2026-06-17T00:09:44Z",
"translationDateRangeEnd": "2026-06-17T00:09:44Z",
"translatorUids": ["Hola"],
"searchOptions": ConcordanceSearchOptions
}
ConcordanceSearchOptions
Description
Options controlling how a concordance search matches and reports results
Fields
| Input Field | Description |
|---|---|
searchTarget - Boolean
|
Match the search phrase against translation text instead of source text |
caseSensitive - Boolean
|
Match letter case exactly |
publishedOnly - Boolean
|
Restrict matches to strings that have been published |
highlightMatches - Boolean
|
Wrap matched text in the result with highlight markers |
characterExactSearch - Boolean
|
Require the match to align on character boundaries rather than word boundaries |
Example
{
"searchTarget": false,
"caseSensitive": false,
"publishedOnly": true,
"highlightMatches": false,
"characterExactSearch": false
}
ConcordanceSearchResult
Description
Result of a single-phrase concordance search
Fields
| Field Name | Description |
|---|---|
sourceIcf - String!
|
Source text in ICF format |
translationIcf - String!
|
Translation text in ICF format |
sourceText - String!
|
Source text |
translationText - String!
|
Translation text |
highlightedSourceText - String
|
Source text with the search phrase wrapped in highlight markers, when highlightMatches was requested |
highlightedTranslationText - String
|
Translation text with the search phrase wrapped in highlight markers, when highlightMatches was requested |
published - Boolean!
|
Whether this string has been published |
tmSourceName - String!
|
Name of the TM this match came from |
lastTranslatedDate - Date
|
When this match was last translated |
translator - User
|
User who translated this match |
Example
{
"sourceIcf": "Hola",
"translationIcf": "Hola",
"sourceText": "Hola",
"translationText": "Hola",
"highlightedSourceText": "Hola",
"highlightedTranslationText": "Hola",
"published": true,
"tmSourceName": "Hola",
"lastTranslatedDate": "2026-06-17T00:09:44Z",
"translator": User
}
Configuration
Description
Feature flags controlling which TM operations are available in an environment
Example
{"createTmEnabled": false, "importTmxEnabled": true, "exportTmxEnabled": true}
CreateLeverage
Description
Input for creating a new leverage configuration. A leverage configuration controls which completed translations are available for reuse and how they are applied
Example
{
"sourceLanguageId": "Hola",
"name": "Hola",
"description": "Hola"
}
CreateSmartMatchRule
Description
Input describing a single SmartMatch rule to attach to a leverage share (TM source). Enabling a rule lets a matching TM entry apply automatically at the given precision, skipping the translation step
Fields
| Input Field | Description |
|---|---|
smartMatchType - SmartMatchType!
|
Precision of match this rule allows |
smartMatchTargetStep - SmartMatchTargetStep!
|
Workflow step this rule applies to |
prePublished - Boolean!
|
Whether this rule applies to pre-published content |
Example
{
"smartMatchType": "ICE",
"smartMatchTargetStep": "PUBLISHED",
"prePublished": false
}
CreateSourceGroup
Description
Input for creating a new source group
Example
{
"sourceLanguageId": "Hola",
"name": "Hola",
"description": "Hola",
"tmUids": ["2z68632hdvw2"]
}
CreateStringSearchFilter
Description
Filter defining which TM strings createStringSearch should match and index for later browsing. Every field is optional; omit a field (or leave a date range bound unset) to skip filtering on it. See Search and Filter The Translation Memory for how these filters behave in the UI
Fields
| Input Field | Description |
|---|---|
tmUids - [ID!]!
|
TMs to search. At least one is required |
sourceLocaleIds - [String!]
|
Restrict to strings with one of these source locale IDs |
translationLocaleIds - [String!]
|
Restrict to strings with one of these translation locale IDs |
keyword - SearchKeyword
|
Match this keyword against either source or translation text |
sourceKeyword - SearchKeyword
|
Match this keyword against source text only |
translationKeyword - SearchKeyword
|
Match this keyword against translation text only |
leverageType - LeverageType
|
Restrict to strings with this leverage type |
hashcodes - [String!]
|
Restrict to strings with one of these content hashcodes |
smtHashcodes - [String!]
|
Restrict to strings with one of these SmartMatch hashcodes |
translatorUids - [String!]
|
Restrict to strings translated by one of these user UIDs |
translationDateRangeStart - Date
|
Restrict to strings translated on or after this date |
translationDateRangeEnd - Date
|
Restrict to strings translated on or before this date |
editorUids - [String!]
|
Restrict to strings edited by one of these user UIDs |
editDateRangeStart - Date
|
Restrict to strings edited on or after this date |
editDateRangeEnd - Date
|
Restrict to strings edited on or before this date |
reviewerUids - [String!]
|
Restrict to strings reviewed by one of these user UIDs |
reviewDateRangeStart - Date
|
Restrict to strings reviewed on or after this date |
reviewDateRangeEnd - Date
|
Restrict to strings reviewed on or before this date |
authorizerUids - [String!]
|
Restrict to strings authorized by one of these user UIDs |
authorizationDateRangeStart - Date
|
Restrict to strings authorized on or after this date |
authorizationDateRangeEnd - Date
|
Restrict to strings authorized on or before this date |
ingestedDateRangeStart - Date
|
Restrict to strings ingested on or after this date |
ingestedDateRangeEnd - Date
|
Restrict to strings ingested on or before this date |
variants - [String!]
|
Restrict to strings with one of these plural variant identifiers |
projectUids - [String!]
|
Restrict to strings belonging to one of these project UIDs |
externalStep - Boolean
|
Restrict to strings at an external (non-Smartling) workflow step |
urls - [String!]
|
Restrict to strings originating from one of these source URLs |
fileNames - [String!]
|
Restrict to strings originating from one of these source file names |
keys - [String!]
|
Restrict to strings with one of these string keys |
domains - [String!]
|
Restrict to strings belonging to one of these domains |
tmxFileNames - [String!]
|
Restrict to strings imported from one of these TMX file names |
sources - [SourceType!]
|
Restrict to strings that originated from one of these sources |
translationQualities - [TuTranslationQualityType!]
|
Restrict to strings with one of these translation quality types |
firstTranslatorUids - [String!]
|
Restrict to strings first translated by one of these user UIDs |
lastTranslatedAfter - Date
|
Restrict to strings whose most recent translation is after this date |
lastTranslatedBefore - Date
|
Restrict to strings whose most recent translation is before this date |
firstTranslatedAfter - Date
|
Restrict to strings whose first translation is after this date |
firstTranslatedBefore - Date
|
Restrict to strings whose first translation is before this date |
tags - Tags
|
Restrict by tag membership |
offlineReportUids - [String!]
|
Restrict to strings already referenced by one of these offline reports |
searchOptions - CreateStringSearchOptions
|
Options controlling how the search executes and reports its results |
Example
{
"tmUids": ["2z68632hdvw2"],
"sourceLocaleIds": ["Hola"],
"translationLocaleIds": ["Hola"],
"keyword": SearchKeyword,
"sourceKeyword": SearchKeyword,
"translationKeyword": SearchKeyword,
"leverageType": "PUBLISHED",
"hashcodes": ["Hola"],
"smtHashcodes": ["Hola"],
"translatorUids": ["Hola"],
"translationDateRangeStart": "2026-06-17T00:09:44Z",
"translationDateRangeEnd": "2026-06-17T00:09:44Z",
"editorUids": ["Hola"],
"editDateRangeStart": "2026-06-17T00:09:44Z",
"editDateRangeEnd": "2026-06-17T00:09:44Z",
"reviewerUids": ["Hola"],
"reviewDateRangeStart": "2026-06-17T00:09:44Z",
"reviewDateRangeEnd": "2026-06-17T00:09:44Z",
"authorizerUids": ["Hola"],
"authorizationDateRangeStart": "2026-06-17T00:09:44Z",
"authorizationDateRangeEnd": "2026-06-17T00:09:44Z",
"ingestedDateRangeStart": "2026-06-17T00:09:44Z",
"ingestedDateRangeEnd": "2026-06-17T00:09:44Z",
"variants": ["Hola"],
"projectUids": ["Hola"],
"externalStep": false,
"urls": ["Hola"],
"fileNames": ["Hola"],
"keys": ["Hola"],
"domains": ["Hola"],
"tmxFileNames": ["Hola"],
"sources": ["SMARTLING"],
"translationQualities": ["HUMAN"],
"firstTranslatorUids": ["Hola"],
"lastTranslatedAfter": "2026-06-17T00:09:44Z",
"lastTranslatedBefore": "2026-06-17T00:09:44Z",
"firstTranslatedAfter": "2026-06-17T00:09:44Z",
"firstTranslatedBefore": "2026-06-17T00:09:44Z",
"tags": Tags,
"offlineReportUids": ["Hola"],
"searchOptions": CreateStringSearchOptions
}
CreateStringSearchOptions
Description
Options controlling how createStringSearch executes and reports its results
Fields
| Input Field | Description |
|---|---|
highlightMatches - Boolean
|
Wrap matched keyword text in the result with highlight markers. Default = true |
searchDuplicates - Boolean
|
Detect and report duplicate strings within the result set. Default = false |
translationEqSource - Boolean
|
Only include strings whose translation text is identical to their source text. Default = false |
requestedResultsCount - Int
|
Maximum number of matching strings to return. Must be between 1 and 10,000; values outside this range are rejected. Default = 10000 |
Example
{
"highlightMatches": true,
"searchDuplicates": true,
"translationEqSource": true,
"requestedResultsCount": 987
}
CreateStringSearchResult
Description
Result of creating and indexing a string search
Fields
| Field Name | Description |
|---|---|
searchUid - ID!
|
UID identifying this search for later browsing, reporting, or bulk operations |
stringCount - Int
|
Total number of strings matched |
wordCount - Int
|
Total number of words matched |
duplicateStrings - [DuplicateString]
|
Duplicate strings detected within the match set, when searchDuplicates was requested |
duplicateSearch - Boolean
|
Whether this search's filter is identical to a previously created search |
actionUid - String
|
UID of the async action tracking search indexing, if indexing continues in the background |
offlineReportUid - String
|
UID of the offline report automatically generated for this search, if any |
Example
{
"searchUid": "2z68632hdvw2",
"stringCount": 123,
"wordCount": 123,
"duplicateStrings": [DuplicateString],
"duplicateSearch": true,
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"offlineReportUid": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22"
}
CreateTm
Description
Input for creating a new translation memory
Fields
| Input Field | Description |
|---|---|
name - String!
|
Display name for the TM. Must not be blank |
description - String
|
Optional free-text description |
sourceLocaleId - String!
|
Source locale ID for content stored in this TM |
translationQuality - TranslationQualityType
|
Expected quality of content stored in this TM |
Example
{
"name": "Hola",
"description": "Hola",
"sourceLocaleId": "Hola",
"translationQuality": "TRANSLATION"
}
Date
Description
ISO-8601 date-time string, e.g. 2026-07-17T12:00:00Z
Example
"2026-06-17T00:09:44Z"
DeleteApiStringMetadata
Description
Metadata for a string removed via the delete strings API
Fields
| Field Name | Description |
|---|---|
stringMetadataUid - ID!
|
Unique identifier for this metadata record |
tm - TM!
|
TM the described string belongs to |
tmString - TmString!
|
String this metadata describes |
leverageType - LeverageType!
|
How closely this string's leverage match aligns with the current workflow step |
translationQuality - TuTranslationQualityType
|
Who or what produced this string's translation |
variant - String
|
Plural variant identifier, if this string is part of a plural set |
created - Date!
|
When this metadata record was created |
metadataType - SourceType!
|
Where this string originated |
sourceTmUid - String!
|
TM the string was deleted from |
Example
{
"stringMetadataUid": "2z68632hdvw2",
"tm": TM,
"tmString": TmString,
"leverageType": "PUBLISHED",
"translationQuality": "HUMAN",
"variant": "Hola",
"created": "2026-06-17T00:09:44Z",
"metadataType": "SMARTLING",
"sourceTmUid": "2z68632hdvw2"
}
DuplicateString
Description
A duplicate string detected within a search's match set
Fields
| Field Name | Description |
|---|---|
duplicateKey - String!
|
Key shared by every occurrence of this duplicate |
count - Int!
|
Number of occurrences found |
srcText - String!
|
Source text of the duplicated string |
srcLocale - String!
|
Source locale of the duplicated string |
translationLocale - String!
|
Translation locale of the duplicated string |
Example
{
"duplicateKey": "Hola",
"count": 987,
"srcText": "Hola",
"srcLocale": "en-US",
"translationLocale": "ja"
}
EditApiStringMetadata
Description
Metadata for a string modified via the string edit API
Fields
| Field Name | Description |
|---|---|
stringMetadataUid - ID!
|
Unique identifier for this metadata record |
tm - TM!
|
TM the described string belongs to |
tmString - TmString!
|
String this metadata describes |
leverageType - LeverageType!
|
How closely this string's leverage match aligns with the current workflow step |
translationQuality - TuTranslationQualityType
|
Who or what produced this string's translation |
variant - String
|
Plural variant identifier, if this string is part of a plural set |
created - Date!
|
When this metadata record was created |
metadataType - SourceType!
|
Where this string originated |
translator - User
|
User who made the edit |
translationDate - Date
|
When the edit was made |
Example
{
"stringMetadataUid": "2z68632hdvw2",
"tm": TM,
"tmString": TmString,
"leverageType": "PUBLISHED",
"translationQuality": "HUMAN",
"variant": "Hola",
"created": "2026-06-17T00:09:44Z",
"metadataType": "SMARTLING",
"translator": User,
"translationDate": "2026-06-17T00:09:44Z"
}
EditString
Description
Input for editing a TM string's translation text and plural variants
Fields
| Input Field | Description |
|---|---|
tmStringUid - ID!
|
String to edit |
tmUid - ID!
|
TM the string belongs to |
translationNonPluralIcf - String
|
New translation text for the non-plural form |
translationZeroIcf - String
|
New translation text for the "zero" plural form |
translationOneIcf - String
|
New translation text for the "one" plural form |
translationTwoIcf - String
|
New translation text for the "two" plural form |
translationFewIcf - String
|
New translation text for the "few" plural form |
translationManyIcf - String
|
New translation text for the "many" plural form |
translationOtherIcf - String
|
New translation text for the "other" plural form |
propagate - Boolean
|
Apply the same edit to every occurrence of this string across its plural variants |
Example
{
"tmStringUid": "2z68632hdvw2",
"tmUid": "2z68632hdvw2",
"translationNonPluralIcf": "Hola",
"translationZeroIcf": "Hola",
"translationOneIcf": "Hola",
"translationTwoIcf": "Hola",
"translationFewIcf": "Hola",
"translationManyIcf": "Hola",
"translationOtherIcf": "Hola",
"propagate": true
}
Environment
Description
The caller's account or user-scoped environment: its configuration and summary counts
Fields
| Field Name | Description |
|---|---|
environmentUid - ID!
|
Unique identifier for this environment |
environmentType - EnvironmentType!
|
Whether this environment is scoped to the account or to the requesting user |
name - String!
|
Display name |
configuration - Configuration!
|
Feature configuration for this environment |
tmSummary - TmSummary!
|
Summary of the TMs available in this environment |
leverageSummary - LeverageSummary!
|
Summary of the leverages available in this environment |
Example
{
"environmentUid": "2z68632hdvw2",
"environmentType": "ACCOUNT",
"name": "Hola",
"configuration": Configuration,
"tmSummary": TmSummary,
"leverageSummary": LeverageSummary
}
EnvironmentType
Description
Scope of an Environment: the whole account or a single user within it
Values
| Enum Value | Description |
|---|---|
|
|
Settings shared by every user in the account |
|
|
Settings scoped to the requesting user only |
Example
"ACCOUNT"
ExtendedExportMetadataType
Description
Which end of a string's translation history an extended export should report metadata for
Values
| Enum Value | Description |
|---|---|
|
|
Metadata from the first time the string was translated |
|
|
Metadata from the most recent time the string was translated |
Example
"FIRST_TRANSLATED_STRINGS"
HighlightSearchFilter
Description
Filter for highlighting keyword matches within an explicit list of strings, without modifying them
Fields
| Input Field | Description |
|---|---|
strings - [HighlightString]!
|
Strings to search within |
searchPhrase - String!
|
Phrase to search for |
matchCase - Boolean!
|
Match letter case exactly |
wholeWord - Boolean!
|
Require the phrase to match on whole-word boundaries |
boundaryChars - String!
|
Characters treated as word boundaries when wholeWord is true |
Example
{
"strings": [HighlightString],
"searchPhrase": "Hola",
"matchCase": false,
"wholeWord": true,
"boundaryChars": "Hola"
}
HighlightString
HighlightedString
HistoricalTm
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID
Example
"2z68632hdvw2"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1
Example
123
KeywordSearchType
Description
How a keyword search term should be matched against string content
Values
| Enum Value | Description |
|---|---|
|
|
Substring match |
|
|
Match against the full text exactly, including punctuation and markup |
|
|
Match using a regular expression pattern |
Example
"BASIC"
Leverage
Description
A leverage configuration: an ordered set of TM and source group shares used to find translation matches for a source language. It controls which completed translations are available for reuse in a project and how they are applied
Fields
| Field Name | Description |
|---|---|
leverageUid - ID!
|
Unique identifier for this leverage |
sourceLanguageId - String!
|
Source language this leverage applies to |
name - String!
|
Display name |
description - String
|
Free-text description |
leverageShares - [LeverageShare]!
|
Shares configured on this leverage, in match priority order |
creator - User!
|
User who created this leverage |
created - Date!
|
When this leverage was created |
lastModifier - User!
|
User who last modified this leverage |
lastModified - Date!
|
When this leverage was last modified |
leverageSnapshotUid - String
|
Identifier of the leverage snapshot this configuration was captured from, if any |
Example
{
"leverageUid": "2z68632hdvw2",
"sourceLanguageId": "en",
"name": "Hola",
"description": "Hola",
"leverageShares": [LeverageShare],
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"leverageSnapshotUid": "Hola"
}
LeverageFilter
Description
Pagination and filter for listing leverage configurations
Fields
| Input Field | Description |
|---|---|
sourceLanguageId - String
|
Restrict to leverage configurations with this source language ID |
nameFilter - String
|
Restrict to leverage configurations whose name contains this substring |
tmUid - ID
|
Restrict to leverage configurations that include this TM |
first - Int
|
Maximum number of leverage configurations to return. Default = 50 |
offset - Int
|
Number of leverage configurations to skip before returning results. Default = 0 |
Example
{
"sourceLanguageId": "Hola",
"nameFilter": "Hola",
"tmUid": "2z68632hdvw2",
"first": 987,
"offset": 987
}
LeverageHistory
Description
Configuration change history for a leverage
Fields
| Field Name | Description |
|---|---|
leverageUid - ID!
|
Leverage this history belongs to |
historyRecords - [LeverageHistoryRecord!]!
|
Change records, most recent first |
Example
{
"leverageUid": "2z68632hdvw2",
"historyRecords": [LeverageHistoryRecord]
}
LeverageHistoryFieldChange
Description
A single field-level change captured within a leverage history record
Fields
| Field Name | Description |
|---|---|
fieldName - String!
|
Name of the changed field, e.g. locale, cross_locale, penalty, priority, or one of the sm_* SmartMatch rule flags |
fieldValue - String!
|
New value of the field, formatted for display |
previousFieldValue - String
|
Previous value of the field, formatted for display |
Example
{
"fieldName": "Hola",
"fieldValue": "Hola",
"previousFieldValue": "Hola"
}
LeverageHistoryFilter
Description
Identifies the leverage to retrieve configuration change history for
Fields
| Input Field | Description |
|---|---|
leverageUid - ID!
|
Leverage to retrieve history for |
Example
{"leverageUid": "2z68632hdvw2"}
LeverageHistoryRecord
Description
A single configuration change made to a leverage
Fields
| Field Name | Description |
|---|---|
actor - User!
|
User who made the change |
timestamp - Date!
|
When the change was made |
type - LeverageHistoryRecordType!
|
Kind of change |
fieldChanges - [LeverageHistoryFieldChange!]
|
Individual field-level changes made in this record |
tms - [HistoricalTm]!
|
TMs affected by this change |
groupUid - String
|
Source group affected by this change, if the change was made at the group level |
groupName - String
|
Display name of the affected source group, if the change was made at the group level |
Example
{
"actor": User,
"timestamp": "2026-06-17T00:09:44Z",
"type": "CREATE",
"fieldChanges": [LeverageHistoryFieldChange],
"tms": [HistoricalTm],
"groupUid": "Hola",
"groupName": "Hola"
}
LeverageHistoryRecordType
Description
Kind of change recorded in a LeverageHistoryRecord
Values
| Enum Value | Description |
|---|---|
|
|
A leverage share was added |
|
|
A leverage share's configuration was changed |
|
|
A leverage share was removed |
Example
"CREATE"
LeverageLocale
Description
SmartMatch configuration detail for a single locale within a leverage
Example
{"localeId": "ja", "hasAtLeastOneIceMatchOnlySmartmatchConfiguration": true}
LeverageSearchResult
Description
Result of listing leverage configurations, together with a total count
Fields
| Field Name | Description |
|---|---|
leverages - [Leverage!]!
|
Page of matching leverages |
totalCount - Int!
|
Total number of matching leverages |
Example
{"leverages": [Leverage], "totalCount": 987}
LeverageSummary
Description
Summary of the leverages available in an environment
Fields
| Field Name | Description |
|---|---|
total - Int!
|
Total number of leverages in the environment |
leverages - [Leverage]
|
Page of leverages matching an optional name or UID filter |
Example
{"total": 123, "leverages": [Leverage]}
LeverageType
Description
How a leverage match relates to the current translation workflow step
Values
| Enum Value | Description |
|---|---|
|
|
The matched string has been published |
|
|
The matched string was published in an earlier revision, before the one currently in progress |
|
|
The matched string has been translated but not yet published |
Example
"PUBLISHED"
Locale
Description
A source or translation locale available in the account
Example
{
"localeId": "en-US",
"localeDescription": "Hola",
"rtlLanguage": true,
"wordSpacing": false
}
LocaleSummary
Description
String and word count for a single translation locale
Example
{
"translationLocaleId": "de-DE",
"translationLocale": Locale,
"stringCount": 123,
"wordCount": 123
}
MoveApiStringMetadata
Description
Metadata for a string relocated via the move strings API
Fields
| Field Name | Description |
|---|---|
stringMetadataUid - ID!
|
Unique identifier for this metadata record |
tm - TM!
|
TM the described string belongs to |
tmString - TmString!
|
String this metadata describes |
leverageType - LeverageType!
|
How closely this string's leverage match aligns with the current workflow step |
translationQuality - TuTranslationQualityType
|
Who or what produced this string's translation |
variant - String
|
Plural variant identifier, if this string is part of a plural set |
created - Date!
|
When this metadata record was created |
metadataType - SourceType!
|
Where this string originated |
sourceTmUid - String!
|
TM the string was moved from |
Example
{
"stringMetadataUid": "2z68632hdvw2",
"tm": TM,
"tmString": TmString,
"leverageType": "PUBLISHED",
"translationQuality": "HUMAN",
"variant": "Hola",
"created": "2026-06-17T00:09:44Z",
"metadataType": "SMARTLING",
"sourceTmUid": "2z68632hdvw2"
}
Project
ProjectStringSubKey
QCSSearchBulkResult
Description
Result of a single phrase within a bulk QCS search
Fields
| Field Name | Description |
|---|---|
phraseUid - String!
|
Identifier of the phrase this result belongs to, matching the phraseUid supplied in the request |
strings - [QCSSearchResultString]!
|
Matches found for this phrase |
Example
{
"phraseUid": "Hola",
"strings": [QCSSearchResultString]
}
QCSSearchResult
QCSSearchResultString
Description
A single string match within a bulk QCS search result
Example
{
"sourceText": "Hola",
"translationText": "Hola",
"published": true
}
QcsSearchFilter
Description
Filter for a multi-phrase QCS search within one leverage and locale
Fields
| Input Field | Description |
|---|---|
leverageUid - ID!
|
Leverage to search within |
translationLocaleId - String!
|
Target locale ID to search within |
phrases - [SearchPhrase]!
|
Phrases to search for, each returned as a separate result via bulkQcsSearch |
searchOptions - QcsSearchOptions
|
Options controlling how the search matches and reports results |
Example
{
"leverageUid": "2z68632hdvw2",
"translationLocaleId": "Hola",
"phrases": [SearchPhrase],
"searchOptions": QcsSearchOptions
}
QcsSearchOptions
Description
Options controlling how a QCS (quick concordance search) matches and reports results
Example
{"searchTarget": true, "publishedOnly": false, "caseSensitive": true}
SearchAndReplaceAsyncActionResult
Description
Progress and outcome of an asynchronous search-and-replace action
Fields
| Field Name | Description |
|---|---|
actionUid - ID!
|
Unique identifier for this action, used to poll its status |
totalCount - Int!
|
Total number of strings the action expects to process |
processedCount - Int!
|
Number of strings processed so far |
errorCount - Int!
|
Number of strings that failed to process |
executionComplete - Boolean!
|
Whether the action has fully completed |
editedStringCount - Int!
|
Number of strings edited by the replacement |
replacedPhraseCount - Int!
|
Total number of phrase occurrences replaced |
propagatedStringCount - Int!
|
Number of strings whose edit was propagated to other plural variants |
Example
{
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 987,
"processedCount": 123,
"errorCount": 123,
"executionComplete": false,
"editedStringCount": 987,
"replacedPhraseCount": 123,
"propagatedStringCount": 123
}
SearchAndReplaceCountAsyncActionResult
Description
Progress and outcome of an asynchronous search-and-replace count action
Fields
| Field Name | Description |
|---|---|
actionUid - ID!
|
Unique identifier for this action, used to poll its status |
totalCount - Int!
|
Total number of strings the action expects to process |
processedCount - Int!
|
Number of strings processed so far |
errorCount - Int!
|
Number of strings that failed to process |
executionComplete - Boolean!
|
Whether the action has fully completed |
stringCount - Int!
|
Number of strings containing at least one match |
phraseCount - Int!
|
Total number of matched phrase occurrences |
Example
{
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 123,
"processedCount": 987,
"errorCount": 123,
"executionComplete": true,
"stringCount": 987,
"phraseCount": 123
}
SearchAndReplaceCountFilter
Description
Filter for counting how many matches a search-and-replace would affect, scoped to an explicit list of strings
Fields
| Input Field | Description |
|---|---|
tmStringKeys - [TmStringKey]!
|
Strings to check |
searchPhrase - String!
|
Phrase to search for. Must not be blank |
matchCase - Boolean!
|
Match letter case exactly |
wholeWord - Boolean!
|
Require the phrase to match on whole-word boundaries |
Example
{
"tmStringKeys": [TmStringKey],
"searchPhrase": "Hola",
"matchCase": true,
"wholeWord": true
}
SearchAndReplaceCountResult
SearchAndReplaceFilter
Description
Filter for a search-and-replace scoped to an explicit list of strings
Fields
| Input Field | Description |
|---|---|
tmStringKeys - [TmStringKey]!
|
Strings to search and replace within |
searchPhrase - String!
|
Phrase to search for. Must not be blank |
replacePhrase - String!
|
Replacement text. Must not be blank; a blank value would delete every matched fragment instead of replacing it |
matchCase - Boolean!
|
Match letter case exactly |
wholeWord - Boolean!
|
Require the phrase to match on whole-word boundaries |
propagate - Boolean!
|
Apply the same replacement to every plural variant of a matched string |
Example
{
"tmStringKeys": [TmStringKey],
"searchPhrase": "Hola",
"replacePhrase": "Hola",
"matchCase": true,
"wholeWord": false,
"propagate": true
}
SearchAndReplaceResult
Description
Result of a synchronous search-and-replace
Fields
| Field Name | Description |
|---|---|
actionUid - ID
|
UID of the async action continuing this operation in the background, if it did not finish synchronously |
isAsync - Boolean
|
Whether the operation continued asynchronously instead of finishing synchronously |
editedStringCount - Int!
|
Number of strings edited by the replacement |
replacedPhraseCount - Int!
|
Total number of phrase occurrences replaced |
propagatedStringCount - Int!
|
Number of strings whose edit was propagated to other plural variants |
Example
{
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"isAsync": true,
"editedStringCount": 987,
"replacedPhraseCount": 123,
"propagatedStringCount": 123
}
SearchFieldByLeverageFilter
Description
Filter for autocompleting the translator field's known values within a single leverage
Fields
| Input Field | Description |
|---|---|
leverageUid - ID!
|
Leverage to search within |
translationLocaleId - String!
|
Target locale ID to restrict the search to |
prefixFilter - String!
|
Prefix the returned values must start with |
first - Int
|
Maximum number of values to return. Default = 50 |
offset - Int
|
Number of values to skip before returning results. Default = 0 |
Example
{
"leverageUid": "2z68632hdvw2",
"translationLocaleId": "Hola",
"prefixFilter": "Hola",
"first": 987,
"offset": 987
}
SearchFieldFilter
Description
Filter for autocompleting a text field's known values across one or more TMs
Example
{
"tmUids": ["2z68632hdvw2"],
"prefixFilter": "Hola",
"first": 123,
"offset": 123
}
SearchHighlightingResult
Description
Result of highlighting keyword matches within an explicit list of strings
Fields
| Field Name | Description |
|---|---|
highlightedStrings - [HighlightedString]!
|
Strings with matches wrapped in highlight markers |
highlightedStringCount - Int!
|
Number of strings containing at least one match |
highlightedPhraseCount - Int!
|
Total number of matched phrase occurrences |
boundaryChars - String!
|
Characters that were treated as word boundaries |
Example
{
"highlightedStrings": [HighlightedString],
"highlightedStringCount": 987,
"highlightedPhraseCount": 987,
"boundaryChars": "Hola"
}
SearchKeyword
Description
A single keyword to match against string text
Fields
| Input Field | Description |
|---|---|
searchText - String!
|
The text or pattern to search for |
caseSensitive - Boolean
|
Match letter case exactly. Default = false |
entireStringMatch - Boolean
|
Require the keyword to match the entire string, not just a substring. Default = false |
searchType - KeywordSearchType
|
How to interpret searchText: substring, exact match, or regular expression. Default = BASIC |
Example
{
"searchText": "Hola",
"caseSensitive": false,
"entireStringMatch": false,
"searchType": "BASIC"
}
SearchPhrase
Description
A single phrase to look up in a bulk QCS search, paired with a caller-supplied identifier for correlating results
Fields
| Input Field | Description |
|---|---|
phrase - String!
|
The phrase text to search for |
phraseUid - String!
|
Caller-supplied identifier used to match this phrase to its result in bulkQcsSearch |
Example
{
"phrase": "Hola",
"phraseUid": "Hola"
}
SearchTmFilter
Description
Pagination and sort filter for listing translation memories
Fields
| Input Field | Description |
|---|---|
first - Int
|
Maximum number of TMs to return. Default = 50 |
offset - Int
|
Number of TMs to skip before returning results. Default = 0 |
sortBy - TmSorting
|
Sort order for the returned TMs. Default = BY_NAME_ASC |
sourceLocaleId - String
|
Restrict to TMs with this source locale ID |
nameFilter - String
|
Restrict to TMs whose name contains this substring |
sourceLanguageId - String
|
Restrict to TMs with this source language ID |
translationQuality - TranslationQualityType
|
Restrict to TMs with this translation quality type |
Example
{
"first": 123,
"offset": 123,
"sortBy": "BY_NAME_ASC",
"sourceLocaleId": "Hola",
"nameFilter": "Hola",
"sourceLanguageId": "Hola",
"translationQuality": "TRANSLATION"
}
SmartMatchEnabledFilter
SmartMatchEnabledResult
Description
Whether SmartMatch is enabled for a given leverage and locale
Fields
| Field Name | Description |
|---|---|
enabled - Boolean!
|
True if SmartMatch is enabled |
Example
{"enabled": false}
SmartMatchLeverage
Description
SmartMatch leverage configuration for a TM and locale
Fields
| Field Name | Description |
|---|---|
leverageUid - ID!
|
Leverage this configuration belongs to |
localeIds - [String]!
|
Locale IDs covered by this configuration |
locales - [LeverageLocale]!
|
Per-locale SmartMatch details |
Example
{
"leverageUid": "2z68632hdvw2",
"localeIds": ["de-DE"],
"locales": [LeverageLocale]
}
SmartMatchLeverageFilter
SmartMatchRule
Description
A single SmartMatch rule configured on a leverage share
Fields
| Field Name | Description |
|---|---|
smartMatchType - SmartMatchType!
|
Precision of match this rule allows |
smartMatchTargetStep - SmartMatchTargetStep!
|
Workflow step this rule applies to |
prePublished - Boolean!
|
Whether this rule applies to pre-published content |
Example
{
"smartMatchType": "ICE",
"smartMatchTargetStep": "PUBLISHED",
"prePublished": true
}
SmartMatchTargetStep
Description
Workflow step a SmartMatch rule targets when deciding whether a leverage match should surface. See Smartling's SmartMatch for how each result behaves
Values
| Enum Value | Description |
|---|---|
|
|
SmartMatched strings bypass all workflow steps and are immediately published |
|
|
SmartMatched strings move to the first Review-type step, bypassing all previous steps |
|
|
SmartMatched strings move to the first Edit-type step |
|
|
SmartMatched strings move to the first post-translation step of any type (Edit, Post-Edit, Review, AI Review, Hold, Internal Review, Quality Evaluation, LQA, or Desktop Publishing) |
|
|
SmartMatched strings move to the first Hold step in the workflow |
|
|
SmartMatched strings move to the step directly preceding the Published step |
|
|
SmartMatched strings move to the first Internal Review-type step |
Example
"PUBLISHED"
SmartMatchType
Description
Match precision required between a leverage candidate's source text and the string being translated. See SmartMatch Rules for how each precision level behaves for translators
Values
| Enum Value | Description |
|---|---|
|
|
Only in-context exact (ICE) matches |
|
|
Exact text matches regardless of context |
|
|
Matches that ignore whitespace differences |
|
|
Matches that ignore markup differences |
|
|
Matches that ignore letter case |
|
|
Matches that ignore both text markup and letter case |
|
|
Any match regardless of precision |
|
|
Matches against strings that have not yet been published |
Example
"ICE"
SmartlingStringMetadata
Description
Metadata for a string ingested from a Smartling translation job
Fields
| Field Name | Description |
|---|---|
stringMetadataUid - ID!
|
Unique identifier for this metadata record |
tm - TM!
|
TM the described string belongs to |
tmString - TmString!
|
String this metadata describes |
leverageType - LeverageType!
|
How closely this string's leverage match aligns with the current workflow step |
translationQuality - TuTranslationQualityType
|
Who or what produced this string's translation |
variant - String
|
Plural variant identifier, if this string is part of a plural set |
created - Date!
|
When this metadata record was created |
metadataType - SourceType!
|
Where this string originated |
hashcode - String!
|
Content hashcode used to match this string against leverage candidates |
translator - User
|
User who translated this string |
translationDate - Date
|
When this string was translated |
editor - User
|
User who edited this string |
editDate - Date
|
When this string was edited |
reviewer - User
|
User who reviewed this string |
reviewDate - Date
|
When this string was reviewed |
authorizer - User
|
User who authorized this string |
authorizationDate - Date
|
When this string was authorized |
project - Project
|
Project this string was translated within |
externalStep - Boolean
|
Whether this string is at an external (non-Smartling) workflow step |
url - String
|
Source URL this string was extracted from |
fileName - String
|
Source file name this string was extracted from |
key - String
|
String key within its source file |
domain - String
|
Domain this string belongs to |
Example
{
"stringMetadataUid": "2z68632hdvw2",
"tm": TM,
"tmString": TmString,
"leverageType": "PUBLISHED",
"translationQuality": "HUMAN",
"variant": "Hola",
"created": "2026-06-17T00:09:44Z",
"metadataType": "SMARTLING",
"hashcode": "Hola",
"translator": User,
"translationDate": "2026-06-17T00:09:44Z",
"editor": User,
"editDate": "2026-06-17T00:09:44Z",
"reviewer": User,
"reviewDate": "2026-06-17T00:09:44Z",
"authorizer": User,
"authorizationDate": "2026-06-17T00:09:44Z",
"project": Project,
"externalStep": true,
"url": "Hola",
"fileName": "Hola",
"key": "Hola",
"domain": "Hola"
}
SourceGroup
Description
A named group of TMs sharing a common source language, usable as a leverage share
Fields
| Field Name | Description |
|---|---|
sourceGroupUid - ID!
|
Unique identifier for this source group |
sourceLanguageId - String
|
Source language shared by every TM in the group |
name - String!
|
Display name |
description - String
|
Free-text description |
tms - [TM]!
|
TMs included in this group |
creator - User!
|
User who created this source group |
created - Date!
|
When this source group was created |
lastModifier - User!
|
User who last modified this source group |
lastModified - Date!
|
When this source group was last modified |
Example
{
"sourceGroupUid": "2z68632hdvw2",
"sourceLanguageId": "en",
"name": "Hola",
"description": "Hola",
"tms": [TM],
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z"
}
SourceGroupFilter
Description
Pagination and filter for listing source groups
Fields
| Input Field | Description |
|---|---|
nameFilter - String
|
Restrict to source groups whose name contains this substring |
sourceLanguageId - String
|
Restrict to source groups with this source language ID |
first - Int
|
Maximum number of source groups to return. Default = 50 |
offset - Int
|
Number of source groups to skip before returning results. Default = 0 |
Example
{
"nameFilter": "Hola",
"sourceLanguageId": "Hola",
"first": 987,
"offset": 123
}
SourceType
Description
Where a TM string or its metadata originated
Values
| Enum Value | Description |
|---|---|
|
|
Ingested from a Smartling translation job |
|
|
Imported from an uploaded TMX file |
|
|
Removed via the delete strings API |
|
|
Relocated via the move strings API |
|
|
Modified via the string edit API |
Example
"SMARTLING"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text
Example
"Hola"
StringEditAsyncActionResult
Description
Progress and outcome of an asynchronous string edit action
Fields
| Field Name | Description |
|---|---|
actionUid - ID!
|
Unique identifier for this action, used to poll its status |
totalCount - Int!
|
Total number of strings the action expects to process |
processedCount - Int!
|
Number of strings processed so far |
executionComplete - Boolean!
|
Whether the action has fully completed |
editedStringCount - Int!
|
Number of strings edited |
propagatedStringCount - Int!
|
Number of strings whose edit was propagated to other plural variants |
tmUid - String!
|
TM the edited string belongs to |
tmStringUid - String!
|
String that was edited |
resultedTmStringUid - String
|
UID of the resulting string, if the edit produced a new string record |
Example
{
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 123,
"processedCount": 123,
"executionComplete": false,
"editedStringCount": 987,
"propagatedStringCount": 123,
"tmUid": "2z68632hdvw2",
"tmStringUid": "Hola",
"resultedTmStringUid": "Hola"
}
StringHistoryFilter
Description
Filter for retrieving translation history across a set of strings in a single locale
Fields
| Input Field | Description |
|---|---|
localeId - String!
|
Locale to retrieve history for |
projectStringSubKeys - [ProjectStringSubKey!]!
|
Strings to retrieve history for |
Example
{
"localeId": "Hola",
"projectStringSubKeys": [ProjectStringSubKey]
}
StringMetadata
Description
Common fields describing how a TM string was produced or last touched, regardless of its source
Fields
| Field Name | Description |
|---|---|
stringMetadataUid - ID!
|
Unique identifier for this metadata record |
tm - TM!
|
TM the described string belongs to |
tmString - TmString!
|
String this metadata describes |
leverageType - LeverageType!
|
How closely this string's leverage match aligns with the current workflow step |
translationQuality - TuTranslationQualityType
|
Who or what produced this string's translation |
variant - String
|
Plural variant identifier, if this string is part of a plural set |
created - Date!
|
When this metadata record was created |
metadataType - SourceType!
|
Where this string originated |
Possible Types
| StringMetadata Types |
|---|
Example
{
"stringMetadataUid": "2z68632hdvw2",
"tm": TM,
"tmString": TmString,
"leverageType": "PUBLISHED",
"translationQuality": "HUMAN",
"variant": "Hola",
"created": "2026-06-17T00:09:44Z",
"metadataType": "SMARTLING"
}
StringsExportAsyncActionResult
Description
Progress and outcome of an asynchronous string export action
Fields
| Field Name | Description |
|---|---|
actionUid - ID!
|
Unique identifier for this action, used to poll its status |
totalCount - Int!
|
Total number of strings the action expects to process |
processedCount - Int!
|
Number of strings processed so far |
errorCount - Int!
|
Number of strings that failed to process |
executionComplete - Boolean!
|
Whether the action has fully completed |
tmxDownloadKey - String
|
Key for downloading the resulting TMX file, once the action completes |
expired - Boolean!
|
Whether the download key has expired |
actionStatus - AsyncActionStatus!
|
Current lifecycle status of the action |
Example
{
"actionUid": "d23eb702-7358-11ea-bc55-0242ac130003",
"totalCount": 123,
"processedCount": 123,
"errorCount": 987,
"executionComplete": true,
"tmxDownloadKey": "Hola",
"expired": true,
"actionStatus": "QUEUEING"
}
TM
Description
A translation memory: a named container of translated string pairs for one source locale
Fields
| Field Name | Description |
|---|---|
tmUid - ID
|
Unique identifier for this TM |
name - String!
|
Display name |
description - String
|
Free-text description |
sourceLocaleId - ID!
|
Locale ID of the source content stored in this TM |
sourceLocale - Locale!
|
Locale of the source content stored in this TM |
creator - User!
|
User who created this TM |
created - Date!
|
When this TM was created |
lastModifier - User!
|
User who last modified this TM |
lastModified - Date!
|
When this TM was last modified |
localeSummary - [LocaleSummary]
|
String and word counts per translation locale |
translationQuality - TranslationQualityType!
|
Expected quality of content stored in this TM |
managedWordsEnabled - Boolean!
|
Whether managed words are enabled for this TM |
Example
{
"tmUid": "2z68632hdvw2",
"name": "Hola",
"description": "Hola",
"sourceLocaleId": "en-US",
"sourceLocale": Locale,
"creator": User,
"created": "2026-06-17T00:09:44Z",
"lastModifier": User,
"lastModified": "2026-06-17T00:09:44Z",
"localeSummary": [LocaleSummary],
"translationQuality": "TRANSLATION",
"managedWordsEnabled": true
}
TMX
Description
A single TMX file import into a TM
Fields
| Field Name | Description |
|---|---|
tmxFileName - String
|
Name of the imported TMX file |
complete - Boolean!
|
Whether the import has fully completed |
errors - [TmxError]
|
Errors encountered while parsing or importing the file |
requestCount - Int!
|
Total number of translation units in the file |
processedCount - Int!
|
Number of translation units successfully processed |
skippedCount - Int!
|
Number of translation units skipped, e.g. due to validation errors |
tmxUid - String!
|
Unique identifier for this import |
tm - TM
|
TM the file was imported into |
localeSummary - [LocaleSummary]
|
String and word counts per translation locale for this import |
creator - User
|
User who started this import |
created - Date!
|
When this import was started |
Example
{
"tmxFileName": "Hola",
"complete": false,
"errors": [TmxError],
"requestCount": 987,
"processedCount": 987,
"skippedCount": 123,
"tmxUid": "Hola",
"tm": TM,
"localeSummary": [LocaleSummary],
"creator": User,
"created": "2026-06-17T00:09:44Z"
}
Tags
Description
Tag-based filter for narrowing a string search
Fields
| Input Field | Description |
|---|---|
tags - [String!]
|
Tags to filter by. Maximum of 1,000 tags; longer lists are rejected |
matchAllTags - Boolean
|
Require every listed tag to be present, instead of any one of them. Default = false |
noTags - Boolean
|
Match only strings that have no tags at all. Default = false |
Example
{
"tags": ["Hola"],
"matchAllTags": false,
"noTags": false
}
TargetLocaleFilter
Description
Filter for listing the target locales reachable from a source language
Fields
| Input Field | Description |
|---|---|
sourceLanguageId - String!
|
Source language to find configured target locales for |
Example
{"sourceLanguageId": "Hola"}
TmSorting
Description
Sort order for a translation memory listing
Values
| Enum Value | Description |
|---|---|
|
|
Sort by name, A to Z |
|
|
Sort by name, Z to A |
Example
"BY_NAME_ASC"
TmStatsFilter
Description
Filter for retrieving locale-level string and word count statistics
Example
{
"tmUids": ["2z68632hdvw2"],
"statsForTmxStringOnly": false
}
TmString
Description
A single translated string within a TM, together with its source text and metadata
Fields
| Field Name | Description |
|---|---|
tmStringUid - ID!
|
Unique identifier for this string |
tm - TM
|
TM this string belongs to |
stringMetadata - [StringMetadata]
|
Metadata records describing how this string was produced or last modified |
sourceLocaleId - ID!
|
Locale ID of the source text |
translationLocaleId - ID!
|
Locale ID of the translation text |
sourceText - String!
|
Source text |
translationText - String!
|
Translation text |
sourceNonPluralText - String
|
Source text for the non-plural form |
translationNonPluralText - String
|
Translation text for the non-plural form |
sourceZeroText - String
|
Source text for the "zero" plural form |
sourceOneText - String
|
Source text for the "one" plural form |
sourceTwoText - String
|
Source text for the "two" plural form |
sourceFewText - String
|
Source text for the "few" plural form |
sourceManyText - String
|
Source text for the "many" plural form |
sourceOtherText - String
|
Source text for the "other" plural form |
translationZeroText - String
|
Translation text for the "zero" plural form |
translationOneText - String
|
Translation text for the "one" plural form |
translationTwoText - String
|
Translation text for the "two" plural form |
translationFewText - String
|
Translation text for the "few" plural form |
translationManyText - String
|
Translation text for the "many" plural form |
translationOtherText - String
|
Translation text for the "other" plural form |
tmStringIcf - TmStringIcf!
|
Source and translation text in ICF format, across every plural form |
lastModificationDate - Date
|
When this string's translation was last modified |
stringMetadataCount - Int
|
Number of metadata records associated with this string |
leverageType - LeverageType
|
How closely this string's leverage match aligns with the current workflow step, when returned from a leverage search |
wordCount - Int!
|
Word count of the source text |
highlightedSourceText - String
|
Source text with search keyword matches wrapped in highlight markers |
highlightedTranslationText - String
|
Translation text with search keyword matches wrapped in highlight markers |
Example
{
"tmStringUid": "2z68632hdvw2",
"tm": TM,
"stringMetadata": [StringMetadata],
"sourceLocaleId": "en-US",
"translationLocaleId": "ja",
"sourceText": "Hola",
"translationText": "Hola",
"sourceNonPluralText": "Hola",
"translationNonPluralText": "Hola",
"sourceZeroText": "Hola",
"sourceOneText": "Hola",
"sourceTwoText": "Hola",
"sourceFewText": "Hola",
"sourceManyText": "Hola",
"sourceOtherText": "Hola",
"translationZeroText": "Hola",
"translationOneText": "Hola",
"translationTwoText": "Hola",
"translationFewText": "Hola",
"translationManyText": "Hola",
"translationOtherText": "Hola",
"tmStringIcf": TmStringIcf,
"lastModificationDate": "2026-06-17T00:09:44Z",
"stringMetadataCount": 987,
"leverageType": "PUBLISHED",
"wordCount": 123,
"highlightedSourceText": "Hola",
"highlightedTranslationText": "Hola"
}
TmStringIcf
Description
ICU/ICF-formatted source and translation text for a string, including every plural form
Fields
| Field Name | Description |
|---|---|
sourceIcf - String!
|
Source text in ICF format |
translationIcf - String!
|
Translation text in ICF format |
translationNonPluralIcf - String
|
Translation text for the non-plural form, in ICF format |
translationZeroIcf - String
|
Translation text for the "zero" plural form, in ICF format |
translationOneIcf - String
|
Translation text for the "one" plural form, in ICF format |
translationTwoIcf - String
|
Translation text for the "two" plural form, in ICF format |
translationFewIcf - String
|
Translation text for the "few" plural form, in ICF format |
translationManyIcf - String
|
Translation text for the "many" plural form, in ICF format |
translationOtherIcf - String
|
Translation text for the "other" plural form, in ICF format |
Example
{
"sourceIcf": "Hola",
"translationIcf": "Hola",
"translationNonPluralIcf": "Hola",
"translationZeroIcf": "Hola",
"translationOneIcf": "Hola",
"translationTwoIcf": "Hola",
"translationFewIcf": "Hola",
"translationManyIcf": "Hola",
"translationOtherIcf": "Hola"
}
TmStringKey
Description
Identifies a single TM string by its UID and the TM it belongs to
Example
{
"tmStringUid": "2z68632hdvw2",
"tmUid": "2z68632hdvw2"
}
TmSummary
Description
Summary of the TMs available in an environment
Fields
| Field Name | Description |
|---|---|
sourceLocales - [Locale]!
|
Every source locale in use across the environment's TMs |
translationLocales - [Locale]!
|
Every translation locale in use across the environment's TMs |
total - Int!
|
Total number of TMs in the environment |
tms - [TM]
|
Page of TMs matching an optional name or UID filter |
Example
{
"sourceLocales": [Locale],
"translationLocales": [Locale],
"total": 987,
"tms": [TM]
}
TmxError
Description
A single error encountered while parsing or importing a TMX file
Example
{
"messages": ["Hola"],
"line": 987,
"column": 987
}
TmxFilter
Description
Pagination filter for listing TMX imports
Example
{
"tmUid": "2z68632hdvw2",
"first": 987,
"offset": 123
}
TmxImportsSearchResult
TmxStringMetadata
Description
Metadata for a string imported from a TMX file
Fields
| Field Name | Description |
|---|---|
stringMetadataUid - ID!
|
Unique identifier for this metadata record |
tm - TM!
|
TM the described string belongs to |
tmString - TmString!
|
String this metadata describes |
leverageType - LeverageType!
|
How closely this string's leverage match aligns with the current workflow step |
translationQuality - TuTranslationQualityType
|
Who or what produced this string's translation |
variant - String
|
Plural variant identifier, if this string is part of a plural set |
created - Date!
|
When this metadata record was created |
metadataType - SourceType!
|
Where this string originated |
tmxFileName - String!
|
Name of the TMX file this string was imported from |
translator - User
|
User who translated this string |
translationDate - Date
|
When this string was translated |
fileName - String
|
Source file name recorded in the TMX file, if present |
Example
{
"stringMetadataUid": "2z68632hdvw2",
"tm": TM,
"tmString": TmString,
"leverageType": "PUBLISHED",
"translationQuality": "HUMAN",
"variant": "Hola",
"created": "2026-06-17T00:09:44Z",
"metadataType": "SMARTLING",
"tmxFileName": "Hola",
"translator": User,
"translationDate": "2026-06-17T00:09:44Z",
"fileName": "Hola"
}
TranslationHistoryRecord
Description
A single historical translation of a string, as recorded for a specific project, locale, and content hash
Fields
| Field Name | Description |
|---|---|
hashcode - String!
|
Content hashcode of the translated string |
projectUid - String!
|
Project the string was translated within |
targetLocaleId - String!
|
Locale the string was translated into |
translator - User!
|
User who made this translation |
translationDate - Date!
|
When this translation was made |
sourceText - String!
|
Source text at the time of this translation |
translationText - String!
|
Translation text recorded by this history entry |
Example
{
"hashcode": "Hola",
"projectUid": "Hola",
"targetLocaleId": "de-DE",
"translator": User,
"translationDate": "2026-06-17T00:09:44Z",
"sourceText": "Hola",
"translationText": "Hola"
}
TranslationLocales
Description
Result of listing every locale available in the account, together with a total count
Example
{"translationLocales": [Locale], "totalCount": 123}
TranslationMemories
TranslationQualityType
Description
How a translation memory's content is expected to be produced
Values
| Enum Value | Description |
|---|---|
|
|
Produced by professional human translation |
|
|
Produced by creative human transcreation |
|
|
Produced by machine translation |
Example
"TRANSLATION"
TuTranslationQualityDictionaryEntry
Description
One entry in the lookup table of human-readable labels for TuTranslationQualityType values
Fields
| Field Name | Description |
|---|---|
value - TuTranslationQualityType!
|
The enum value this entry labels |
label - String!
|
Human-readable label for display in a UI |
Example
{"value": "HUMAN", "label": "Hola"}
TuTranslationQualityType
Description
Who or what produced a translation, as recorded on translation history records
Values
| Enum Value | Description |
|---|---|
|
|
Produced by a human translator |
|
|
Produced by creative human transcreation |
|
|
Produced by Smartling AI Translate |
|
|
Produced by machine translation |
Example
"HUMAN"
UpdateLeverage
Description
Input for renaming or re-describing an existing leverage configuration
Example
{
"leverageUid": "2z68632hdvw2",
"name": "Hola",
"description": "Hola"
}
UpdateSourceGroup
Description
Input for renaming, re-describing, or changing the TM membership of a source group
Example
{
"sourceGroupUid": "2z68632hdvw2",
"name": "Hola",
"description": "Hola",
"tmUids": ["2z68632hdvw2"]
}
UpdateTm
Description
Input for renaming or re-describing an existing translation memory
Example
{
"tmUid": "2z68632hdvw2",
"name": "Hola",
"description": "Hola"
}