Create a Job
curl --request POST \
--url https://api.lilt.com/v2/jobs \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "My new Job",
"languagePairs": [
{
"trgLang": "de",
"memoryId": 1241,
"trgLocale": "DE",
"dueDate": "2021-10-03T13:43:00.000Z",
"externalModelId": 44,
"pretranslate": true,
"autoAccept": true,
"caseSensitive": true,
"takeMatchAttribution": true,
"configId": 2332,
"workflowTemplateId": 14,
"workflowTemplateName": 123,
"workflowStageAssignments": [
{
"workflowStageTemplateId": 12345,
"userId": 123,
"email": "username@domain.com"
}
]
}
],
"fileIds": [
298,
299
],
"srcLang": "en",
"srcLocale": "US",
"due": "2021-10-05T14:48:00.000Z",
"isPlural": true,
"workflowTemplateId": 123,
"domainId": 1,
"requireQuotationApproval": true
}
'import requests
url = "https://api.lilt.com/v2/jobs"
payload = {
"name": "My new Job",
"languagePairs": [
{
"trgLang": "de",
"memoryId": 1241,
"trgLocale": "DE",
"dueDate": "2021-10-03T13:43:00.000Z",
"externalModelId": 44,
"pretranslate": True,
"autoAccept": True,
"caseSensitive": True,
"takeMatchAttribution": True,
"configId": 2332,
"workflowTemplateId": 14,
"workflowTemplateName": 123,
"workflowStageAssignments": [
{
"workflowStageTemplateId": 12345,
"userId": 123,
"email": "username@domain.com"
}
]
}
],
"fileIds": [298, 299],
"srcLang": "en",
"srcLocale": "US",
"due": "2021-10-05T14:48:00.000Z",
"isPlural": True,
"workflowTemplateId": 123,
"domainId": 1,
"requireQuotationApproval": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'My new Job',
languagePairs: [
{
trgLang: 'de',
memoryId: 1241,
trgLocale: 'DE',
dueDate: '2021-10-03T13:43:00.000Z',
externalModelId: 44,
pretranslate: true,
autoAccept: true,
caseSensitive: true,
takeMatchAttribution: true,
configId: 2332,
workflowTemplateId: 14,
workflowTemplateName: 123,
workflowStageAssignments: [{workflowStageTemplateId: 12345, userId: 123, email: 'username@domain.com'}]
}
],
fileIds: [298, 299],
srcLang: 'en',
srcLocale: 'US',
due: '2021-10-05T14:48:00.000Z',
isPlural: true,
workflowTemplateId: 123,
domainId: 1,
requireQuotationApproval: true
})
};
fetch('https://api.lilt.com/v2/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lilt.com/v2/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'My new Job',
'languagePairs' => [
[
'trgLang' => 'de',
'memoryId' => 1241,
'trgLocale' => 'DE',
'dueDate' => '2021-10-03T13:43:00.000Z',
'externalModelId' => 44,
'pretranslate' => true,
'autoAccept' => true,
'caseSensitive' => true,
'takeMatchAttribution' => true,
'configId' => 2332,
'workflowTemplateId' => 14,
'workflowTemplateName' => 123,
'workflowStageAssignments' => [
[
'workflowStageTemplateId' => 12345,
'userId' => 123,
'email' => 'username@domain.com'
]
]
]
],
'fileIds' => [
298,
299
],
'srcLang' => 'en',
'srcLocale' => 'US',
'due' => '2021-10-05T14:48:00.000Z',
'isPlural' => true,
'workflowTemplateId' => 123,
'domainId' => 1,
'requireQuotationApproval' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.lilt.com/v2/jobs"
payload := strings.NewReader("{\n \"name\": \"My new Job\",\n \"languagePairs\": [\n {\n \"trgLang\": \"de\",\n \"memoryId\": 1241,\n \"trgLocale\": \"DE\",\n \"dueDate\": \"2021-10-03T13:43:00.000Z\",\n \"externalModelId\": 44,\n \"pretranslate\": true,\n \"autoAccept\": true,\n \"caseSensitive\": true,\n \"takeMatchAttribution\": true,\n \"configId\": 2332,\n \"workflowTemplateId\": 14,\n \"workflowTemplateName\": 123,\n \"workflowStageAssignments\": [\n {\n \"workflowStageTemplateId\": 12345,\n \"userId\": 123,\n \"email\": \"username@domain.com\"\n }\n ]\n }\n ],\n \"fileIds\": [\n 298,\n 299\n ],\n \"srcLang\": \"en\",\n \"srcLocale\": \"US\",\n \"due\": \"2021-10-05T14:48:00.000Z\",\n \"isPlural\": true,\n \"workflowTemplateId\": 123,\n \"domainId\": 1,\n \"requireQuotationApproval\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.lilt.com/v2/jobs")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My new Job\",\n \"languagePairs\": [\n {\n \"trgLang\": \"de\",\n \"memoryId\": 1241,\n \"trgLocale\": \"DE\",\n \"dueDate\": \"2021-10-03T13:43:00.000Z\",\n \"externalModelId\": 44,\n \"pretranslate\": true,\n \"autoAccept\": true,\n \"caseSensitive\": true,\n \"takeMatchAttribution\": true,\n \"configId\": 2332,\n \"workflowTemplateId\": 14,\n \"workflowTemplateName\": 123,\n \"workflowStageAssignments\": [\n {\n \"workflowStageTemplateId\": 12345,\n \"userId\": 123,\n \"email\": \"username@domain.com\"\n }\n ]\n }\n ],\n \"fileIds\": [\n 298,\n 299\n ],\n \"srcLang\": \"en\",\n \"srcLocale\": \"US\",\n \"due\": \"2021-10-05T14:48:00.000Z\",\n \"isPlural\": true,\n \"workflowTemplateId\": 123,\n \"domainId\": 1,\n \"requireQuotationApproval\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lilt.com/v2/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My new Job\",\n \"languagePairs\": [\n {\n \"trgLang\": \"de\",\n \"memoryId\": 1241,\n \"trgLocale\": \"DE\",\n \"dueDate\": \"2021-10-03T13:43:00.000Z\",\n \"externalModelId\": 44,\n \"pretranslate\": true,\n \"autoAccept\": true,\n \"caseSensitive\": true,\n \"takeMatchAttribution\": true,\n \"configId\": 2332,\n \"workflowTemplateId\": 14,\n \"workflowTemplateName\": 123,\n \"workflowStageAssignments\": [\n {\n \"workflowStageTemplateId\": 12345,\n \"userId\": 123,\n \"email\": \"username@domain.com\"\n }\n ]\n }\n ],\n \"fileIds\": [\n 298,\n 299\n ],\n \"srcLang\": \"en\",\n \"srcLocale\": \"US\",\n \"due\": \"2021-10-05T14:48:00.000Z\",\n \"isPlural\": true,\n \"workflowTemplateId\": 123,\n \"domainId\": 1,\n \"requireQuotationApproval\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "My New Job",
"creationStatus": "COMPLETE",
"deliveredAt": "2021-06-03T13:43:00Z",
"status": "active",
"due": "2021-06-03T13:43:00Z",
"id": 241,
"isProcessing": 0,
"stats": {
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": 123,
"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"
},
"domains": [
{
"id": 12,
"name": "Marketing"
}
]
}"<string>"{
"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://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" }
]
}'
POST
/
v2
/
jobs
Create a Job
curl --request POST \
--url https://api.lilt.com/v2/jobs \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "My new Job",
"languagePairs": [
{
"trgLang": "de",
"memoryId": 1241,
"trgLocale": "DE",
"dueDate": "2021-10-03T13:43:00.000Z",
"externalModelId": 44,
"pretranslate": true,
"autoAccept": true,
"caseSensitive": true,
"takeMatchAttribution": true,
"configId": 2332,
"workflowTemplateId": 14,
"workflowTemplateName": 123,
"workflowStageAssignments": [
{
"workflowStageTemplateId": 12345,
"userId": 123,
"email": "username@domain.com"
}
]
}
],
"fileIds": [
298,
299
],
"srcLang": "en",
"srcLocale": "US",
"due": "2021-10-05T14:48:00.000Z",
"isPlural": true,
"workflowTemplateId": 123,
"domainId": 1,
"requireQuotationApproval": true
}
'import requests
url = "https://api.lilt.com/v2/jobs"
payload = {
"name": "My new Job",
"languagePairs": [
{
"trgLang": "de",
"memoryId": 1241,
"trgLocale": "DE",
"dueDate": "2021-10-03T13:43:00.000Z",
"externalModelId": 44,
"pretranslate": True,
"autoAccept": True,
"caseSensitive": True,
"takeMatchAttribution": True,
"configId": 2332,
"workflowTemplateId": 14,
"workflowTemplateName": 123,
"workflowStageAssignments": [
{
"workflowStageTemplateId": 12345,
"userId": 123,
"email": "username@domain.com"
}
]
}
],
"fileIds": [298, 299],
"srcLang": "en",
"srcLocale": "US",
"due": "2021-10-05T14:48:00.000Z",
"isPlural": True,
"workflowTemplateId": 123,
"domainId": 1,
"requireQuotationApproval": True
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'My new Job',
languagePairs: [
{
trgLang: 'de',
memoryId: 1241,
trgLocale: 'DE',
dueDate: '2021-10-03T13:43:00.000Z',
externalModelId: 44,
pretranslate: true,
autoAccept: true,
caseSensitive: true,
takeMatchAttribution: true,
configId: 2332,
workflowTemplateId: 14,
workflowTemplateName: 123,
workflowStageAssignments: [{workflowStageTemplateId: 12345, userId: 123, email: 'username@domain.com'}]
}
],
fileIds: [298, 299],
srcLang: 'en',
srcLocale: 'US',
due: '2021-10-05T14:48:00.000Z',
isPlural: true,
workflowTemplateId: 123,
domainId: 1,
requireQuotationApproval: true
})
};
fetch('https://api.lilt.com/v2/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lilt.com/v2/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'My new Job',
'languagePairs' => [
[
'trgLang' => 'de',
'memoryId' => 1241,
'trgLocale' => 'DE',
'dueDate' => '2021-10-03T13:43:00.000Z',
'externalModelId' => 44,
'pretranslate' => true,
'autoAccept' => true,
'caseSensitive' => true,
'takeMatchAttribution' => true,
'configId' => 2332,
'workflowTemplateId' => 14,
'workflowTemplateName' => 123,
'workflowStageAssignments' => [
[
'workflowStageTemplateId' => 12345,
'userId' => 123,
'email' => 'username@domain.com'
]
]
]
],
'fileIds' => [
298,
299
],
'srcLang' => 'en',
'srcLocale' => 'US',
'due' => '2021-10-05T14:48:00.000Z',
'isPlural' => true,
'workflowTemplateId' => 123,
'domainId' => 1,
'requireQuotationApproval' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.lilt.com/v2/jobs"
payload := strings.NewReader("{\n \"name\": \"My new Job\",\n \"languagePairs\": [\n {\n \"trgLang\": \"de\",\n \"memoryId\": 1241,\n \"trgLocale\": \"DE\",\n \"dueDate\": \"2021-10-03T13:43:00.000Z\",\n \"externalModelId\": 44,\n \"pretranslate\": true,\n \"autoAccept\": true,\n \"caseSensitive\": true,\n \"takeMatchAttribution\": true,\n \"configId\": 2332,\n \"workflowTemplateId\": 14,\n \"workflowTemplateName\": 123,\n \"workflowStageAssignments\": [\n {\n \"workflowStageTemplateId\": 12345,\n \"userId\": 123,\n \"email\": \"username@domain.com\"\n }\n ]\n }\n ],\n \"fileIds\": [\n 298,\n 299\n ],\n \"srcLang\": \"en\",\n \"srcLocale\": \"US\",\n \"due\": \"2021-10-05T14:48:00.000Z\",\n \"isPlural\": true,\n \"workflowTemplateId\": 123,\n \"domainId\": 1,\n \"requireQuotationApproval\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.lilt.com/v2/jobs")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My new Job\",\n \"languagePairs\": [\n {\n \"trgLang\": \"de\",\n \"memoryId\": 1241,\n \"trgLocale\": \"DE\",\n \"dueDate\": \"2021-10-03T13:43:00.000Z\",\n \"externalModelId\": 44,\n \"pretranslate\": true,\n \"autoAccept\": true,\n \"caseSensitive\": true,\n \"takeMatchAttribution\": true,\n \"configId\": 2332,\n \"workflowTemplateId\": 14,\n \"workflowTemplateName\": 123,\n \"workflowStageAssignments\": [\n {\n \"workflowStageTemplateId\": 12345,\n \"userId\": 123,\n \"email\": \"username@domain.com\"\n }\n ]\n }\n ],\n \"fileIds\": [\n 298,\n 299\n ],\n \"srcLang\": \"en\",\n \"srcLocale\": \"US\",\n \"due\": \"2021-10-05T14:48:00.000Z\",\n \"isPlural\": true,\n \"workflowTemplateId\": 123,\n \"domainId\": 1,\n \"requireQuotationApproval\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lilt.com/v2/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My new Job\",\n \"languagePairs\": [\n {\n \"trgLang\": \"de\",\n \"memoryId\": 1241,\n \"trgLocale\": \"DE\",\n \"dueDate\": \"2021-10-03T13:43:00.000Z\",\n \"externalModelId\": 44,\n \"pretranslate\": true,\n \"autoAccept\": true,\n \"caseSensitive\": true,\n \"takeMatchAttribution\": true,\n \"configId\": 2332,\n \"workflowTemplateId\": 14,\n \"workflowTemplateName\": 123,\n \"workflowStageAssignments\": [\n {\n \"workflowStageTemplateId\": 12345,\n \"userId\": 123,\n \"email\": \"username@domain.com\"\n }\n ]\n }\n ],\n \"fileIds\": [\n 298,\n 299\n ],\n \"srcLang\": \"en\",\n \"srcLocale\": \"US\",\n \"due\": \"2021-10-05T14:48:00.000Z\",\n \"isPlural\": true,\n \"workflowTemplateId\": 123,\n \"domainId\": 1,\n \"requireQuotationApproval\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "My New Job",
"creationStatus": "COMPLETE",
"deliveredAt": "2021-06-03T13:43:00Z",
"status": "active",
"due": "2021-06-03T13:43:00Z",
"id": 241,
"isProcessing": 0,
"stats": {
"exactWords": 0,
"fuzzyWords": 0,
"newWords": 0,
"numDeliveredProjects": 0,
"numLanguagePairs": 0,
"numProjects": 0,
"percentReviewed": 0,
"percentTranslated": 0,
"projects": [
{
"id": 123,
"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"
},
"domains": [
{
"id": 12,
"name": "Marketing"
}
]
}"<string>"{
"message": "Internal server error."
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
The Job resource to create.
A name for the Job.
Example:
"My new Job"
Language pairs is a set of one or more pairs that includes source language, source locale(optional), target language, target locale(optional), and memoryId.
Show child attributes
Show child attributes
A list of file ids to upload to job creation.
Example:
[298, 299]
2-letter ISO source language code
Example:
"en"
2-letter source language code
Example:
"US"
An ISO string date representing job due date.
Example:
"2021-10-05T14:48:00.000Z"
A boolean value representing if the files have plurals.
Example:
true
ID of the workflow template to be used. Use the workflows templates endpoint to get the list of available workflows.
ID of the domain to be used. Use the domains endpoint to get the list of available domains.
Example:
1
When set to true, the Job enters AWAITING_QUOTE status after creation. Documents are created, but translation does not start and auto-assignment is suppressed until a quote is approved.
A PM creates a manual estimate, and the same user associated with the API key used to create the Job will receive the approval notification email and can approve or reject the quote. Alternatively, anyone in a Customer, Manager, or Admin role can approve or reject the quote.
Job status flow: Job created → Awaiting Quote → Awaiting Quote Approval → In Progress.
Example:
true
Response
A 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.
A name for the job.
Example:
"My New Job"
Status of job creation process that includes PENDING, COMPLETE, and FAILED.
Example:
"COMPLETE"
Example:
"2021-06-03T13:43:00Z"
Current status of job that includes archived, delivered, and active.
Example:
"active"
An ISO string date.
Example:
"2021-06-03T13:43:00Z"
An id for the job.
Example:
241
Values include 1 while in progress, 0 when idle and -2 when processing failed.
Example:
0
A job stats shows an overview of job's statistical data including total number of exact words, fuzzy words, language pairs, projects, etc.
Show child attributes
Show child attributes
Domains associated with this Job. Returned on the GET /v2/jobs/{jobId} response so callers can drive domain-specific behaviour (e.g. quality thresholds) without falling back to BigQuery.
Show child attributes
Show child attributes
Was this page helpful?