Lilt REST API (v3.0)

Get a list of supported languages.

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).

Update 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.

Delete a Memory.

Perform a translation memory query.

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://api.lilt.com/v2/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://api.lilt.com/v2/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

Exports the termbase entries for the given memory into a CSV file.

Calling this endpoint will begin the export process in the background. Check that the processing is complete by polling the GET /2/memories endpoint. When the is_processing value is 0 then call the POST /2/memories/termbase/download endpoint.

  curl -X POST https://api.lilt.com/v2/memories/termbase/export?key=API_KEY&id=ID

Downloads the termbase export for the given memory as a CSV file.

Ensure you first call the /2/memories/termbase/export endpoint to start the export process before you try to download it.

  curl -X GET https://api.lilt.com/v2/memories/termbase/download?key=API_KEY&id=ID

Delete a segment from a memory.

  curl -X DELETE https://api.lilt.com/v2/memories/segment?key=API_KEY&id=ID&segment_id=$SEGMENT_ID

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.

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 GET 'https://api.lilt.com/v2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress'

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 POST 'https://api.lilt.com/v2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true'

Download a translated File.

Example CURL:

curl -X GET 'https://api.lilt.com/v2/translate/files?key=API_KEY&id=1'

Lilt Create requires that the terms and conditions are signed first before using it. The terms and conditions can be signed by using this endpoint.

Example CURL:

curl -X POST 'https://api.lilt.com/v2/create/terms-and-conditions?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{"signedAgreement": true}'

Get a list of all content that has been generated by Lilt Create.

Example CURL:

curl -X GET 'https://api.lilt.com/v2/create?key=API_KEY'

Generate new Lilt Create content with the given parameters.

Example CURL:

curl -X POST 'https://api.lilt.com/v2/create?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "language":"en-US",
  "template":"blog-post",
  "templateParams":{
    "contentLength":"100",
    "language":"en-US",
    "sections":[],
    "summary":"a blog post about hiking"
    },
  "preferences":{"tone":"formal","styleguide":""}
}'

Get the stored preferences for Lilt Create.

Example CURL:

curl -X POST 'https://api.lilt.com/v2/create/preferences?key=API_KEY'

Update the stored preferences for Lilt Create.

Example CURL:

curl -X PUT
'https://api.lilt.com/v2/create/preferences?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{"tone": "formal", "styleguide": ""}'

Get Lilt Create content by ID.

Example CURL:

curl -X GET 'https://api.lilt.com/v2/create/1234?key=API_KEY'

Update a piece of Lilt Create content.

Example CURL:

curl -X PUT 'https://api.lilt.com/v2/create/1234?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{"language":"de-DE"}'

Delete a piece of Lilt Create content.

Example CURL:

curl -X DELETE 'https://api.lilt.com/v2/create/1234?key=API_KEY'

Regenerate the given piece of content with the current parameters.

Example CURL:

curl -X GET 'https://api.lilt.com/v2/create/1234/create?key=API_KEY'

Get all of 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: bash curl -X GET 'https://api.lilt.com/v2/workflows/templates?key=API_KEY'

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://api.lilt.com/v2/jobs?key=API_KEY&isArchived=false'

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://api.lilt.com/v2/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" }
    ]
}'

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://api.lilt.com/v2/jobs/{id}?key=API_KEY'

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://api.lilt.com/v2/jobs/{id}?key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "test job",
  "due": "2022-05-05T10:56:44.985Z"
}'

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://api.lilt.com/v2/jobs/{id}?key=API_KEY'

Get the TM leverage stats for the job (new/exact/fuzzy matches).

Example CURL command:

curl -X POST 'https://api.lilt.com/v2/jobs/{id}/stats?key=API_KEY'

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://api.lilt.com/v2/jobs/{id}/archive?key=API_KEY'

Set job to unarchived, the job will move to active status.

Example CURL command:

curl -X POST 'https://api.lilt.com/v2/jobs/{id}/unarchive?key=API_KEY'

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://api.lilt.com/v2/jobs/{id}/deliver?key=API_KEY'

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://api.lilt.com/v2/jobs/{id}/reactivate?key=API_KEY'

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://api.lilt.com/v2/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.