Lilt REST API API Reference
The Lilt REST API enables programmatic access to the full-range of Lilt backend services including:
- Training of and translating with interactive, adaptive machine translation
- Large-scale translation memory
- The Lexicon (a large-scale termbase)
- Programmatic control of the Lilt CAT environment
- Translation memory synchronization
Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests.
Authentication
Requests are authenticated via REST API key, which requires the Business plan.
Requests are authenticated using
HTTP Basic Auth. Add your REST API key as both the username and password.
For development, you may also pass the REST API key via the key query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use.
Quotas
Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request.
API Endpoint
https://lilt.com/2Contact: support@lilt.com
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v2.0
Authentication
BasicAuth
ApiKeyAuth
Workflows
These endpoints are only relevant if Lilt Workflows are enabled for your organization. Any other Workflow related topics you notice within these docs will also only be relevant for a Workflows enabled organization.
Retrieve workflow templates
Get all the possible Workflow Templates owned by the team. Useful for retrieving the ids corresponding to each workflow tables, and passing them to subsequent requests, for example, creating a new Job with a specific Workflow.
Example CURL:
curl --X --request GET 'https://lilt.com/2/workflows/templates?key=API_KEY'
An array with a team's available WorkflowTemplates.
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": 15,
"name": "Translate > Review > Customer Review",
"TeamId": 100,
"stages": [
{
"name": "Translate",
"assignmentType": "TRANSLATE"
}
]
}
]
Retrieve document Workflow metadata
Get Workflow metadata related to a document. This is useful for gathering information about the current Workflow stage of a document.
Example CURL:
curl --X --request GET 'https://lilt.com/2/workflows/document/{documentId}?key=API_KEY'
A document id.
An object with document Workflow metadata.
Response Content-Types: application/json
Response Example (200 OK)
{
"documentId": 12345,
"workflowId": 1111,
"stages": [
{
"id": 1,
"name": "Translate",
"active": true,
"assignmentType": "TRANSLATE"
}
],
"currentTask": {
"id": 1,
"workflowStageId": 123,
"name": "Review",
"enteredAt": "2022-09-09T21:33:21.000Z",
"startedAt": "2022-09-09T21:33:21.000Z"
}
}
Set Workflow stage for a document
Set the Workflow stage for a document. You can find the stage information required for this request from the "Retrieve document Workflow metadata" endpoint.
Example CURL:
curl --X --request PUT 'https://lilt.com/2/workflows/document/{documentId}/stage?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"workflowStageId": {workflowStageId}
}'
- workflowStageId: string
-
A workflow stage id. Can be found in "Retrieve document Workflow metadata" endpoint. To set the document stage to 'Done', pass through an empty request body.
A document id.
Request Example
{
"workflowStageId": 1234
}
An object with a documents next task Workflow metadata.
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "SUCCESS",
"newTaskId": 123,
"newStageName": "Review"
}
Advance workflow to the next stage
Advance a workflow to the next stage and mark current workflow task as complete.
Example CURL:
curl --X --request POST 'https://lilt.com/2/workflows/document/{documentId}/task/{taskId}/advance?key=API_KEY'
A document id.
The task id of the current workflow stage.
An object with a documents next task Workflow metadata.
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "SUCCESS",
"newTaskId": 123,
"newStageName": "Review"
}
Move workflow to the previous stage
Move a workflow to the previous stage and mark current workflow task as rejected.
Example CURL:
curl --X --request POST 'https://lilt.com/2/workflows/document/{documentId}/task/{taskId}/reject?key=API_KEY'
A document id.
The task id of the current workflow stage.
An object with a documents next task Workflow metadata.
Response Content-Types: application/json
Response Example (200 OK)
{
"status": "SUCCESS",
"newTaskId": 123,
"newStageName": "Review"
}
Root
Retrieve the REST API root
This resource does not have any attributes. It lists the name of the REST API.
This endpoint can be used to verify REST API keys and to check the availability of the REST API.
A status object.
Unexpected error
Response Example (200 OK)
{
"api_name": "Lilt REST API v2",
"api_root": "/2"
}
Response Example (default )
{
"message": "Internal server error."
}
Files
Retrieve a File
Retrieves one or more files available to your user. Files are not associated with a project or a memory. They are unprocessed and can be used later in the project/document creation workflow step.
To retrieve a specific file, specify the id request parameter. To retrieve all files, omit the id request parameter.
Example CURL command:
curl -X GET https://lilt.com/2/files?key=API_KEY&id=274
A unique File identifier.
One or more labels. This will return the files which contain all of the given labels.
Array values passed separated by comma: ?labels=aaa,bbb
A list of files.
User does not have permission for provided file.
File deleted.
Unexpected error.
Response Content-Types: application/json
Response Example (200 OK)
[
{
"id": 46530,
"name": "en_US.json",
"file_hash": "3858f62230ac3c915f300c664312c63f",
"detected_lang": "de",
"detected_lang_confidence": 0.7,
"category": "REFERENCE",
"labels": [],
"created_at": "2019-10-16T22:12:34.000Z",
"updated_at": "2019-10-16T22:12:34.000Z"
}
]
Response Example (default )
{
"message": "Internal server error."
}
Upload a File
Upload a File in any of the formats documented in our knowledge base. Request parameters should be passed in as query string parameters.
Example CURL command:
curl -X POST https://lilt.com/2/files?key=API_KEY&name=en_US.json \
--header "Content-Type: application/octet-stream" \
--data-binary @en_US.json
Calls to GET /files are used to monitor the language detection results. The API response will be augmented to include detected language and confidence score.
The language detection will complete asynchronously. Prior to completion, the detected_lang value will be zxx, the reserved ISO 639-2 code for "No linguistic content/not applicable".
If the language can not be determined, or the detection process fails, the detected_lang field will return und, the reserved ISO 639-2 code for undetermined language, and the detected_lang_confidence score will be 0.
The file contents to be uploaded. The entire POST body will be treated as the file.
A file name.
A hash value to associate with the file. The MD5 hash of the body contents will be used by default if a value isn't provided.
Flag indicating whether to perform language detection on the uploaded file. Default is false.
The project to associate the uploaded file with.
The category of the file. The options are REFERENCE, or API. The default is API. Files with the REFERENCE category will be displayed as reference material.
Comma-separated list of labels to add to the uploaded document.
Request Content-Types: application/octet-stream
Request Example
"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<xliff xmlns=\"urn:oasis:names:tc:xliff:document:1.2\">\n...\n</xliff>"
A SourceFile object.
Unexpected error
Response Example (201 Created)
{
"id": 46530,
"name": "en_US.json",
"file_hash": "3858f62230ac3c915f300c664312c63f",
"detected_lang": "de",
"detected_lang_confidence": 0.7,
"category": "REFERENCE",
"labels": [],
"created_at": "2019-10-16T22:12:34.000Z",
"updated_at": "2019-10-16T22:12:34.000Z"
}
Response Example (default )
{
"message": "Internal server error."
}
Delete a File
Delete a File.
Example CURL command:
curl -X DELETE https://lilt.com/2/files?key=API_KEY&id=123 ```
A unique File identifier.
A status object.
Unexpected error
Response Example (204 No Content)
{
"id": 12345,
"deleted": true
}
Response Example (default )
{
"message": "Internal server error."
}
Download file
Download a File.
Example CURL:
curl --X --request GET 'https://lilt.com/2/files/download?key=API_KEY&id=1'
A File id.
A file.
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Add Label to File
Add a label to a File.
Example CURL:
curl --X --request POST 'https://lilt.com/2/files/labels?key=API_KEY&id=1'
--header 'Content-Type: application/json' \
--data-raw '{
"name": "label_name"
}'
A label name.
- name: string
-
The Label name.
A File id.
Request Example
{
"name": "label_name"
}
A success response.
Remove Label from File
Remove a label from a File.
Example CURL:
curl --X --request DELETE 'https://lilt.com/2/files/labels?key=API_KEY&id=1&name=label_name'
A File id.
A label name.
A success response.
Comments
Retrieve a document's comments by segment
Retrieves all comments associated with a specified document, grouped by their Segment's ID.
To retrieve a document's comments, specify the document_id request parameter.
Example CURL command:
curl -X GET https://lilt.com/2/comments?key=API_KEY&document_id=123
A unique document identifier.
An object containing lists of comments identified by the id of the segment to which they belong.
User does not have permission for provided document.
Comment deleted.
Unexpected error.
Response Example (200 OK)
{
"1234567": [
{
"id": 84480010,
"text": "This is incorrect.",
"annotations": [
{
"text": "mistranslation"
}
],
"is_resolved": true,
"document_id": 5678,
"segment_id": 5678,
"segment_revision_id": 5678,
"user_id": 5678,
"created_at": 1489147692
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Create a new comment
Create a new comment for the specified Segment ID.
The comment being created
A unique document identifier.
A unique segment identifier.
Request Content-Types: application/json
Request Example
{
"text": "Please update this segment",
"annotations": [
{
"text": "mistranslation"
}
],
"isResolved": false
}
Response Example (201 Created)
{
"id": 84480010,
"text": "This is incorrect.",
"annotations": [
{
"text": "mistranslation"
}
],
"is_resolved": true,
"document_id": 5678,
"segment_id": 5678,
"segment_revision_id": 5678,
"user_id": 5678,
"created_at": 1489147692
}
Response Example (default )
{
"message": "Internal server error."
}
Update an existing comment
Update an existing comment.
The comment being updated.
A unique comment identifier.
A unique document identifier.
Request Content-Types: application/json
Request Example
{
"text": "Please update this segment",
"annotations": [
{
"text": "mistranslation"
}
],
"isResolved": false
}
Response Example (201 Created)
{
"id": 84480010,
"text": "This is incorrect.",
"annotations": [
{
"text": "mistranslation"
}
],
"is_resolved": true,
"document_id": 5678,
"segment_id": 5678,
"segment_revision_id": 5678,
"user_id": 5678,
"created_at": 1489147692
}
Response Example (default )
{
"message": "Internal server error."
}
Delete a Comment
Delete a Comment.
Example CURL command:
curl -X DELETE https://lilt.com/2/comments?key=API_KEY&comment_id=123
A unique Comment identifier.
A status object.
Unexpected error
Response Example (204 No Content)
{
"id": 12345
}
Response Example (default )
{
"message": "Internal server error."
}
Connectors
Retrieve a Connector
Retrieves one or more connectors available to your user. Connectors are not associated with a project or a memory.
To retrieve a specific connector, specify the id request parameter. To retrieve all connectors, omit the id request parameter.
Example CURL command:
curl -X GET https://lilt.com/2/connectors?key=API_KEY&id=274
A unique Connector identifier.
A list of Connectors.
User does not have permission for provided connector.
Connector deleted.
Unexpected error.
Response Example (200 OK)
[
{
"id": "integer",
"name": "string",
"schedule": "string",
"last_check": "string",
"healthy": "boolean",
"args": "object",
"created_at": "string",
"updated_at": "string"
}
]
Response Example (default )
{
"message": "Internal server error."
}
Upload a Connector
Create a new connector linked to a supported external cms.
Connector arguments.
- name: string
-
Name of connector.
- args: object
-
Connector parameters.
- schedule: string
-
Cron string
Request Content-Types: application/json
Request Example
{
"name": "string",
"args": "object",
"schedule": "0 0 * * *"
}
Response Example (201 Created)
{
"id": "integer",
"name": "string",
"schedule": "string",
"last_check": "string",
"healthy": "boolean",
"args": "object",
"created_at": "string",
"updated_at": "string"
}
Response Example (default )
{
"message": "Internal server error."
}
Upload a Connector
Create a new connector linked to a supported external content source.
Connector arguments.
- id: integer
-
A unique Connector identifier.
- name: string
-
Name of connector.
- args: object
-
Connector parameters.
- schedule: string
-
Cron string
Request Content-Types: application/json
Request Example
{
"id": 46530,
"name": "zendesk",
"args": "object",
"schedule": "0 0 * * *"
}
Response Example (201 Created)
{
"id": "integer",
"name": "string",
"schedule": "string",
"last_check": "string",
"healthy": "boolean",
"args": "object",
"created_at": "string",
"updated_at": "string"
}
Response Example (default )
{
"message": "Internal server error."
}
Delete a Connector
Delete a Connector.
Example CURL command:
curl -X DELETE https://lilt.com/2/connectors?key=API_KEY&id=123 ```
A unique Connector identifier.
A status object.
Unexpected error
Response Example (204 No Content)
{
"id": 12345,
"deleted": true
}
Response Example (default )
{
"message": "Internal server error."
}
Sync a Connector
Request an import job for the given connector ID. This will check the target system for new content to pull into Lilt.
Example CURL command:
curl -X GET https://lilt.com/2/connectors/sync?key=API_KEY&id=128
A unique Connector identifier.
A Connector Job object.
Unexpected error
Response Example (201 Created)
{
"id": "integer",
"status": "string",
"args": "object",
"created_at": "string",
"updated_at": "string"
}
Response Example (default )
{
"message": "Internal server error."
}
Retrieve a Connector Job
Retrieves a connector job available to your user. Use this to check the status of jobs started by the /connectors/sync and /connectors/jobs/deliver endpoints.
Example CURL command:
curl -X GET https://lilt.com/2/connectors/jobs?key=API_KEY&id=9274
A unique Connector Job identifier.
A list of Connector Jobs.
Unexpected error
Response Example (200 OK)
[
{
"id": "integer",
"status": "string",
"args": "object",
"created_at": "string",
"updated_at": "string"
}
]
Response Example (default )
{
"message": "Internal server error."
}
Deliver a Connector Job
Request an export job for the given connector job ID. This will check Lilt for completed projects that are associated with this job and deliver them to the target system.
Example CURL command:
curl -X POST https://lilt.com/2/connectors/jobs/deliver?key=API_KEY&id=9274
A unique Connector Job identifier.
A success status code.
Unexpected error
Response Example (default )
{
"message": "Internal server error."
}
ConverterConfig
List Converter Configs
List all file filter configurations for your Organization.
A unique Organization identifier.
A map of config id to string escaped config json.
Unexpected error
Response Example (200 OK)
{
"145": "{\"registry\": {\".xlsx\": {\"type\": \"OkapiFprm\", \"version\": 1, \"filterName\": \"okf_openxml\", \"filterConfig\": \"#v1\\nbPreferenceTranslateDocProperties.b=false\\nbPreferenceTranslateComments.b=true\\nbPreferenceTranslatePowerpointNotes.b=true\\nbPreferenceTranslatePowerpointMasters.b=true\\nbPreferenceIgnorePlaceholdersInPowerpointMasters.b=false\\nbPreferenceTranslateWordHeadersFooters.b=true\\nbPreferenceTranslateWordHidden.b=false\\nbPreferenceTranslateWordExcludeGraphicMetaData.b=true\\nbPreferenceTranslatePowerpointHidden.b=false\\nbPreferenceTranslateExcelHidden.b=false\\nbPreferenceTranslateExcelExcludeColors.b=false\\nbPreferenceTranslateExcelExcludeColumns.b=false\\nbPreferenceTranslateExcelSheetNames.b=false\\nbPreferenceAddLineSeparatorAsCharacter.b=false\\nsPreferenceLineSeparatorReplacement=$0a$\\nbPreferenceReplaceNoBreakHyphenTag.b=false\\nbPreferenceIgnoreSoftHyphenTag.b=false\\nbPreferenceAddTabAsCharacter.b=false\\nbPreferenceAggressiveCleanup.b=true\\nbPreferenceAutomaticallyAcceptRevisions.b=true\\nbPreferencePowerpointIncludedSlideNumbersOnly.b=false\\nbPreferenceTranslateExcelDiagramData.b=false\\nbPreferenceTranslateExcelDrawings.b=false\\nsubfilter=okf_plaintext\\nbInExcludeMode.b=true\\nbInExcludeHighlightMode.b=true\\nbPreferenceTranslateWordExcludeColors.b=false\\nbReorderPowerpointNotesAndComments.b=true\\ntsComplexFieldDefinitionsToExtract.i=1\\ncfd0=HYPERLINK\\ntsExcelExcludedColors.i=0\\ntsExcelExcludedColumns.i=0\\ntsExcludeWordStyles.i=0\\ntsWordHighlightColors.i=0\\ntsWordExcludedColors.i=0\\ntsPowerpointIncludedSlideNumbers.i=0\\nbExtractExternalHyperlinks.b=false\\n\", \"extractAllTags\": true, \"exportReplacements\": {\"patterns\": [], \"replacements\": []}, \"importReplacements\": {\"patterns\": [], \"replacements\": []}}}}",
"432": "{\"registry\": {\".md\": {\"type\": \"OkapiFprm\", \"version\": 1, \"filterName\": \"okf_markdown\", \"filterConfig\": \"#v1\\nuseCodeFinder.b=false\\ntranslateUrls.b=true\\nurlToTranslatePattern=.+\\ntranslateCodeBlocks.b=false\\ntranslateInlineCodeBlocks.b=true\\ntranslateHeaderMetadata.b=true\\ntranslateImageAltText.b=true\\nuseLinkSubflow.b=true\\ncodeFinderRules.count.i=1\\ncodeFinderRules.rule0=\\\\{\\\\{[^}]+\\\\}\\\\}\\ncodeFinderRules.sample={{#test}} handle bar test {{/test}}$0a${{stand-alone handle bar}}$0a$\\ncodeFinderRules.useAllRulesWhenTesting.b=true\\n\", \"extractAllTags\": true, \"exportReplacements\": {\"patterns\": [], \"replacements\": []}, \"importReplacements\": {\"patterns\": [], \"replacements\": []}}}"
}
Response Example (default )
{
"message": "Internal server error."
}
Add Converter Config
Add a file filter configuration for your Organization.
The file filter configuration to create.
- configJson: string
-
The configuration json blob, string escaped.
- configName: string
-
The user defined name of your configuration.
- configDescription: string
-
A description for the configuration.
A unique Organization identifier.
Request Content-Types: application/json
Request Example
{
"configJson": "{\"registry\": {\".md\": {\"type\": \"OkapiFprm\", \"version\": 1, \"filterName\": \"okf_markdown\", \"filterConfig\": \"#v1\\nuseCodeFinder.b=false\\ntranslateUrls.b=true\\nurlToTranslatePattern=.+\\ntranslateCodeBlocks.b=false\\ntranslateInlineCodeBlocks.b=true\\ntranslateHeaderMetadata.b=true\\ntranslateImageAltText.b=true\\nuseLinkSubflow.b=true\\ncodeFinderRules.count.i=1\\ncodeFinderRules.rule0=\\\\{\\\\{[^}]+\\\\}\\\\}\\ncodeFinderRules.sample={{#test}} handle bar test {{/test}}$0a${{stand-alone handle bar}}$0a$\\ncodeFinderRules.useAllRulesWhenTesting.b=true\\n\", \"extractAllTags\": true, \"exportReplacements\": {\"patterns\": [], \"replacements\": []}, \"importReplacements\": {\"patterns\": [], \"replacements\": []}}}",
"configName": "my_config",
"configDescription": "config for custom markdown escaping"
}
The config id of the configuration created.
Unexpected error
Response Example (200 OK)
{
"configId": "integer"
}
Response Example (default )
{
"message": "Internal server error."
}
Fetch Converter Config by Id
Fetch a file filter configuration by id.
A unique configuration identifier.
A map of config id to string escaped config json.
Unexpected error
Response Example (200 OK)
{
"145": "{\"registry\": {\".xlsx\": {\"type\": \"OkapiFprm\", \"version\": 1, \"filterName\": \"okf_openxml\", \"filterConfig\": \"#v1\\nbPreferenceTranslateDocProperties.b=false\\nbPreferenceTranslateComments.b=true\\nbPreferenceTranslatePowerpointNotes.b=true\\nbPreferenceTranslatePowerpointMasters.b=true\\nbPreferenceIgnorePlaceholdersInPowerpointMasters.b=false\\nbPreferenceTranslateWordHeadersFooters.b=true\\nbPreferenceTranslateWordHidden.b=false\\nbPreferenceTranslateWordExcludeGraphicMetaData.b=true\\nbPreferenceTranslatePowerpointHidden.b=false\\nbPreferenceTranslateExcelHidden.b=false\\nbPreferenceTranslateExcelExcludeColors.b=false\\nbPreferenceTranslateExcelExcludeColumns.b=false\\nbPreferenceTranslateExcelSheetNames.b=false\\nbPreferenceAddLineSeparatorAsCharacter.b=false\\nsPreferenceLineSeparatorReplacement=$0a$\\nbPreferenceReplaceNoBreakHyphenTag.b=false\\nbPreferenceIgnoreSoftHyphenTag.b=false\\nbPreferenceAddTabAsCharacter.b=false\\nbPreferenceAggressiveCleanup.b=true\\nbPreferenceAutomaticallyAcceptRevisions.b=true\\nbPreferencePowerpointIncludedSlideNumbersOnly.b=false\\nbPreferenceTranslateExcelDiagramData.b=false\\nbPreferenceTranslateExcelDrawings.b=false\\nsubfilter=okf_plaintext\\nbInExcludeMode.b=true\\nbInExcludeHighlightMode.b=true\\nbPreferenceTranslateWordExcludeColors.b=false\\nbReorderPowerpointNotesAndComments.b=true\\ntsComplexFieldDefinitionsToExtract.i=1\\ncfd0=HYPERLINK\\ntsExcelExcludedColors.i=0\\ntsExcelExcludedColumns.i=0\\ntsExcludeWordStyles.i=0\\ntsWordHighlightColors.i=0\\ntsWordExcludedColors.i=0\\ntsPowerpointIncludedSlideNumbers.i=0\\nbExtractExternalHyperlinks.b=false\\n\", \"extractAllTags\": true, \"exportReplacements\": {\"patterns\": [], \"replacements\": []}, \"importReplacements\": {\"patterns\": [], \"replacements\": []}}}}",
"432": "{\"registry\": {\".md\": {\"type\": \"OkapiFprm\", \"version\": 1, \"filterName\": \"okf_markdown\", \"filterConfig\": \"#v1\\nuseCodeFinder.b=false\\ntranslateUrls.b=true\\nurlToTranslatePattern=.+\\ntranslateCodeBlocks.b=false\\ntranslateInlineCodeBlocks.b=true\\ntranslateHeaderMetadata.b=true\\ntranslateImageAltText.b=true\\nuseLinkSubflow.b=true\\ncodeFinderRules.count.i=1\\ncodeFinderRules.rule0=\\\\{\\\\{[^}]+\\\\}\\\\}\\ncodeFinderRules.sample={{#test}} handle bar test {{/test}}$0a${{stand-alone handle bar}}$0a$\\ncodeFinderRules.useAllRulesWhenTesting.b=true\\n\", \"extractAllTags\": true, \"exportReplacements\": {\"patterns\": [], \"replacements\": []}, \"importReplacements\": {\"patterns\": [], \"replacements\": []}}}"
}
Response Example (default )
{
"message": "Internal server error."
}
Delete Converter Config
Delete a file filter configuration by id.
A unique configuration identifier.
The config id of the configuration deleted.
Unexpected error
Response Example (200 OK)
{
"configId": "integer"
}
Response Example (default )
{
"message": "Internal server error."
}
Add Filter Mapping
Add a specific filter mapping to your file filter configuration
The file filter mapping to create.
- registryEntryJson: string
-
The filter mapping json blob, string escaped.
- configName: string
-
The user defined name of your configuration.
- configDescription: string
-
A description for the configuration.
A unique configuration identifier.
A file extension for the filter mapping.
Request Content-Types: application/json
Request Example
{
"registryEntryJson": "{\"type\": \"OkapiFprm\", \"version\": 1, \"filterName\": \"okf_markdown\", \"filterConfig\": \"#v1\\nuseCodeFinder.b=false\\ntranslateUrls.b=true\\nurlToTranslatePattern=.+\\ntranslateCodeBlocks.b=false\\ntranslateInlineCodeBlocks.b=true\\ntranslateHeaderMetadata.b=true\\ntranslateImageAltText.b=true\\nuseLinkSubflow.b=true\\ncodeFinderRules.count.i=1\\ncodeFinderRules.rule0=\\\\{\\\\{[^}]+\\\\}\\\\}\\ncodeFinderRules.sample={{#test}} handle bar test {{/test}}$0a${{stand-alone handle bar}}$0a$\\ncodeFinderRules.useAllRulesWhenTesting.b=true\\n\", \"extractAllTags\": true, \"exportReplacements\": {\"patterns\": [], \"replacements\": []}, \"importReplacements\": {\"patterns\": [], \"replacements\": []}",
"configName": "my_config",
"configDescription": "config for custom markdown escaping"
}
A map of config id to string escaped config json.
Unexpected error
Response Example (200 OK)
{
"145": "{\"registry\": {\".xlsx\": {\"type\": \"OkapiFprm\", \"version\": 1, \"filterName\": \"okf_openxml\", \"filterConfig\": \"#v1\\nbPreferenceTranslateDocProperties.b=false\\nbPreferenceTranslateComments.b=true\\nbPreferenceTranslatePowerpointNotes.b=true\\nbPreferenceTranslatePowerpointMasters.b=true\\nbPreferenceIgnorePlaceholdersInPowerpointMasters.b=false\\nbPreferenceTranslateWordHeadersFooters.b=true\\nbPreferenceTranslateWordHidden.b=false\\nbPreferenceTranslateWordExcludeGraphicMetaData.b=true\\nbPreferenceTranslatePowerpointHidden.b=false\\nbPreferenceTranslateExcelHidden.b=false\\nbPreferenceTranslateExcelExcludeColors.b=false\\nbPreferenceTranslateExcelExcludeColumns.b=false\\nbPreferenceTranslateExcelSheetNames.b=false\\nbPreferenceAddLineSeparatorAsCharacter.b=false\\nsPreferenceLineSeparatorReplacement=$0a$\\nbPreferenceReplaceNoBreakHyphenTag.b=false\\nbPreferenceIgnoreSoftHyphenTag.b=false\\nbPreferenceAddTabAsCharacter.b=false\\nbPreferenceAggressiveCleanup.b=true\\nbPreferenceAutomaticallyAcceptRevisions.b=true\\nbPreferencePowerpointIncludedSlideNumbersOnly.b=false\\nbPreferenceTranslateExcelDiagramData.b=false\\nbPreferenceTranslateExcelDrawings.b=false\\nsubfilter=okf_plaintext\\nbInExcludeMode.b=true\\nbInExcludeHighlightMode.b=true\\nbPreferenceTranslateWordExcludeColors.b=false\\nbReorderPowerpointNotesAndComments.b=true\\ntsComplexFieldDefinitionsToExtract.i=1\\ncfd0=HYPERLINK\\ntsExcelExcludedColors.i=0\\ntsExcelExcludedColumns.i=0\\ntsExcludeWordStyles.i=0\\ntsWordHighlightColors.i=0\\ntsWordExcludedColors.i=0\\ntsPowerpointIncludedSlideNumbers.i=0\\nbExtractExternalHyperlinks.b=false\\n\", \"extractAllTags\": true, \"exportReplacements\": {\"patterns\": [], \"replacements\": []}, \"importReplacements\": {\"patterns\": [], \"replacements\": []}}}}",
"432": "{\"registry\": {\".md\": {\"type\": \"OkapiFprm\", \"version\": 1, \"filterName\": \"okf_markdown\", \"filterConfig\": \"#v1\\nuseCodeFinder.b=false\\ntranslateUrls.b=true\\nurlToTranslatePattern=.+\\ntranslateCodeBlocks.b=false\\ntranslateInlineCodeBlocks.b=true\\ntranslateHeaderMetadata.b=true\\ntranslateImageAltText.b=true\\nuseLinkSubflow.b=true\\ncodeFinderRules.count.i=1\\ncodeFinderRules.rule0=\\\\{\\\\{[^}]+\\\\}\\\\}\\ncodeFinderRules.sample={{#test}} handle bar test {{/test}}$0a${{stand-alone handle bar}}$0a$\\ncodeFinderRules.useAllRulesWhenTesting.b=true\\n\", \"extractAllTags\": true, \"exportReplacements\": {\"patterns\": [], \"replacements\": []}, \"importReplacements\": {\"patterns\": [], \"replacements\": []}}}"
}
Response Example (default )
{
"message": "Internal server error."
}
Delete Filter Mapping
Delete a file filter mapping by id and file extension.
A unique configuration identifier.
A file extension to delete.
A map of config id to string escaped config json.
Unexpected error
Response Example (200 OK)
{
"145": "{\"registry\": {\".xlsx\": {\"type\": \"OkapiFprm\", \"version\": 1, \"filterName\": \"okf_openxml\", \"filterConfig\": \"#v1\\nbPreferenceTranslateDocProperties.b=false\\nbPreferenceTranslateComments.b=true\\nbPreferenceTranslatePowerpointNotes.b=true\\nbPreferenceTranslatePowerpointMasters.b=true\\nbPreferenceIgnorePlaceholdersInPowerpointMasters.b=false\\nbPreferenceTranslateWordHeadersFooters.b=true\\nbPreferenceTranslateWordHidden.b=false\\nbPreferenceTranslateWordExcludeGraphicMetaData.b=true\\nbPreferenceTranslatePowerpointHidden.b=false\\nbPreferenceTranslateExcelHidden.b=false\\nbPreferenceTranslateExcelExcludeColors.b=false\\nbPreferenceTranslateExcelExcludeColumns.b=false\\nbPreferenceTranslateExcelSheetNames.b=false\\nbPreferenceAddLineSeparatorAsCharacter.b=false\\nsPreferenceLineSeparatorReplacement=$0a$\\nbPreferenceReplaceNoBreakHyphenTag.b=false\\nbPreferenceIgnoreSoftHyphenTag.b=false\\nbPreferenceAddTabAsCharacter.b=false\\nbPreferenceAggressiveCleanup.b=true\\nbPreferenceAutomaticallyAcceptRevisions.b=true\\nbPreferencePowerpointIncludedSlideNumbersOnly.b=false\\nbPreferenceTranslateExcelDiagramData.b=false\\nbPreferenceTranslateExcelDrawings.b=false\\nsubfilter=okf_plaintext\\nbInExcludeMode.b=true\\nbInExcludeHighlightMode.b=true\\nbPreferenceTranslateWordExcludeColors.b=false\\nbReorderPowerpointNotesAndComments.b=true\\ntsComplexFieldDefinitionsToExtract.i=1\\ncfd0=HYPERLINK\\ntsExcelExcludedColors.i=0\\ntsExcelExcludedColumns.i=0\\ntsExcludeWordStyles.i=0\\ntsWordHighlightColors.i=0\\ntsWordExcludedColors.i=0\\ntsPowerpointIncludedSlideNumbers.i=0\\nbExtractExternalHyperlinks.b=false\\n\", \"extractAllTags\": true, \"exportReplacements\": {\"patterns\": [], \"replacements\": []}, \"importReplacements\": {\"patterns\": [], \"replacements\": []}}}}",
"432": "{\"registry\": {\".md\": {\"type\": \"OkapiFprm\", \"version\": 1, \"filterName\": \"okf_markdown\", \"filterConfig\": \"#v1\\nuseCodeFinder.b=false\\ntranslateUrls.b=true\\nurlToTranslatePattern=.+\\ntranslateCodeBlocks.b=false\\ntranslateInlineCodeBlocks.b=true\\ntranslateHeaderMetadata.b=true\\ntranslateImageAltText.b=true\\nuseLinkSubflow.b=true\\ncodeFinderRules.count.i=1\\ncodeFinderRules.rule0=\\\\{\\\\{[^}]+\\\\}\\\\}\\ncodeFinderRules.sample={{#test}} handle bar test {{/test}}$0a${{stand-alone handle bar}}$0a$\\ncodeFinderRules.useAllRulesWhenTesting.b=true\\n\", \"extractAllTags\": true, \"exportReplacements\": {\"patterns\": [], \"replacements\": []}, \"importReplacements\": {\"patterns\": [], \"replacements\": []}}}"
}
Response Example (default )
{
"message": "Internal server error."
}
Documents
Create a Document
Create a new Document. A Document is a collection of one or more Segments. Documents are nested inside of Projects, and appear in the Project details view in the web app. Document-level relationships between Segments are considered by the machine translation system during adaptation. If there is no inherent document structure in your data, you still might consider grouping related Segments into Documents to improve translation quality.
The Document resource to create.
- name: string
-
The document name.
- project_id: integer
-
A unique Project identifier.
Request Content-Types: application/json
Request Example
{
"name": "Introduction.xliff",
"project_id": 23618
}
A Document object.
Unexpected error
Response Example (200 OK)
{
"id": 46530,
"project_id": 287,
"srclang": "en",
"trglang": "de",
"name": "Introduction.xliff",
"import_in_progress": false,
"import_succeeded": false,
"import_error_message": "Could not parse XML.",
"export_in_progress": false,
"export_succeeded": false,
"export_error_message": "Could not parse XML.",
"is_pretranslating": false,
"status": {
"pretranslation": "idle"
},
"translator_email": "translator@example.com",
"reviewer_email": "reviewer@example.com",
"created_at": 1489147692,
"updated_at": 1489147692,
"is_review_complete": true,
"segments": [
{
"id": 84480010,
"created_at": 1489147692,
"updated_at": 1489147692,
"document_id": 1234,
"memory_id": 5678,
"source": "The red bus.",
"srclang": "en",
"target": "Le bus rouge.",
"trglang": "fr",
"is_confirmed": true,
"is_reviewed": true
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Retrieve a Document
List a Document.
The listing will include the pretranslation status for the document. When pretranslation is in progress for a document, the GET /documents endpoint's response will include is_pretranslating = true as well as a more detailed status property status.pretranslation one of idle, pending, or running.
A unique Document identifier.
Flag indicating whether full segment information should be returned.
A Document object.
Unexpected error
Response Example (200 OK)
{
"id": 46530,
"project_id": 287,
"srclang": "en",
"trglang": "de",
"name": "Introduction.xliff",
"import_in_progress": false,
"import_succeeded": false,
"import_error_message": "Could not parse XML.",
"export_in_progress": false,
"export_succeeded": false,
"export_error_message": "Could not parse XML.",
"is_pretranslating": false,
"status": {
"pretranslation": "idle"
},
"translator_email": "translator@example.com",
"reviewer_email": "reviewer@example.com",
"created_at": 1489147692,
"updated_at": 1489147692,
"is_review_complete": true,
"segments": [
{
"id": 84480010,
"created_at": 1489147692,
"updated_at": 1489147692,
"document_id": 1234,
"memory_id": 5678,
"source": "The red bus.",
"srclang": "en",
"target": "Le bus rouge.",
"trglang": "fr",
"is_confirmed": true,
"is_reviewed": true
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Update a Document
Update a Document.
The Document resource to update.
- id: integer
-
A unique Document identifier.
- name: string
-
The Document name.
Request Content-Types: application/json
Request Example
{
"id": 46530,
"name": "Introduction to our App"
}
A Document object.
Invalid id or name or one of them was missing.
Unexpected error
Response Example (200 OK)
{
"id": 46530,
"project_id": 287,
"srclang": "en",
"trglang": "de",
"name": "Introduction.xliff",
"import_in_progress": false,
"import_succeeded": false,
"import_error_message": "Could not parse XML.",
"export_in_progress": false,
"export_succeeded": false,
"export_error_message": "Could not parse XML.",
"is_pretranslating": false,
"status": {
"pretranslation": "idle"
},
"translator_email": "translator@example.com",
"reviewer_email": "reviewer@example.com",
"created_at": 1489147692,
"updated_at": 1489147692,
"is_review_complete": true,
"segments": [
{
"id": 84480010,
"created_at": 1489147692,
"updated_at": 1489147692,
"document_id": 1234,
"memory_id": 5678,
"source": "The red bus.",
"srclang": "en",
"target": "Le bus rouge.",
"trglang": "fr",
"is_confirmed": true,
"is_reviewed": true
}
]
}
Response Example (400 Bad Request)
{
"message": "Internal server error."
}
Response Example (default )
{
"message": "Internal server error."
}
Update multiple Documents
Update multiple Documents.
An array of Document resources to update.
- id: integer
-
A unique Document identifier.
- name: string
-
The Document name.
Request Content-Types: application/json
Request Example
[
{
"id": 46530,
"name": "Introduction to our App"
}
]
Multiple Document objects.
Invalid id or name or one of them was missing.
Unexpected error
Response Example (200 OK)
[
{
"id": 46530,
"project_id": 287,
"srclang": "en",
"trglang": "de",
"name": "Introduction.xliff",
"import_in_progress": false,
"import_succeeded": false,
"import_error_message": "Could not parse XML.",
"export_in_progress": false,
"export_succeeded": false,
"export_error_message": "Could not parse XML.",
"is_pretranslating": false,
"status": {
"pretranslation": "idle"
},
"translator_email": "translator@example.com",
"reviewer_email": "reviewer@example.com",
"created_at": 1489147692,
"updated_at": 1489147692,
"is_review_complete": true,
"segments": [
{
"id": 84480010,
"created_at": 1489147692,
"updated_at": 1489147692,
"document_id": 1234,
"memory_id": 5678,
"source": "The red bus.",
"srclang": "en",
"target": "Le bus rouge.",
"trglang": "fr",
"is_confirmed": true,
"is_reviewed": true
}
]
}
]
Response Example (400 Bad Request)
[
{
"message": "Internal server error."
}
]
Response Example (default )
{
"message": "Internal server error."
}
Delete a Document
Delete a Document.
A unique Document identifier.
A status object.
Unexpected error
Response Example (200 OK)
{
"id": 46530,
"deleted": true
}
Response Example (default )
{
"message": "Internal server error."
}
Pretranslate a Document
Initiate pretranslation of a list of Documents. This request will mark document(s) as being pretranslated. Pretranslation in this context is:
- Applying and confirming exact TM matches based on the Memory of the Project;
- Translating all other segments via MT without confirming them.
Example CURL command:
curl -X POST https://lilt.com/2/documents/pretranslate?key=API_KEY -d '{"id": [123]}' -H "Content-Type: application/json"
Document translation is an asynchronous process that, in effect, is performed in the background.
To check the status of pretranslation for a document, use the GET /documents endpoint. When pretranslation is in progress for a document, the GET /documents endpoint's response will include is_pretranslating = true as well as a more detailed status property status.pretranslation one of idle, pending, or running.
Once pretranslation is finished, the document can be downloaded via GET /documents/files.
A list of unique Document identifiers.
- id: integer[]
-
A list of unique Document identifiers.
-
integer - auto_accept: boolean
-
Optional parameter for auto-accepting 100% TM hits.
- case_sensitive: boolean
-
Optional for using case matching against TM hits..
- attribute_to_creator: boolean
-
Optional parameter for attributing translation authorship of exact matches to document creator.
- mode: string
-
An optional parameter indicating how the document will be pretranslated.
The accepted values are
tm, ortm+mt. Default istm.
Deprecated, use body param instead. Optional parameter for auto-accepting 100% TM hits.
Deprecated, use body param instead. Optional for using case matching against TM hits.
Deprecated, use body param instead. Optional parameter for attributing translation authorship of exact matches to document creator.
Deprecated, use body param instead. An optional parameter indicating how the document will be pretranslated.
The accepted values are tm, or tm+mt. Default is tm.
Request Content-Types: application/json
Request Example
{
"id": [
123,
234
],
"auto_accept": false,
"case_sensitive": false,
"attribute_to_creator": false,
"mode": "tm+mt"
}
A status object.
Unexpected error
Response Example (202 Accepted)
{
"id": [
123,
234
],
"is_pretranslating": true,
"documents": [
{
"id": 123,
"import_in_progress": false,
"import_succeeded": true,
"import_error_message": "",
"is_processing": false,
"is_pretranslating": true,
"status": {
"pretranslation": "running"
}
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Download a Document
Export a Document that has been translated in the Lilt web application. Any Document can be downloaded in XLIFF 1.2 format, or can be retrieved in its original uploaded format by setting is_xliff=false. This endpoint will fail if either (a) export or (b) pre-translation operations are in-progress. The status of those operations can be determined by retrieving the Document resource. Example CURL command:
curl -X GET https://lilt.com/2/documents/files?key=API_KEY&id=274 -o from_lilt.xliff
An unique Document identifier.
Download the document in XLIFF 1.2 format.
A file.
File in pretranslation.
Unexpected error
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Response Example (default )
{
"message": "Internal server error."
}
Upload a File
Create a Document from a file in any of the formats
documented in our knowledge base. Request parameters should be passed as JSON object with the header field LILT-API.
File names in the header can only contain US-ASCII characters. File names with characters outside of US-ASCII should be URI encoded or transliterated to US-ASCII strings.
Example CURL command:
curl -X POST https://lilt.com/2/documents/files?key=API_KEY \
--header "LILT-API: {\"name\": \"introduction.xliff\",\"pretranslate\": \"tm+mt\",\"project_id\": 9}" \
--header "Content-Type: application/octet-stream" \
--data-binary @Introduction.xliff
The file contents to be uploaded. The entire POST body will be treated as the file.
A file name.
A unique Project identifier.
An optional parameter indicating if and how the document will be pretranslated upon being uploaded. The accepted values are TM, or TM+MT
An optional parameter to auto-accept segments with 100% translation memory matches when the pretranslate option is also set, or to auto-accept any target data that is present when the uploaded file is XLIFF. If omitted it will default to your organization settings for Accept and lock exact matches, if set to false, no segments will be auto-accepted.
An optional parameter to use case sensitive translation memory matching when the pretranslate option is also enabled. Matches must have identical character-by-character case to qualify as matches. Default value matches your organization settings for Use case sensitive translation memory matching setting
An optional parameter to attribute translation authorship of exact matches to the author of the file when the pretranslate option is also enabled. Default value matches your organization settings for Translation authorship setting
An optional pararameter to specify an import configuration to be applied when extracting translatable content from this file.
Request Content-Types: application/octet-stream
Request Example
"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<xliff xmlns=\"urn:oasis:names:tc:xliff:document:1.2\">\n...\n</xliff>"
A Document object.
Unexpected error
Response Example (200 OK)
{
"id": 46530,
"project_id": 287,
"srclang": "en",
"trglang": "de",
"name": "Introduction.xliff",
"import_in_progress": false,
"import_succeeded": false,
"import_error_message": "Could not parse XML.",
"export_in_progress": false,
"export_succeeded": false,
"export_error_message": "Could not parse XML.",
"is_pretranslating": false,
"status": {
"pretranslation": "idle"
},
"translator_email": "translator@example.com",
"reviewer_email": "reviewer@example.com",
"created_at": 1489147692,
"updated_at": 1489147692,
"is_review_complete": true,
"segments": [
{
"id": 84480010,
"created_at": 1489147692,
"updated_at": 1489147692,
"document_id": 1234,
"memory_id": 5678,
"source": "The red bus.",
"srclang": "en",
"target": "Le bus rouge.",
"trglang": "fr",
"is_confirmed": true,
"is_reviewed": true
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Unlock documents
Unlock documents for translation. Sets document "Translation Done" and "Review Done" to false.
Example curl:
curl --X --request POST 'https://lilt.com/2/documents/done/unlock?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"documentIds": [23921, 23922]
}'
document ids to update
- documentIds: number[]
-
array of document ids
-
number
Request Example
{
"documentIds": [
10641,
10642
]
}
array of updated documents
Response Example (200 OK)
[
"number"
]
Mark translation done
Mark the translation of documents as done/undone in bulk.
When being marked positively as done:
- Documents must not already be marked as done and all segments must be confirmed.
- This request will also trigger an email notification to a document's assigned reviewer that the document is ready for review.
When being marked as un-done:
- Documents must not be marked as complete for review.
Example curl:
curl --X --request POST 'https://lilt.com/2/documents/done/translation?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"documentIds": [23921, 23922],
"isDone": true
}'
document ids to update
- documentIds: number[]
-
array of document ids
-
number - isDone: boolean
Request Example
{
"documentIds": [
10641,
10642
],
"isDone": true
}
array of updated documents
Unexpected error
Response Example (200 OK)
[
"number"
]
Response Example (default )
{
"message": "Some documents are already marked as complete for review. DocumentIds 22322, 23343"
}
Mark review done
Mark the review of documents as done/undone in bulk.
When being marked positively as done:
- Documents must not already be marked as done for review.
- Documents must already be marked as done for translation.
- This request will also trigger an email notification.
Example curl:
curl --X --request POST 'https://lilt.com/2/documents/done/review?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"documentIds": [23921, 23922],
"isDone": true
}'
document ids to update
- documentIds: number[]
-
array of document ids
-
number - isDone: boolean
Request Example
{
"documentIds": [
10641,
10642
],
"isDone": true
}
array of updated documents
Unexpected error
Response Example (200 OK)
[
"number"
]
Response Example (default )
{
"message": "Some documents' translation is not marked as complete. Complete translation before completing review. DocumentIds 22322, 23343"
}
Languages
Retrieve supported languages
Get a list of supported languages.
An object listing supported languages and their corresponding locales.
Unexpected error
Response Example (200 OK)
{
"source_to_target": {
"en": {
"da": true,
"de": true,
"fr": true,
"...": "..."
},
"...": "..."
},
"code_to_name": {
"aa": "Afar",
"ab": "Abkhazian",
"af": "Afrikaans",
"...": "..."
}
}
Response Example (default )
{
"message": "Internal server error."
}
Lexicon
Update a Lexicon
Update the Lexicon (Termbase as displayed in the ui) with a new term. The maximum source length is 250 characters.
The lexicon entry.
- memory_id: integer
-
A unique Memory identifier.
- source: string
-
The source side of the lexicon entry.
- target: string
-
The target side of the lexicon entry.
Request Content-Types: application/json
Request Example
{
"memory_id": 10641,
"source": "washing machine",
"target": "Waschmaschine"
}
A status object.
Unexpected error
Response Example (200 OK)
{
"memory_id": 46530,
"success": true
}
Response Example (default )
{
"message": "Internal server error."
}
Query a Lexicon
Query the Lexicon. The Lexicon is an editable termbase / concordance that is integrated with the Memory.
A unique Memory identifier.
An ISO 639-1 language code.
An ISO 639-1 language code.
The query term.
The maximum number of results to return.
A list of LexiconEntry objects.
Unexpected error
Response Example (200 OK)
[
{
"translations": [],
"examples": [
[
{
"source": "Waschmaschine",
"sourceDelimiters": [
"",
""
],
"target": [
"washing",
"machine"
],
"targetDelimiters": [
"",
" ",
""
],
"sourceSpan": {
"start": 0,
"length": 1
},
"targetSpan": {
"start": 1,
"length": 1
},
"similarity": 0,
"memoryId": 10641
}
]
]
}
]
Response Example (default )
{
"message": "Internal server error."
}
Memories
Create a Memory
Create a new Memory. A Memory is a container that collects source/target sentences for a specific language pair (e.g., English>French). The data in the Memory is used to train the MT system, populate the TM, and update the lexicon. Memories are private to your account - the data is not shared across users - unless you explicitly share a Memory with your team (via web app only).
Refer to our KB for a more detailed description.
The Memory resource to create.
- name: string
-
A name for the Memory.
- srclang: string
-
An ISO 639-1 language identifier.
- trglang: string
-
An ISO 639-1 language identifier.
- srclocale: string
-
An ISO 3166-1 region name for language locales
- trglocale: string
-
An ISO 3166-1 region name for language locales
Request Content-Types: application/json
Request Example
{
"name": "automotive",
"srclang": "en",
"trglang": "fr",
"srclocale": "US",
"trglocale": "FR"
}
Response Example (200 OK)
{
"id": 1234,
"srclang": "en",
"trglang": "fr",
"srclocale": "US",
"trglocale": "FR",
"name": "Acme Corp Support Content",
"version": 78,
"created_at": 1489147692,
"updated_at": 1489147692,
"resources": [
"string"
]
}
Response Example (default )
{
"message": "Internal server error."
}
Retrieve a Memory
Retrieve a Memory. If you cannot access the Memory (401 error) please check permissions (e.g. in case you created the Memory via the web app with a different account you may have to explicitly share that Memory).
An optional Memory identifier.
Response Example (200 OK)
[
{
"id": 1234,
"srclang": "en",
"trglang": "fr",
"srclocale": "US",
"trglocale": "FR",
"name": "Acme Corp Support Content",
"version": 78,
"created_at": 1489147692,
"updated_at": 1489147692,
"resources": [
"string"
]
}
]
Response Example (default )
{
"message": "Internal server error."
}
Update the name of a Memory
Update a Memory.
The Memory resource to update.
- id: integer
-
A unique Memory identifier.
- name: string
-
The Memory name.
Request Content-Types: application/json
Request Example
{
"id": 7246,
"name": "Automotive Memory"
}
Response Example (200 OK)
{
"id": 1234,
"srclang": "en",
"trglang": "fr",
"srclocale": "US",
"trglocale": "FR",
"name": "Acme Corp Support Content",
"version": 78,
"created_at": 1489147692,
"updated_at": 1489147692,
"resources": [
"string"
]
}
Response Example (default )
{
"message": "Internal server error."
}
Delete a Memory
Delete a Memory.
A unique Memory identifier.
A status object.
Unexpected error
Response Example (200 OK)
{
"id": 46530,
"deleted": true
}
Response Example (default )
{
"message": "Internal server error."
}
Query a Memory
Perform a translation memory query.
A unique Memory identifier.
A source query.
Maximum number of results to return.
A list of TranslationMemoryEntry objects.
Unexpected error
Response Example (200 OK)
[
{
"source": "The red bus.",
"target": "Le bus rouge.",
"score": 100,
"metadata": "object"
}
]
Response Example (default )
{
"message": "Internal server error."
}
Get-sync for a Memory
Get all or part of a memory in TMX 1.4b format. If the from_time and/or to_time are omitted, then all segments are returned. The parameter when specifies on which date field from_time and to_time are matched. Possible values are created (when the segment was originally created in the memory), updated (when the segment was lastly updated), and deleted (when the segment was deleted).
Example CURL command:
curl -X GET https://lilt.com/2/memories/sync?key=API_KEY&id=42 -o from_lilt.tmx
A unique Memory identifier.
Unix time stamp (epoch, in seconds) of the start of the Memory section.
Unix time stamp (epoch, in seconds) of the end of the Memory section.
The date field on which retrieved segments match from/to time stamps: created, updated, deleted. If this parameter is omitted, then the whole Memory is returned.
A TMX 1.4b file.
Unexpected error
Response Content-Types: application/x-tmx
Response Example (200 OK)
"string (byte)"
Response Example (default )
{
"message": "Internal server error."
}
Insert-sync for a Memory
Inserts a TM in TMX 1.4b format into the Memory. Request parameters should be passed as JSON object with the header field LILT-API.
Example CURL command:
curl -X POST https://lilt.com/2/memories/sync?key=API_KEY \
--header "LILT-API: {\"name\": \"my_memory.tmx\",\"id\": 42}" \
--header "Content-Type: application/octet-stream" \
--data-binary @my_memory.tmx
The file contents to be uploaded. The entire POST body will be treated as the file.
A unique Memory identifier.
Name of the TMX file.
Request Content-Types: application/octet-stream
Request Example
"string"
A status object.
Unexpected error
Response Example (200 OK)
{
"id": 123,
"num_updates": 107
}
Response Example (default )
{
"message": "Internal server error."
}
Update-sync for a Memory
Updates the Memory with given TMX file. Request parameters should be passed as JSON object with the header field LILT-API. The number of segments returned by the from_time, to_time, when parameters and the number of segments in the TMX file need to be identical.
Example CURL command:
curl -X PUT https://lilt.com/2/memories/sync?key=API_KEY \
--header "LILT-API: {\"name\": \"my_memory.tmx\", \"id\": 42, \"from_time\": 1491048000, \"to_time\": 1491049800, "when": "Updated"}" \
--header "Content-Type: application/octet-stream" \
--data-binary @my_memory.tmx
The file contents to be uploaded. The entire PUT body will be treated as the file.
A unique Memory identifier.
Unix time stamp (epoch, in seconds) of the start of the Memory section.
Unix time stamp (epoch, in seconds) of the end of the Memory section.
The date field on which retrieved segments match from/to time stamps: created, updated, deleted.
Request Example
"string"
A status object.
Unexpected error
Response Example (200 OK)
{
"id": 123,
"num_updates": "num_updates"
}
Response Example (default )
{
"message": "Internal server error."
}
Delete-sync for a Memory
Deletes segments in the Memory matching the from_time, to_time and when parameters.
Example CURL command:
curl -X DELETE https://lilt.com/2/memories/sync?key=API_KEY&id=42&from_time=1491048000&to_time=1491049800&when=created
A unique Memory identifier.
Unix time stamp (epoch, in seconds) of the start of the Memory section.
Unix time stamp (epoch, in seconds) of the end of the Memory section.
The date field on which retrieved segments match from/to time stamps: created, updated, deleted.
A status object.
Unexpected error
Response Example (200 OK)
{
"id": 123,
"num_updates": 107
}
Response Example (default )
{
"message": "Internal server error."
}
File import for a Memory
Imports common translation memory or termbase file formats to a specific Lilt memory. Currently supported file formats are *.tmx, *.sdltm, *.sdlxliff(With custom Filters), '*.xliff', and *.tmq for TM data; *.csv and *.tbx for termbase data. Request parameters should be passed as JSON object with the header field LILT-API.
Example CURL command to upload a translation memory file named my_memory.sdltm in the current working directory:
curl -X POST https://lilt.com/2/memories/import?key=API_KEY \
--header "LILT-API: {\"name\": \"my_memory.sdltm\",\"memory_id\": 42}" \
--header "Content-Type: application/octet-stream" \
--data-binary @my_memory.sdltm
Example CURL command to upload a translation memory file named my_memory.sdlxliff in the current working directory, with Custom Filters based on SDLXLIFF fields, conf_name which maps to, percentage, and whether we should ignore unlocked segments.
curl -X POST https://lilt.com/2/memories/import?key=API_KEY \
--header "LILT-API: {\"name\": \"my_memory.sdlxliff\",\"memory_id\": 12,\"sdlxliff_filters\":[{\"conf_name\": \"Translated\", \"percentage\": 100, \"allow_unlocked\": false}]"}" \
--header "Content-Type: application/octet-stream" \
--data-binary @my_memory.sdlxliff
The file contents to be uploaded. The entire POST body will be treated as the file.
A unique Memory identifier.
Name of the TM or termbase file.
Contains Filter information Unique to SDLXLIFF
A flag indicating whether an imported Termbase CSV has a header row or not (the default value is false).
A flag indicating whether or not to skip the import of segments which already exist in the memory. (the default value is false).
Request Content-Types: application/octet-stream
Request Example
"string (binary)"
A status object.
Unexpected error
Response Example (200 OK)
{
"id": 123,
"isProcessing": 1
}
Response Example (default )
{
"message": "Internal server error."
}
Jobs
Create a Job
Create a Job. A Job is a collection of Projects. A Job will contain multiple projects, based on the language pair. A Project is associated with exactly one Memory.
Jobs appear in the Jobs dashboard of the web app.
Example CURL command:
curl -X POST 'https://lilt.com/2/jobs?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "test job",
"fileIds": [5009, 5010, 5011],
"due": "2022-05-05T10:56:44.985Z",
"srcLang": "en",
"srcLocale": "US",
"languagePairs": [
{ "memoryId": 3121, "trgLang": "de" },
{ "memoryId": 2508, "trgLang": "fr" },
{ "memoryId": 3037, "trgLang": "zh" }
]
}'
The Job resource to create.
- name: string
-
A name for the Job.
- languagePairs: LanguagePair
-
Language pairs is a set of one or more pairs that includes source language, source locale(optional), target language, target locale(optional), and memoryId.
-
LanguagePair - fileIds: integer[]
-
A list of file ids to upload to job creation.
-
integer - due: string
-
An ISO string date representing job due date.
- srcLang: string
-
2-letter ISO source language code
- srcLocale: string
-
2-letter source language code
- isPlural: boolean
-
A boolean value representing if the files have plurals.
- workflowTemplateId: integer
-
Identifier of the workflow template to be used when creating a job. If not passed the organization default will be used.
Request Content-Types: application/json
Request Example
{
"name": "My new Job",
"languagePairs": [
{
"srcLang": "en",
"srcLocale": "US",
"trgLang": "de",
"trgLocale": "DE",
"dueDate": "2021-10-03T13:43:00.000Z",
"memoryId": 1241,
"pretranslate": "boolean",
"autoAccept": true,
"caseSensitive": "boolean",
"takeMatchAttribution": true,
"configId": 2332,
"workflowTemplateId": 14,
"workflowStageAssignments": [
{
"workflowStageTemplateId": 12345,
"userId": 123,
"email": "username@domain.com"
}
]
}
],
"fileIds": [
298,
299
],
"due": "2021-10-05T14:48:00.000Z",
"srcLang": "en",
"srcLocale": "US",
"isPlural": true,
"workflowTemplateId": 123
}
Response Example (200 OK)
{
"name": "My New Job",
"creationStatus": "COMPLETE",
"deliveredAt": "2021-06-03T13:43:00.000Z",
"status": "active",
"due": "2021-06-03T13:43:00.000Z",
"id": 241,
"isProcessing": 0,
"stats": {
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": "en",
"srcLang": "en",
"srcLocale": "US",
"trgLang": "fr",
"trgLocale": "CA",
"name": "My new project",
"due": "2021-10-03T13:43:00.000Z",
"isComplete": false,
"isArchived": false,
"state": "inProgress",
"numSourceTokens": 2134,
"createdAt": "2021-04-01T13:43:00.000Z",
"updatedAt": "2021-06-03T13:43:00.000Z",
"isDeleted": false,
"memoryId": 2134,
"workflowStatus": "READY_TO_START",
"workflowName": "Translate > Review > Analyst Review"
}
],
"sourceWords": 0,
"uniqueLanguagePairs": 1,
"uniqueLinguists": 1,
"workflowStatus": "READY_TO_START"
}
}
Response Example (default )
{
"message": "Internal server error."
}
Retrieve all Jobs
Get all Jobs within a given offset and limit. You can retrieve jobs from your account using the above API.
Example CURL command:
curl -X GET 'https://lilt.com/2/jobs?key=API_KEY&isArchived=false'
Retrieves all jobs that are archived.
Retrieves all jobs that are delivered.
Return jobs starting at the offset row. If not given the default offset will be 0.
The maximum number of jobs to be returned. If not given the default limit will be 25.
Response Example (200 OK)
[
{
"name": "My New Job",
"creationStatus": "COMPLETE",
"deliveredAt": "2021-06-03T13:43:00.000Z",
"status": "active",
"due": "2021-06-03T13:43:00.000Z",
"id": 241,
"isProcessing": 0,
"stats": {
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": "en",
"srcLang": "en",
"srcLocale": "US",
"trgLang": "fr",
"trgLocale": "CA",
"name": "My new project",
"due": "2021-10-03T13:43:00.000Z",
"isComplete": false,
"isArchived": false,
"state": "inProgress",
"numSourceTokens": 2134,
"createdAt": "2021-04-01T13:43:00.000Z",
"updatedAt": "2021-06-03T13:43:00.000Z",
"isDeleted": false,
"memoryId": 2134,
"workflowStatus": "READY_TO_START",
"workflowName": "Translate > Review > Analyst Review"
}
],
"sourceWords": 0,
"uniqueLanguagePairs": 1,
"uniqueLinguists": 1,
"workflowStatus": "READY_TO_START"
}
}
]
Response Example (default )
{
"message": "Internal server error."
}
Retrieve a Job
Retrieves a job data along with stats. To retrieve a specific job, you will need the job id in the url path.
Example CURL command:
curl -X GET 'https://lilt.com/2/jobs/{id}?key=API_KEY'
A job id.
Response Example (200 OK)
{
"name": "My New Job",
"creationStatus": "COMPLETE",
"deliveredAt": "2021-06-03T13:43:00.000Z",
"status": "active",
"due": "2021-06-03T13:43:00.000Z",
"id": 241,
"isProcessing": 0,
"stats": {
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": "en",
"srcLang": "en",
"srcLocale": "US",
"trgLang": "fr",
"trgLocale": "CA",
"name": "My new project",
"due": "2021-10-03T13:43:00.000Z",
"isComplete": false,
"isArchived": false,
"state": "inProgress",
"numSourceTokens": 2134,
"createdAt": "2021-04-01T13:43:00.000Z",
"updatedAt": "2021-06-03T13:43:00.000Z",
"isDeleted": false,
"memoryId": 2134,
"workflowStatus": "READY_TO_START",
"workflowName": "Translate > Review > Analyst Review"
}
],
"sourceWords": 0,
"uniqueLanguagePairs": 1,
"uniqueLinguists": 1,
"workflowStatus": "READY_TO_START"
}
}
Response Example (default )
{
"message": "Internal server error."
}
Update a Job
Updates a job with the new job properties. To update a specific job, you will need the job id in the url path.
You can update job's name and due date by passing the property and new value in the body.
Example CURL command:
curl -X PUT 'https://lilt.com/2/jobs/{id}?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "test job",
"due": "2022-05-05T10:56:44.985Z"
}'
The Job resource to update.
- name: string
-
A name for the Job.
- dueDate: integer
-
An ISO string date.
A job id.
Request Example
{
"name": "My new Job",
"dueDate": "2021-10-05T14:48:00.000Z"
}
Response Example (200 OK)
{
"name": "My New Job",
"creationStatus": "COMPLETE",
"deliveredAt": "2021-06-03T13:43:00.000Z",
"status": "active",
"due": "2021-06-03T13:43:00.000Z",
"id": 241,
"isProcessing": 0,
"stats": {
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": "en",
"srcLang": "en",
"srcLocale": "US",
"trgLang": "fr",
"trgLocale": "CA",
"name": "My new project",
"due": "2021-10-03T13:43:00.000Z",
"isComplete": false,
"isArchived": false,
"state": "inProgress",
"numSourceTokens": 2134,
"createdAt": "2021-04-01T13:43:00.000Z",
"updatedAt": "2021-06-03T13:43:00.000Z",
"isDeleted": false,
"memoryId": 2134,
"workflowStatus": "READY_TO_START",
"workflowName": "Translate > Review > Analyst Review"
}
],
"sourceWords": 0,
"uniqueLanguagePairs": 1,
"uniqueLinguists": 1,
"workflowStatus": "READY_TO_START"
}
}
Response Example (default )
{
"message": "Internal server error."
}
Delete a Job
Delete a job, deletes all projects and documents in the job, deletes all the segments from all the job's translation memories.
Example CURL command:
curl -X DELETE 'https://lilt.com/2/jobs/{id}?key=API_KEY'
A job id.
A status object.
Unexpected error
Response Example (200 OK)
{
"id": 241
}
Response Example (default )
{
"message": "Internal server error."
}
Retrieve Job Leverage Stats
Get the TM leverage stats for the job (new/exact/fuzzy matches).
Example CURL command:
curl -X POST 'https://lilt.com/2/jobs/{id}/stats?key=API_KEY'
A job id.
A job leverage stats object.
Unexpected error
Response Example (200 OK)
{
"sourceWords": 0,
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"projects": [
{
"id": 1,
"sourceWords": 1000,
"exactWords": 800,
"fuzzyWords": 150,
"newWords": 50
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Archive a Job
Set job to archived, unassign all linguists and archive all projects and documents inside the job.
It will return the archived job.
Example CURL command:
curl -X POST 'https://lilt.com/2/jobs/{id}/archive?key=API_KEY'
A job id.
Response Example (200 OK)
{
"name": "My New Job",
"creationStatus": "COMPLETE",
"deliveredAt": "2021-06-03T13:43:00.000Z",
"status": "active",
"due": "2021-06-03T13:43:00.000Z",
"id": 241,
"isProcessing": 0,
"stats": {
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": "en",
"srcLang": "en",
"srcLocale": "US",
"trgLang": "fr",
"trgLocale": "CA",
"name": "My new project",
"due": "2021-10-03T13:43:00.000Z",
"isComplete": false,
"isArchived": false,
"state": "inProgress",
"numSourceTokens": 2134,
"createdAt": "2021-04-01T13:43:00.000Z",
"updatedAt": "2021-06-03T13:43:00.000Z",
"isDeleted": false,
"memoryId": 2134,
"workflowStatus": "READY_TO_START",
"workflowName": "Translate > Review > Analyst Review"
}
],
"sourceWords": 0,
"uniqueLanguagePairs": 1,
"uniqueLinguists": 1,
"workflowStatus": "READY_TO_START"
}
}
Response Example (default )
{
"message": "Internal server error."
}
Unarchive a Job
Set job to unarchived, the job will move to active status.
Example CURL command:
curl -X POST 'https://lilt.com/2/jobs/{id}/unarchive?key=API_KEY'
A job id.
Response Example (200 OK)
{
"name": "My New Job",
"creationStatus": "COMPLETE",
"deliveredAt": "2021-06-03T13:43:00.000Z",
"status": "active",
"due": "2021-06-03T13:43:00.000Z",
"id": 241,
"isProcessing": 0,
"stats": {
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": "en",
"srcLang": "en",
"srcLocale": "US",
"trgLang": "fr",
"trgLocale": "CA",
"name": "My new project",
"due": "2021-10-03T13:43:00.000Z",
"isComplete": false,
"isArchived": false,
"state": "inProgress",
"numSourceTokens": 2134,
"createdAt": "2021-04-01T13:43:00.000Z",
"updatedAt": "2021-06-03T13:43:00.000Z",
"isDeleted": false,
"memoryId": 2134,
"workflowStatus": "READY_TO_START",
"workflowName": "Translate > Review > Analyst Review"
}
],
"sourceWords": 0,
"uniqueLanguagePairs": 1,
"uniqueLinguists": 1,
"workflowStatus": "READY_TO_START"
}
}
Response Example (default )
{
"message": "Internal server error."
}
Deliver a Job
Set the job state to delivered and set all the projects in the job to done
It will return the delivered job.
Example CURL command:
curl -X POST 'https://lilt.com/2/jobs/{id}/deliver?key=API_KEY'
A job id.
Response Example (200 OK)
{
"name": "My New Job",
"creationStatus": "COMPLETE",
"deliveredAt": "2021-06-03T13:43:00.000Z",
"status": "active",
"due": "2021-06-03T13:43:00.000Z",
"id": 241,
"isProcessing": 0,
"stats": {
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": "en",
"srcLang": "en",
"srcLocale": "US",
"trgLang": "fr",
"trgLocale": "CA",
"name": "My new project",
"due": "2021-10-03T13:43:00.000Z",
"isComplete": false,
"isArchived": false,
"state": "inProgress",
"numSourceTokens": 2134,
"createdAt": "2021-04-01T13:43:00.000Z",
"updatedAt": "2021-06-03T13:43:00.000Z",
"isDeleted": false,
"memoryId": 2134,
"workflowStatus": "READY_TO_START",
"workflowName": "Translate > Review > Analyst Review"
}
],
"sourceWords": 0,
"uniqueLanguagePairs": 1,
"uniqueLinguists": 1,
"workflowStatus": "READY_TO_START"
}
}
Response Example (default )
{
"message": "Internal server error."
}
Reactivate a Job
Set the job state to active. Does not change the state of projects associated with the given job.
It will return the reactivated job.
Example CURL command:
curl -X POST 'https://lilt.com/2/jobs/{id}/reactivate?key=API_KEY'
A job id.
Response Example (200 OK)
{
"name": "My New Job",
"creationStatus": "COMPLETE",
"deliveredAt": "2021-06-03T13:43:00.000Z",
"status": "active",
"due": "2021-06-03T13:43:00.000Z",
"id": 241,
"isProcessing": 0,
"stats": {
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": "en",
"srcLang": "en",
"srcLocale": "US",
"trgLang": "fr",
"trgLocale": "CA",
"name": "My new project",
"due": "2021-10-03T13:43:00.000Z",
"isComplete": false,
"isArchived": false,
"state": "inProgress",
"numSourceTokens": 2134,
"createdAt": "2021-04-01T13:43:00.000Z",
"updatedAt": "2021-06-03T13:43:00.000Z",
"isDeleted": false,
"memoryId": 2134,
"workflowStatus": "READY_TO_START",
"workflowName": "Translate > Review > Analyst Review"
}
],
"sourceWords": 0,
"uniqueLanguagePairs": 1,
"uniqueLinguists": 1,
"workflowStatus": "READY_TO_START"
}
}
Response Example (default )
{
"message": "Internal server error."
}
Export a Job
Prepare job files for download. To export translated documents from the job use the query parameter type=files:
Example CURL command:
curl -X GET 'https://lilt.com/2/jobs/{id}/export?key=API_KEY&type=files'
To export job memories use the query parameter type=memory.
The status of the export can be checked by requesting the job GET /jobs/:jobId, job.isProcessing will be 1 while in progress, 0 when idle and -2 when the export failed.
A job id.
category for files and memory.
200 status.
Unexpected error
Response Example (default )
{
"message": "Internal server error."
}
Download a Job
Make sure you have exported a job with the same id before using this api.
Downloading files requires the exported job id in the param.
Example CURL command:
curl -X GET 'https://lilt.com/2/jobs/{id}/download?key=API_KEY'
A job id.
zipped file
Unexpected error
Response Example (default )
{
"message": "Internal server error."
}
Projects
Create a Project
Create a Project. A Project is a collection of Documents.
A Project is associated with exactly one Memory.
Projects appear in the dashboard of the web app.
The Project resource to create.
- name: string
-
A name for the Project.
- memory_id: integer
-
The Memory to associate with this new Project.
- job_id: integer
-
The Job to associate with this new Project. If a Job ID is not provided then a new Job will be created to contain the Project.
- due_date: integer
-
The due date. Measured in seconds since the Unix epoch.
- metadata: object
-
A JSON object of key/value string pairs. Stores custom project information.
- workflowTemplateId: integer
-
The workflow template used to create this project. WorkflowTemplateIds can be retrieved via the /workflows/templates endpoint. If not specified then the organization default workflowTemplateId will be used.
Request Content-Types: application/json
Request Example
{
"name": "My new project",
"memory_id": 1234,
"job_id": 1234,
"due_date": 1489147692,
"metadata": {
"connectorType": "github",
"notes": "example metadata"
},
"workflowTemplateId": 14
}
Response Example (200 OK)
{
"id": 448,
"memory_id": 1234,
"job_id": 1234,
"srclang": "en",
"trglang": "fr",
"srclocale": "US",
"trglocale": "FR",
"name": "My New Project",
"state": "backlog",
"due_date": 1489147692,
"archived": false,
"metadata": {
"connectorType": "github",
"notes": "example metadata"
},
"sample_review_percentage": 20,
"created_at": 1489147692,
"updated_at": 1489147692,
"workflowStatus": "READY_TO_START",
"document": [
{
"id": 46530,
"project_id": 287,
"srclang": "en",
"trglang": "de",
"name": "Introduction.xliff",
"import_in_progress": false,
"import_succeeded": false,
"import_error_message": "Could not parse XML.",
"export_in_progress": false,
"export_succeeded": false,
"export_error_message": "Could not parse XML.",
"is_pretranslating": false,
"status": {
"pretranslation": "idle"
},
"translator_email": "translator@example.com",
"reviewer_email": "reviewer@example.com",
"created_at": 1489147692,
"updated_at": 1489147692,
"is_review_complete": true
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Retrieve a Project
Retrieves one or more projects, including the documents associated with each project. Retrieving a project is the most efficient way to retrieve a single project, multiple projects or a list of all available projects.
To retrieve a specific project, specify the id request parameter or you can retrieve multiple projects by adding comma (,) between ids eg. ?id=1234,5678. To retrieve all projects, omit the id request parameter. To limit the retrieved projects to those with a particular source language or target language, specify the corresponding ISO 639-1 language codes in the srclang and trglang request parameters, respectively.
A unique Project identifier. It can be a single id or multiple ids separated by a comma
An ISO 639-1 language code.
An ISO 639-1 language code.
Unix time stamp (epoch, in seconds) of Projects with created_at greater than or equal to the value.
Unix time stamp (epoch, in seconds) of Projects with created_at less than the value.
A project state (backlog, inProgress, inReview, inQA, done).
A flag that toggles whether to include archived projects in the response (the default is true).
A unique Connector identifier.
Response Example (200 OK)
[
{
"id": 448,
"memory_id": 1234,
"job_id": 1234,
"srclang": "en",
"trglang": "fr",
"srclocale": "US",
"trglocale": "FR",
"name": "My New Project",
"state": "backlog",
"due_date": 1489147692,
"archived": false,
"metadata": {
"connectorType": "github",
"notes": "example metadata"
},
"sample_review_percentage": 20,
"created_at": 1489147692,
"updated_at": 1489147692,
"workflowStatus": "READY_TO_START",
"document": [
{
"id": 46530,
"project_id": 287,
"srclang": "en",
"trglang": "de",
"name": "Introduction.xliff",
"import_in_progress": false,
"import_succeeded": false,
"import_error_message": "Could not parse XML.",
"export_in_progress": false,
"export_succeeded": false,
"export_error_message": "Could not parse XML.",
"is_pretranslating": false,
"status": {
"pretranslation": "idle"
},
"translator_email": "translator@example.com",
"reviewer_email": "reviewer@example.com",
"created_at": 1489147692,
"updated_at": 1489147692,
"is_review_complete": true
}
]
}
]
Response Example (default )
{
"message": "Internal server error."
}
Update a Project
Update a Project.
The Project resource to update.
- id: integer
-
A unique Project identifier.
- name: string
-
The Project name.
- state: string
-
The project's state. The possible states are 'backlog', 'inProgress', 'inReview', 'inQA', and 'done'
- due_date: integer
-
The due date. Measured in seconds since the Unix epoch.
- archived: boolean
-
True if the project is archived. Otherwise, false.
- metadata: object
-
Metadata associated with a project. This field must be valid JSON.
- sample_review_percentage: integer
-
The Project's sample review percentage. Must be an integer between 10 and 100, a multiple of 10 and greater than minimum value (displayed in error message).
Request Content-Types: application/json
Request Example
{
"id": 1234,
"name": "Walker Percy Essays",
"state": "backlog",
"due_date": 1489147692,
"archived": false,
"metadata": {
"connectorType": "github",
"notes": "example metadata"
},
"sample_review_percentage": 20
}
Response Example (200 OK)
{
"id": 448,
"memory_id": 1234,
"job_id": 1234,
"srclang": "en",
"trglang": "fr",
"srclocale": "US",
"trglocale": "FR",
"name": "My New Project",
"state": "backlog",
"due_date": 1489147692,
"archived": false,
"metadata": {
"connectorType": "github",
"notes": "example metadata"
},
"sample_review_percentage": 20,
"created_at": 1489147692,
"updated_at": 1489147692,
"workflowStatus": "READY_TO_START",
"document": [
{
"id": 46530,
"project_id": 287,
"srclang": "en",
"trglang": "de",
"name": "Introduction.xliff",
"import_in_progress": false,
"import_succeeded": false,
"import_error_message": "Could not parse XML.",
"export_in_progress": false,
"export_succeeded": false,
"export_error_message": "Could not parse XML.",
"is_pretranslating": false,
"status": {
"pretranslation": "idle"
},
"translator_email": "translator@example.com",
"reviewer_email": "reviewer@example.com",
"created_at": 1489147692,
"updated_at": 1489147692,
"is_review_complete": true
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Update multiple Projects
Update multiple Projects.
The Project resources to update.
- id: integer
-
A unique Project identifier.
- name: string
-
The Project name.
- state: string
-
The project's state. The possible states are 'backlog', 'inProgress', 'inReview', 'inQA', and 'done'
- due_date: integer
-
The due date. Measured in seconds since the Unix epoch.
- archived: boolean
-
True if the project is archived. Otherwise, false.
- metadata: object
-
Metadata associated with a project. This field must be valid JSON.
- sample_review_percentage: integer
-
The Project's sample review percentage. Must be an integer between 10 and 100, a multiple of 10 and greater than minimum value (displayed in error message).
Request Content-Types: application/json
Request Example
[
{
"id": 1234,
"name": "Walker Percy Essays",
"state": "backlog",
"due_date": 1489147692,
"archived": false,
"metadata": {
"connectorType": "github",
"notes": "example metadata"
},
"sample_review_percentage": 20
}
]
Response Example (200 OK)
[
{
"id": 448,
"memory_id": 1234,
"job_id": 1234,
"srclang": "en",
"trglang": "fr",
"srclocale": "US",
"trglocale": "FR",
"name": "My New Project",
"state": "backlog",
"due_date": 1489147692,
"archived": false,
"metadata": {
"connectorType": "github",
"notes": "example metadata"
},
"sample_review_percentage": 20,
"created_at": 1489147692,
"updated_at": 1489147692,
"workflowStatus": "READY_TO_START",
"document": [
{
"id": 46530,
"project_id": 287,
"srclang": "en",
"trglang": "de",
"name": "Introduction.xliff",
"import_in_progress": false,
"import_succeeded": false,
"import_error_message": "Could not parse XML.",
"export_in_progress": false,
"export_succeeded": false,
"export_error_message": "Could not parse XML.",
"is_pretranslating": false,
"status": {
"pretranslation": "idle"
},
"translator_email": "translator@example.com",
"reviewer_email": "reviewer@example.com",
"created_at": 1489147692,
"updated_at": 1489147692,
"is_review_complete": true
}
]
}
]
Response Example (default )
{
"message": "Internal server error."
}
Delete a Project
Delete a Project.
A unique Project identifier.
A status object.
Unexpected error
Response Example (200 OK)
{
"id": 46530,
"deleted": true
}
Response Example (default )
{
"message": "Internal server error."
}
Update multiple Projects with a single payload
Update multiple Projects with a single payload.
The Project resources to update.
- projectIds: integer[]
-
integer A unique Project identifier.
- project: object
-
- name: string
-
The Project name.
- state: string
-
The project's state. The possible states are 'backlog', 'inProgress', 'inReview', 'inQA', and 'done'
- due_date: integer
-
The due date. Measured in seconds since the Unix epoch.
- archived: boolean
-
True if the project is archived. Otherwise, false.
- metadata: object
-
Metadata associated with a project. This field must be valid JSON.
- sample_review_percentage: integer
-
The Project's sample review percentage. Must be an integer between 10 and 100, a multiple of 10 and greater than minimum value (displayed in error message).
Request Content-Types: application/json
Request Example
{
"projectIds": [
1234
],
"project": {
"name": "Walker Percy Essays",
"state": "backlog",
"due_date": 1489147692,
"archived": false,
"metadata": {
"connectorType": "github",
"notes": "example metadata"
},
"sample_review_percentage": 20
}
}
Response Example (200 OK)
[
{
"id": 448,
"memory_id": 1234,
"job_id": 1234,
"srclang": "en",
"trglang": "fr",
"srclocale": "US",
"trglocale": "FR",
"name": "My New Project",
"state": "backlog",
"due_date": 1489147692,
"archived": false,
"metadata": {
"connectorType": "github",
"notes": "example metadata"
},
"sample_review_percentage": 20,
"created_at": 1489147692,
"updated_at": 1489147692,
"workflowStatus": "READY_TO_START",
"document": [
{
"id": 46530,
"project_id": 287,
"srclang": "en",
"trglang": "de",
"name": "Introduction.xliff",
"import_in_progress": false,
"import_succeeded": false,
"import_error_message": "Could not parse XML.",
"export_in_progress": false,
"export_succeeded": false,
"export_error_message": "Could not parse XML.",
"is_pretranslating": false,
"status": {
"pretranslation": "idle"
},
"translator_email": "translator@example.com",
"reviewer_email": "reviewer@example.com",
"created_at": 1489147692,
"updated_at": 1489147692,
"is_review_complete": true
}
]
}
]
Response Example (default )
{
"message": "Internal server error."
}
Deliver multiple projects apart from their jobs.
Deliver mulitple projects apart from their jobs.
The Project resources to update.
- projectIds: integer[]
-
integer A unique Project identifier.
Whether the project has or not workflows enabled. (not used)
Request Content-Types: application/json
Request Example
{
"projectIds": [
1234
]
}
Empty response if succeed.
Unexpected error
Response Example (default )
{
"message": "Internal server error."
}
Retrieve Project report
Get information about a project that can be used for quoting. This includes:
- A translation memory leverage report
- Word count
- Segment count
A unique Project identifier.
An object that represents a Project quote.
Unexpected error
Response Example (200 OK)
{
"id": 21902,
"num_source_words": 8000,
"num_words_new": 6039,
"num_segments_new": 151,
"num_words_repetition": 12,
"num_segments_repetition": 2980000,
"bands": [
{
"minimum_score": 94,
"maximum_score": 85,
"num_source_words": 151,
"num_segments": 12
}
],
"documents": [
{
"id": 21902,
"num_source_words": 8000,
"num_words_new": 6039,
"num_segments_new": 151,
"num_words_repetition": 12,
"num_segments_repetition": 2980000,
"bands": [
{
"minimum_score": 94,
"maximum_score": 85,
"num_source_words": 151,
"num_segments": 12
}
]
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Retrieve Project revision report
Get information about a project's revision report. This includes:
- Stats on accepted segments
- reviewer details
- Error rate
A unique Project identifier.
A csv file containing revision report.
Unexpected error
Response Example (default )
{
"message": "Internal server error."
}
Retrieve Project status
Retrieve the status of a Project.
A unique Project identifier.
An object that represents a Project status report.
Unexpected error
Response Example (200 OK)
{
"id": 21902,
"num_source_words": 6039,
"num_words_confirmed": 151,
"num_words_reviewed": 12,
"time_elapsed": 2980000,
"time_elapsed_translation": 33487,
"time_elapsed_research": 912348,
"time_elapsed_review": 66521,
"updated_at": 1656513752,
"resources": [
{
"email": "joe.strummer@lilt.com",
"name": "Joe Strummer",
"num_words_confirmed": 151,
"num_words_new": 12,
"num_words_fuzzy": 24,
"num_words_exact": 56,
"num_words_reviewed": 182,
"time_elapsed": 1172000,
"time_elapsed_translation": 1172000,
"time_elapsed_research": 1172000,
"time_elapsed_review": 1172000,
"num_segments_confirmed": 25,
"num_segments_reviewed": 30
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Auto Assignment
Trigger automatic assignment of linguists.
Requires auto-assignment to be enabled as a setting on the origanization level.
An array of project ids to auto-assign. (optional) If projectIds is specified in the querystring it will have precedence.
- projectIds: integer[]
-
integer
The comma separated list of project ids to auto-assign. Can be sent in the body as an alternative but if both are specified the query has precedence.
Request Content-Types: application/json
Request Example
{
"projectIds": [
"integer"
]
}
An auto assignment response.
Bad request. Possible causes include no permission to the projects and the auto-assignment setting not being enabled.
Unexpected error
Response Example (200 OK)
[
{
"projectId": 123,
"success": "boolean",
"error": "string",
"errors": [
{
"errorType": "LINGUIST_MAY_BE_DELETED",
"projectId": 123,
"documentId": 456,
"error": "Linguist may be deleted"
}
],
"assignments": [
{
"isPreferredTranslator": true,
"wordsLeftAveragedTranslator": 56,
"wordsLeftAveragedReviewer": 56,
"assignmentErrors": [
"Error message"
],
"docId": 56,
"projectId": 56,
"isAutoAssigned": true,
"translatorUserId": 56,
"translatorRoleId": 56,
"translatorDueDate": "2023-03-28T16:00:00Z",
"reviewerUserId": 56
}
]
}
]
Response Example (400 Bad Request)
{
"message": "Bad Request."
}
Response Example (default )
{
"message": "Internal server error."
}
QA
Perform QA check
Perform QA checks on a target string. Optionally, you can specify a source string for additional bilingual checks, e.g. number consistency.
A target string to be checked.
An ISO 639-1 language code.
An optional source string.
An ISO 639-1 language code.
Any custom rules defined for this Memory will also be applied as part of the QA check.
A QARuleMatches object.
Unexpected error
Response Example (200 OK)
{
"matches": [
{
"context": {
"length": 7,
"offset": 19,
"text": "This segment has a speling mistake"
},
"length": 7,
"message": "Possible spelling mistake found",
"offset": 19,
"replacements": [
{
"value": "spelling"
},
{
"value": "spewing"
},
{
"value": "spieling"
}
],
"rule": {
"category": {
"id": "TYPOS",
"name": "Possible Typo"
},
"description": "Possible spelling mistake",
"id": "MORFOLOGIK_RULE_EN_US",
"issueType": "misspelling",
"subId": "",
"urls": []
},
"shortMessage": "Spelling mistake"
}
],
"custom_rules": [
{
"description": "Mistake detected by a custom rule."
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Segments
Create a Segment
Create a Segment and add it to a Memory. A Segment is a source/target pair that is used to train the machine translation system and populate the translation memory. This is not intended to be used on documents and will throw an error.
The maximum source length is 5,000 characters.
The Segment resource to create.
To add a Segment to a Memory, include the memory_id and target parameters.
To add a Segment to a Document, include the document_id and the source parameters. The target parameter is optional.
- memory_id: integer
-
A unique Memory identifier.
- document_id: integer
-
A unique Document identifier.
- source: string
-
The source string.
- target: string
-
The target string.
Request Content-Types: application/json
Request Example
{
"memory_id": 10641,
"document_id": 1876,
"source": "Code zur Fehleranalyse einschalten",
"target": "Enable debugging code"
}
Response Example (200 OK)
{
"id": 84480010,
"created_at": 1489147692,
"updated_at": 1489147692,
"document_id": 1234,
"memory_id": 5678,
"source": "The red bus.",
"srclang": "en",
"target": "Le bus rouge.",
"trglang": "fr",
"is_confirmed": true,
"is_reviewed": true
}
Response Example (default )
{
"message": "Internal server error."
}
Retrieve a Segment
Retrieve a Segment.
A unique Segment identifier.
Include comments in the response.
A Segment object.
Unexpected error
Response Example (200 OK)
{
"id": 84480010,
"created_at": 1489147692,
"updated_at": 1489147692,
"document_id": 1234,
"memory_id": 5678,
"source": "The red bus.",
"srclang": "en",
"target": "Le bus rouge.",
"trglang": "fr",
"is_confirmed": true,
"is_reviewed": true,
"comments": [
{
"id": 84480010,
"text": "This is incorrect.",
"annotations": [
{
"text": "mistranslation"
}
],
"is_resolved": true,
"document_id": 5678,
"segment_id": 5678,
"segment_revision_id": 5678,
"user_id": 5678,
"created_at": 1489147692
}
]
}
Response Example (default )
{
"message": "Internal server error."
}
Update a Segment
Update a Segment in memory. The Memory will be updated with the new target string.
The Segment resource to update.
- id: integer
-
A unique Segment identifier.
- target: string
-
The target string.
Request Content-Types: application/json
Request Example
{
"id": 84480010,
"target": "Enable debug code"
}
Response Example (200 OK)
{
"id": 84480010,
"created_at": 1489147692,
"updated_at": 1489147692,
"document_id": 1234,
"memory_id": 5678,
"source": "The red bus.",
"srclang": "en",
"target": "Le bus rouge.",
"trglang": "fr",
"is_confirmed": true,
"is_reviewed": true
}
Response Example (default )
{
"message": "Internal server error."
}
Delete a Segment
Delete a Segment from memory. This will not delete a segment from a document.
A unique Segment identifier.
A status object.
Unexpected error
Response Example (200 OK)
{
"id": 46530,
"deleted": true
}
Response Example (default )
{
"message": "Internal server error."
}
Unaccept and unlock segments
Unaccept and unlock segments. Sets individual segments' "Review Done" to false. Confirmed segments will remain confirmed.
Example curl:
curl --X --request POST 'https://lilt.com/2/segments/review/unlock?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"segmentIds": [23921, 23922]
}'
segment ids to update
- documentIds: number[]
-
array of segment ids
-
number
Request Example
{
"documentIds": [
30032,
30125
]
}
array of updated segments
Response Example (200 OK)
[
"number"
]
Tag a Segment
Project tags for a segment. The source_tagged string contains one or more SGML tags. The target string is untagged. This endpoint will automatically place the source tags in the target.
Usage charges apply to this endpoint for production REST API keys.
The tagged source string.
The target string.
A unique Memory identifier.
A TaggedSegment object.
Unexpected error
Response Example (200 OK)
{
"source_tagged": "The <b>red bus.</b>",
"target_tagged": "Le <b>bus rouge.</b>"
}
Response Example (default )
{
"message": "Internal server error."
}
Settings
Update or create a setting
Create or update the value for the given setting and setting scope.
Example CURL to set an organization-level setting:
curl --location --request POST 'https://lilt.com/2/settings?key=<API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"settingName": "requireBatchQaTranslator",
"value": false,
"organizationId": 285,
"scope": "Organization"
}'
undefined
Request Example
{
"settingName": "requireBatchQaTranslator",
"scope": "Organization",
"value": "string | integer | object | boolean",
"isEnforced": "boolean",
"projectId": "number",
"organizationId": 123
}
Updated settings object and updated active settings.
Unexpected error
Response Example (200 OK)
{
"scopedSetting": {
"id": "integer (int32)",
"name": "string",
"valueType": "string",
"value": "string | integer | object | boolean",
"defaultValue": "string | integer | object | boolean",
"isUserFacing": "boolean",
"isDefault": "boolean"
},
"activeSettings": "object"
}
Response Example (default )
{
"message": "Internal server error."
}
Get organization-level settings
Get the organization-level settings for the active users organization
Example CURL:
curl --location --request GET 'https://lilt.com/2/settings/organization?key=<API_KEY>' \
Organization settings dictionary.
Unexpected error
Response Example (200 OK)
"object"
Response Example (default )
{
"message": "Internal server error."
}
Get settings for a project
Get the settings as applied to a specific project. Active settings will combine project-level settings, organization-level settings and fallback to setting default values.
Example CURL:
curl --location --request GET 'https://lilt.com/2/settings/project/123?key=<API_KEY>' \
A project id.
Project settings dictionary.
Unexpected error
Response Example (200 OK)
"object"
Response Example (default )
{
"message": "Internal server error."
}
Get settings for the authenticated user
Get the active settings applied to the authenticated user.
Example CURL:
curl --location --request GET 'https://lilt.com/2/settings/user?key=<API_KEY>' \
Settings dictionary.
Unexpected error
Response Example (200 OK)
"object"
Response Example (default )
{
"message": "Internal server error."
}
Translate
Translate a segment
Translate a source string.
Setting the rich parameter to true will change the response format to include additional information about each translation including a model score, word alignments, and formatting information. The rich format can be seen in the example response on this page.
By default, this endpoint also returns translation memory (TM) fuzzy matches, along with associated scores. Fuzzy matches always appear ahead of machine translation output in the response.
The source parameter may be supplied in the query or in the request body.
The maximum source length is 5,000 characters.
Usage charges apply to this endpoint for production REST API keys.
The source text to be translated.
- source: string
-
A unique Segment identifier.
A unique Memory identifier.
The source text to be translated.
A source hash code.
A target prefix.
Return top n translations (deprecated).
Returns rich translation information (e.g., with word alignments).
Include translation memory fuzzy matches.
Project tags. Projects tags in source to target if set to true.
Contains ICU data. If true then tags in the source following the ICU standard will be parsed and retained.
Request Example
{
"source": "string"
}
A TranslationList object.
When the ML model is loading.
Unexpected error
Response Example (200 OK)
{
"untokenizedSource": "Authentication not required.",
"tokenizedSource": "Authentication not required .",
"sourceDelimiters": [
"",
" ",
" ",
"",
""
],
"translation": [
[
{
"score": 3.4936864e-8,
"align": "0-0 1-1 2-2 3-3",
"targetDelimiters": [
"",
" ",
" ",
"",
""
],
"targetWords": [
"Authentifizierung",
"nicht",
"erforderlich",
"."
],
"target": "Authentifizierung nicht erforderlich .",
"targetWithTags": "Authentifizierung nicht erforderlich.",
"isTMMatch": false,
"provenance": "0 0 0 0"
}
]
]
}
Response Example (202 Accepted)
{
"untokenizedSource": "Authentication not required.",
"tokenizedSource": "Authentication not required .",
"sourceDelimiters": [
"",
" ",
" ",
"",
""
],
"translation": [
[
{
"score": 3.4936864e-8,
"align": "0-0 1-1 2-2 3-3",
"targetDelimiters": [
"",
" ",
" ",
"",
""
],
"targetWords": [
"Authentifizierung",
"nicht",
"erforderlich",
"."
],
"target": "Authentifizierung nicht erforderlich .",
"targetWithTags": "Authentifizierung nicht erforderlich.",
"isTMMatch": false,
"provenance": "0 0 0 0"
}
]
]
}
Response Example (default )
{
"message": "Internal server error."
}
Translate a segment
Translate a source string.
Setting the rich parameter to true will change the response format to include additional information about each translation including a model score, word alignments, and formatting information. The rich format can be seen in the example response on this page.
By default, this endpoint also returns translation memory (TM) fuzzy matches, along with associated scores. Fuzzy matches always appear ahead of machine translation output in the response.
The maximum source length is 5,000 characters.
Usage charges apply to this endpoint for production REST API keys.
- source: string
-
A unique Segment identifier.
- memory_id: integer
-
A unique Memory identifier.
- source_hash: integer
-
A source hash code.
- n: integer 1
-
Return top n translations (deprecated).
- prefix: string
-
A target prefix
- rich: boolean false
-
Returns rich translation information (e.g., with word alignments).
- tm_matches: boolean true
-
Include translation memory fuzzy matches.
- project_tags: boolean false
-
Project tags. Projects tags in source to target if set to true.
- containsICUData: boolean false
-
Contains ICU data. If true then tags in the source following the ICU standard will be parsed and retained.
Request Example
{
"source": "string",
"memory_id": "integer",
"source_hash": "integer",
"n": "integer",
"prefix": "string",
"rich": "boolean",
"tm_matches": "boolean",
"project_tags": "boolean",
"containsICUData": "boolean"
}
A TranslationList object.
Unexpected error
Response Example (200 OK)
{
"untokenizedSource": "Authentication not required.",
"tokenizedSource": "Authentication not required .",
"sourceDelimiters": [
"",
" ",
" ",
"",
""
],
"translation": [
[
{
"score": 3.4936864e-8,
"align": "0-0 1-1 2-2 3-3",
"targetDelimiters": [
"",
" ",
" ",
"",
""
],
"targetWords": [
"Authentifizierung",
"nicht",
"erforderlich",
"."
],
"target": "Authentifizierung nicht erforderlich .",
"targetWithTags": "Authentifizierung nicht erforderlich.",
"isTMMatch": false,
"provenance": "0 0 0 0"
}
]
]
}
Response Example (default )
{
"message": "Internal server error."
}
Register a segment
Register a source string for interactive translation. The source_hash value that is returned by this request is required by the prefix parameter for the translation endpoint. The maximum source length is 5,000 characters. Usage charges apply to this endpoint for production REST API keys.
A source string to be registered.
An ISO 639-1 language code.
An ISO 639-1 language code.
A status object.
Unexpected error
Response Example (200 OK)
{
"source_hash": 11476,
"num_words": 88
}
Response Example (default )
{
"message": "Internal server error."
}
Translate a File
Start machine translation of one or more Files that have previously been uploaded. The response will include an id parameter that can be used to monitor and download the translations in subsequent calls.
Example CURL:
curl --X --request POST 'https://lilt.com/2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true'
List of File ids to be translated, comma separated.
Id of Memory to use in translation.
An optional pararameter to specify an import configuration to be applied when extracting translatable content from this file.
An optional boolean parameter to toggle the use of Translation Memory in the translation of the file.
Translation info
Unexpected error
Response Example (200 OK)
{
"id": 1,
"fileId": "2,",
"status": "InProgress",
"createdAt": 1609357135
}
Response Example (default )
{
"message": "Internal server error."
}
Monitor file translation
Get information about the one or more Files that are being translated with machine translation. Query filters are optional but at least one must be provided.
Example CURL:
curl --X --request GET 'https://lilt.com/2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress'
List of translation ids, comma separated
One of the translation statuses - InProgress, Completed, Failed, ReadyForDownload
Results after this time (inclusive) will be returned, specified as seconds since the Unix epoch.
Results before this time (exclusive) will be returned, specified as seconds since the Unix epoch.
Translation info
Unexpected error
Response Example (200 OK)
{
"id": 1,
"fileId": "2,",
"status": "InProgress",
"createdAt": 1609357135
}
Response Example (default )
{
"Unsupported_file_type": {
"message": "Customer gave us garbage."
},
"File_extraction_error": {
"message": "Customer gave us garbage."
},
"No_translatable_content": {
"message": "Customer gave us an empty file."
},
"Batch_MT_initiation_failure": {
"message": "Something is wrong with MT."
},
"Batch_MT_response_failure": {
"message": "Something is wrong with MT."
},
"File_reassembly_error": {
"message": "We couldn't put the translated file back together.(okapi error)"
},
"Billing_error": {
"message": "We couldn't log the information about the MT to our billing system."
},
"Invalid_memory": {
"message": "Something is wrong with the memory."
},
"Storage_error": {
"message": "Error occurred interacting with file storage."
}
}
Download translated file
Download a translated File.
Example CURL:
curl --X --request GET 'https://lilt.com/2/translate/files?key=API_KEY&id=1'
A translation id.
A file.
Response Content-Types: application/octet-stream
Response Example (200 OK)
"string (byte)"
Schema Definitions
TranslationInfo: object
Information describing a batch translation process.
- id: integer
-
Unique identifier for this translation.
- fileId: integer
-
id of the File that is being translated.
- status: string
-
Status of the translation -
InProgress,ReadyForDownload,Completed,Failed. - createdAt: integer
-
Time when this translation was started, in seconds since the Unix epoch.
- errorMsg: string
-
Error message, present when status is
Failed.
Example
{
"id": 1,
"fileId": "2,",
"status": "InProgress",
"createdAt": 1609357135
}
Error: object
Response in the event of an unexpected error.
- message: object
-
A human-readable message describing the error.
Example
{
"message": "Internal server error."
}
BadRequest: object
Response in the event of a malformed request.
- message: object
-
A human-readable message describing the error.
Example
{
"message": "Bad Request."
}
MonitorFileTranslationTypeError: object
Monitor file translation can have different errors based on reasons explained in the examples.
Example
{
"Unsupported_file_type": {
"message": "Customer gave us garbage."
},
"File_extraction_error": {
"message": "Customer gave us garbage."
},
"No_translatable_content": {
"message": "Customer gave us an empty file."
},
"Batch_MT_initiation_failure": {
"message": "Something is wrong with MT."
},
"Batch_MT_response_failure": {
"message": "Something is wrong with MT."
},
"File_reassembly_error": {
"message": "We couldn't put the translated file back together.(okapi error)"
},
"Billing_error": {
"message": "We couldn't log the information about the MT to our billing system."
},
"Invalid_memory": {
"message": "Something is wrong with the memory."
},
"Storage_error": {
"message": "Error occurred interacting with file storage."
}
}
TranslateCompletionTypeError: object
Response in the event of a malformed error.
- message: object
-
A human-readable message describing the error.
Example
{
"message": "Some documents are already marked as complete for review. DocumentIds 22322, 23343"
}
ReviewCompletionTypeError: object
Response in the event of a malformed error.
- message: object
-
A human-readable message describing the error.
Example
{
"message": "Some documents' translation is not marked as complete. Complete translation before completing review. DocumentIds 22322, 23343"
}
Connector: object
A Connector is a Lilt managed api bridge between a content source and Lilt services.
- id: integer
- name: string
- schedule: string
- last_check: string
- healthy: boolean
- args: object
- created_at: string
- updated_at: string
Example
{
"id": "integer",
"name": "string",
"schedule": "string",
"last_check": "string",
"healthy": "boolean",
"args": "object",
"created_at": "string",
"updated_at": "string"
}
ConnectorJob: object
A ConnectorJob tracks the status of an import or export action.
- id: integer
- status: string
- args: object
- created_at: string
- updated_at: string
Example
{
"id": "integer",
"status": "string",
"args": "object",
"created_at": "string",
"updated_at": "string"
}
Job: object
A Job is a collection of multiple Projects. Each project is specific to a language pair, and is associated with exactly one Memory for that language pair. The Memory association cannot be changed after the Project is created.
- name: string
-
A name for the job.
- creationStatus: string
-
Status of job creation process that includes PENDING, COMPLETE, and FAILED.
- deliveredAt: string (date-time)
- status: string
-
Current status of job that includes archived, delivered, and active.
- due: string (date-time)
-
An ISO string date.
- id: integer
-
An id for the job.
- isProcessing: integer
-
Values include
1while in progress,0when idle and-2when processing failed. - stats: JobStats
-
Overview of job's statistical data.
Example
{
"name": "My New Job",
"creationStatus": "COMPLETE",
"deliveredAt": "2021-06-03T13:43:00.000Z",
"status": "active",
"due": "2021-06-03T13:43:00.000Z",
"id": 241,
"isProcessing": 0,
"stats": {
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": "en",
"srcLang": "en",
"srcLocale": "US",
"trgLang": "fr",
"trgLocale": "CA",
"name": "My new project",
"due": "2021-10-03T13:43:00.000Z",
"isComplete": false,
"isArchived": false,
"state": "inProgress",
"numSourceTokens": 2134,
"createdAt": "2021-04-01T13:43:00.000Z",
"updatedAt": "2021-06-03T13:43:00.000Z",
"isDeleted": false,
"memoryId": 2134,
"workflowStatus": "READY_TO_START",
"workflowName": "Translate > Review > Analyst Review"
}
],
"sourceWords": 0,
"uniqueLanguagePairs": 1,
"uniqueLinguists": 1,
"workflowStatus": "READY_TO_START"
}
}
JobStats: object
A job stats shows an overview of job's statistical data including total number of exact words, fuzzy words, language pairs, projects, etc.
- exactWords: integer
-
Total number of exact words.
- fuzzyWords: integer
-
Total number of fuzzy words.
- newWords: integer
-
Total number of fuzzy words.
- numDeliveredProjects: integer
-
Total number of delivered projects.
- numLanguagePairs: integer
-
Total number of delivered projects.
- numProjects: integer
-
Total number of projects.
- percentReviewed: integer
-
Overall percentage of documents reviewed.
- percentTranslated: integer
-
Overall percentage of documents translated.
- projects: JobProject
-
JobProject - sourceWords: integer
-
Total number of source words.
- uniqueLanguagePairs: integer
-
Number of unique language pairs.
- uniqueLinguists: integer
-
Number of unique linguists.
- workflowStatus: object READY_TO_START, IN_PROGRESS, DONE
-
The status of the Workflow for the current job.
Example
{
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": "en",
"srcLang": "en",
"srcLocale": "US",
"trgLang": "fr",
"trgLocale": "CA",
"name": "My new project",
"due": "2021-10-03T13:43:00.000Z",
"isComplete": false,
"isArchived": false,
"state": "inProgress",
"numSourceTokens": 2134,
"createdAt": "2021-04-01T13:43:00.000Z",
"updatedAt": "2021-06-03T13:43:00.000Z",
"isDeleted": false,
"memoryId": 2134,
"workflowStatus": "READY_TO_START",
"workflowName": "Translate > Review > Analyst Review"
}
],
"sourceWords": 0,
"uniqueLanguagePairs": 1,
"uniqueLinguists": 1,
"workflowStatus": "READY_TO_START"
}
JobLeverageStats: object
A job leverage stats object shows an overview of job's statistical data including total number of exact words, fuzzy words, and exact words for the job in total and for each project.
- sourceWords: integer
-
Total number of source words.
- exactWords: integer
-
Total number of exact words.
- fuzzyWords: integer
-
Total number of fuzzy words.
- newWords: integer
-
Total number of new words.
- projects: ProjectStats
-
ProjectStats
Example
{
"sourceWords": 0,
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"projects": [
{
"id": 1,
"sourceWords": 1000,
"exactWords": 800,
"fuzzyWords": 150,
"newWords": 50
}
]
}
ProjectStats: object
- id: integer
- sourceWords: integer
- exactWords: integer
- fuzzyWords: integer
- newWords: integer
Example
{
"id": 1,
"sourceWords": 1000,
"exactWords": 800,
"fuzzyWords": 150,
"newWords": 50
}
JobProject: object
A job project contains project statistical data that belongs to a specific job.
- id: integer
-
An id for the project.
- srcLang: string
-
Source language, an ISO 639-1 language identifier.
- srcLocale: string
-
A locale identifier, supported for source language.
- trgLang: string
-
Target language, an ISO 639-1 language identifier.
- trgLocale: string
-
A locale identifier, supported for target language.
- name: string
-
A name for the project.
- due: string
-
An ISO date.
- isComplete: boolean
-
A state that checks project was completed.
- isArchived: boolean
-
The archived state of the project.
- state: string
-
Current state of the project. Example, backlog, inProgress, inReview, done.
- numSourceTokens: integer
-
Total number of source tokens.
- createdAt: string
-
Time at which the object was created.
- updatedAt: string
-
Time at which the object was updated.
- isDeleted: boolean
-
A state that checks project was deleted.
- memoryId: integer
-
A unique number identifying the associated Memory.
- workflowStatus: object READY_TO_START, IN_PROGRESS, DONE
-
The status of the Workflow for the current project.
- workflowName: string
-
Human readable name of the workflow associated with the current project.
Example
{
"id": "en",
"srcLang": "en",
"srcLocale": "US",
"trgLang": "fr",
"trgLocale": "CA",
"name": "My new project",
"due": "2021-10-03T13:43:00.000Z",
"isComplete": false,
"isArchived": false,
"state": "inProgress",
"numSourceTokens": 2134,
"createdAt": "2021-04-01T13:43:00.000Z",
"updatedAt": "2021-06-03T13:43:00.000Z",
"isDeleted": false,
"memoryId": 2134,
"workflowStatus": "READY_TO_START",
"workflowName": "Translate > Review > Analyst Review"
}
LanguagePair: object
A language pair couples the source and target language along with memory and pre-translations settings associated to a project.
- srcLang: string
-
Source language, an ISO 639-1 language identifier.
- srcLocale: string
-
A locale identifier, supported for source language.
- trgLang: string
-
Target language, an ISO 639-1 language identifier.
- trgLocale: string
-
A locale identifier, supported for target language.
- dueDate: string
-
An ISO date.
- memoryId: integer
-
A unique number identifying the associated Memory.
- pretranslate: boolean
-
Attribute translation authorship of exact matches to the creator of the document being pretranslated.
- autoAccept: boolean
-
Accept and lock exact matches.
- caseSensitive: boolean
-
Use case sensitive translation memory matching.
- takeMatchAttribution: boolean
-
Use MT for unmatched segments.
- configId: integer
-
Configuration id
- workflowTemplateId: integer
-
Workflow Template id, to assign a specific Workflow to the project created out of this Language Pair. WorkflowTemplateIds can be retrieved via the /workflows/templates endpoint. If not specified then the Job level workflowTemplateId will be used.
- workflowStageAssignments: WorkflowStageAssignment
-
WorkflowStageAssignment
Example
{
"srcLang": "en",
"srcLocale": "US",
"trgLang": "de",
"trgLocale": "DE",
"dueDate": "2021-10-03T13:43:00.000Z",
"memoryId": 1241,
"pretranslate": "boolean",
"autoAccept": true,
"caseSensitive": "boolean",
"takeMatchAttribution": true,
"configId": 2332,
"workflowTemplateId": 14,
"workflowStageAssignments": [
{
"workflowStageTemplateId": 12345,
"userId": 123,
"email": "username@domain.com"
}
]
}
Project: object
A Project is a collection of zero or more Documents. It is specific to a language pair, and is associated with exactly one Memory for that language pair. The Memory association cannot be changed after the Project is created.
- id: integer
-
A unique number identifying the Project.
- memory_id: integer
-
A unique number identifying the associated Memory.
- job_id: integer
-
A unique number identifying the associated Job.
- srclang: string
-
An ISO 639-1 language identifier.
- trglang: string
-
An ISO 639-1 language identifier.
- srclocale: string
-
A locale identifier, supported for srclang.
- trglocale: string
-
A locale identifier, supported for trglang.
- name: string
-
A name for the project.
- state: string
-
The project's state. The possible states are
backlog,inProgress,inReview,inQA, anddone. - due_date: integer
-
The due date. Measured in seconds since the Unix epoch.
- archived: boolean
-
The archived state of the Project.
- metadata: object
-
A JSON object of key/value string pairs. Stores custom project information.
- sample_review_percentage: integer
-
The project's sample review percentage.
- created_at: integer
-
Time at which the object was created. Measured in seconds since the Unix epoch.
- updated_at: integer
-
Time at which the object was created. Measured in seconds since the Unix epoch.
- workflowStatus: object READY_TO_START, IN_PROGRESS, DONE
-
The status of the Workflow for the current project. This may not be present for all project endpoints even with workflows enabled.
- document: DocumentWithoutSegments
-
A list of Documents.
-
DocumentWithoutSegments
Example
{
"id": 448,
"memory_id": 1234,
"job_id": 1234,
"srclang": "en",
"trglang": "fr",
"srclocale": "US",
"trglocale": "FR",
"name": "My New Project",
"state": "backlog",
"due_date": 1489147692,
"archived": false,
"metadata": {
"connectorType": "github",
"notes": "example metadata"
},
"sample_review_percentage": 20,
"created_at": 1489147692,
"updated_at": 1489147692,
"workflowStatus": "READY_TO_START",
"document": [
{
"id": 46530,
"project_id": 287,
"srclang": "en",
"trglang": "de",
"name": "Introduction.xliff",
"import_in_progress": false,
"import_succeeded": false,
"import_error_message": "Could not parse XML.",
"export_in_progress": false,
"export_succeeded": false,
"export_error_message": "Could not parse XML.",
"is_pretranslating": false,
"status": {
"pretranslation": "idle"
},
"translator_email": "translator@example.com",
"reviewer_email": "reviewer@example.com",
"created_at": 1489147692,
"updated_at": 1489147692,
"is_review_complete": true
}
]
}
ProjectQuote: object
Quoting information for a Project.
- id: integer
-
A unique Project identifier.
- num_source_words: integer
-
The number of source words in the Project.
- num_words_new: integer
-
The number of new source words in the Project.
- num_segments_new: integer
-
The number of new segments in the Project.
- num_words_repetition: integer
-
The number of repetition source words in the Project.
- num_segments_repetition: integer
-
The number of repetition segments in the Project.
- bands: MatchBand
-
A list of MatchBand objects that represent translation memory leverage statistics.
-
MatchBand - documents: DocumentQuote
-
A list of DocumentQuote objects that quotes information for a Document.
-
DocumentQuote
Example
{
"id": 21902,
"num_source_words": 8000,
"num_words_new": 6039,
"num_segments_new": 151,
"num_words_repetition": 12,
"num_segments_repetition": 2980000,
"bands": [
{
"minimum_score": 94,
"maximum_score": 85,
"num_source_words": 151,
"num_segments": 12
}
],
"documents": [
{
"id": 21902,
"num_source_words": 8000,
"num_words_new": 6039,
"num_segments_new": 151,
"num_words_repetition": 12,
"num_segments_repetition": 2980000,
"bands": [
{
"minimum_score": 94,
"maximum_score": 85,
"num_source_words": 151,
"num_segments": 12
}
]
}
]
}
DocumentQuote: object
Quoting information for a Document.
- id: integer
-
A unique Document identifier.
- num_source_words: integer
-
The number of source words in the Document.
- num_words_new: integer
-
The number of new source words in the Document.
- num_segments_new: integer
-
The number of new segments in the Document.
- num_words_repetition: integer
-
The number of repetition source words in the Document.
- num_segments_repetition: integer
-
The number of repetition segments in the Document.
- bands: MatchBand
-
A list of MatchBand objects that represent translation memory leverage statistics.
-
MatchBand
Example
{
"id": 21902,
"num_source_words": 8000,
"num_words_new": 6039,
"num_segments_new": 151,
"num_words_repetition": 12,
"num_segments_repetition": 2980000,
"bands": [
{
"minimum_score": 94,
"maximum_score": 85,
"num_source_words": 151,
"num_segments": 12
}
]
}
MatchBand: object
A translation memory match band.
- minimum_score: integer
-
The minimum fuzzy match score.
- maximum_score: integer
-
The maximum fuzzy match score.
- num_source_words: integer
-
The number of source words in the band.
- num_segments: integer
-
The number of source segments in the band.
Example
{
"minimum_score": 94,
"maximum_score": 85,
"num_source_words": 151,
"num_segments": 12
}
ProjectStatus: object
The status of a Project.
- id: integer
-
A unique Project identifier.
- num_source_words: integer
-
The number of source words in the Project.
- num_words_confirmed: integer
-
The number of confirmed source words.
- num_words_reviewed: integer
-
The number of reviewed source words.
- time_elapsed: integer
-
The total time spent on the project by all resources. Measured in milliseconds.
- time_elapsed_translation: integer
-
The total time spent on translation by all resources. Measured in milliseconds.
- time_elapsed_research: integer
-
The total time spent on research by all resources. Measured in milliseconds.
- time_elapsed_review: integer
-
The total time spent on reviewing by all resources. Measured in milliseconds.
- updated_at: integer
-
The project update date and time. Measured in seconds.
- resources: ResourceStatus
-
A list of ResourceStatus objects that represent per-resource statistics.
-
ResourceStatus
Example
{
"id": 21902,
"num_source_words": 6039,
"num_words_confirmed": 151,
"num_words_reviewed": 12,
"time_elapsed": 2980000,
"time_elapsed_translation": 33487,
"time_elapsed_research": 912348,
"time_elapsed_review": 66521,
"updated_at": 1656513752,
"resources": [
{
"email": "joe.strummer@lilt.com",
"name": "Joe Strummer",
"num_words_confirmed": 151,
"num_words_new": 12,
"num_words_fuzzy": 24,
"num_words_exact": 56,
"num_words_reviewed": 182,
"time_elapsed": 1172000,
"time_elapsed_translation": 1172000,
"time_elapsed_research": 1172000,
"time_elapsed_review": 1172000,
"num_segments_confirmed": 25,
"num_segments_reviewed": 30
}
]
}
ResourceStatus: object
The status of a resource working on a Project.
- email: string
-
An email address.
- name: string
-
The full name.
- num_words_confirmed: integer
-
The number of source words confirmed.
- num_words_new: integer
-
The number of new source words confirmed.
- num_words_fuzzy: integer
-
The number of fuzzy match source words confirmed.
- num_words_exact: integer
-
The number of exact match source words confirmed.
- num_words_reviewed: integer
-
The number of source words reviewed.
- time_elapsed: integer
-
The total time spent on translation and research. Measured in milliseconds.
- time_elapsed_translation: integer
-
The total time spent translating. Measured in milliseconds.
- time_elapsed_research: integer
-
The total time spent on research. Measured in milliseconds.
- time_elapsed_review: integer
-
The total time spent reviewing. Measured in milliseconds.
- num_segments_confirmed: integer
-
The number of source segments confirmed.
- num_segments_reviewed: integer
-
The number of source segments reviewed.
Example
{
"email": "joe.strummer@lilt.com",
"name": "Joe Strummer",
"num_words_confirmed": 151,
"num_words_new": 12,
"num_words_fuzzy": 24,
"num_words_exact": 56,
"num_words_reviewed": 182,
"time_elapsed": 1172000,
"time_elapsed_translation": 1172000,
"time_elapsed_research": 1172000,
"time_elapsed_review": 1172000,
"num_segments_confirmed": 25,
"num_segments_reviewed": 30
}
SourceFile: object
A SourceFile is an unprocessed source file that can later be added to a project.
- id: integer
-
A unique number identifying the SourceFile.
- name: string
-
The file name.
- file_hash: string
-
A unique hash value associated with the file. An MD5 hash of the file content will be used by default.
- detected_lang: string
-
Language associated with the file.
- detected_lang_confidence: number
-
Confidence score for the language associated with the file.
- category: string
-
The category of the file. The options are
REFERENCE, orAPI. The default is API. Files with theREFERENCEcategory will be displayed as reference material. - labels: string[]
-
The list of labels associated with the file.
-
string - created_at: string (date-time)
-
Time at which the object was created.
- updated_at: string (date-time)
-
Time at which the object was created.
Example
{
"id": 46530,
"name": "en_US.json",
"file_hash": "3858f62230ac3c915f300c664312c63f",
"detected_lang": "de",
"detected_lang_confidence": 0.7,
"category": "REFERENCE",
"labels": [],
"created_at": "2019-10-16T22:12:34.000Z",
"updated_at": "2019-10-16T22:12:34.000Z"
}