POST
/
v2
/
jobs
Create a Job
curl --request POST \
  --url https://api.lilt.com/v2/jobs \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My new Job",
  "languagePairs": [
    {
      "trgLang": "de",
      "trgLocale": "DE",
      "dueDate": "2021-10-03T13:43:00.000Z",
      "memoryId": 1241,
      "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
  ],
  "due": "2021-10-05T14:48:00.000Z",
  "srcLang": "en",
  "srcLocale": "US",
  "isPlural": true,
  "workflowTemplateId": 123,
  "domainId": 1
}'
{
  "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"
  }
}

Authorizations

key
string
query
required

Body

application/json

The Job resource to create.

name
string
required

A name for the Job.

Example:

"My new Job"

languagePairs
object[]
required

Language pairs is a set of one or more pairs that includes source language, source locale(optional), target language, target locale(optional), and memoryId.

fileIds
integer[]
required

A list of file ids to upload to job creation.

Example:
[298, 299]
srcLang
string
required

2-letter ISO source language code

Example:

"en"

srcLocale
string
required

2-letter source language code

Example:

"US"

due
string

An ISO string date representing job due date.

Example:

"2021-10-05T14:48:00.000Z"

isPlural
boolean

A boolean value representing if the files have plurals.

Example:

true

workflowTemplateId
integer

ID of the workflow template to be used. Use the workflows templates endpoint to get the list of available workflows.

domainId
integer

ID of the domain to be used. Use the domains endpoint to get the list of available domains.

Example:

1

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.

name
string

A name for the job.

Example:

"My New Job"

creationStatus
string

Status of job creation process that includes PENDING, COMPLETE, and FAILED.

Example:

"COMPLETE"

deliveredAt
string<date-time>
Example:

"2021-06-03T13:43:00Z"

status
string

Current status of job that includes archived, delivered, and active.

Example:

"active"

due
string<date-time>

An ISO string date.

Example:

"2021-06-03T13:43:00Z"

id
integer

An id for the job.

Example:

241

isProcessing
integer

Values include 1 while in progress, 0 when idle and -2 when processing failed.

Example:

0

stats
object

A job stats shows an overview of job's statistical data including total number of exact words, fuzzy words, language pairs, projects, etc.