LIlilt
Jobs

Create a Job

Changed on

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

Request

  • Base URL
    https://api.lilt.com
  • URL
    https://api.lilt.com/v2/jobs
  • Auth
    HTTP basic

Request body

namestring required

A name for the Job.

fileIdsinteger[] required

A list of file ids to upload to job creation.

duestring

An ISO string date representing job due date.

srcLangstring required

2-letter ISO source language code

srcLocalestring required

2-letter source language code

isPluralboolean

A boolean value representing if the files have plurals.

workflowTemplateIdinteger

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

domainIdinteger

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

requireQuotationApprovalboolean

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 request

{
  "name": "My new Job",
  "languagePairs": [
    {
      "trgLang": "de",
      "trgLocale": "DE",
      "dueDate": "2021-10-03T13:43:00.000Z",
      "memoryId": 1241,
      "externalModelId": 44,
      "autoAccept": true,
      "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,
  "domainId": 1,
  "requireQuotationApproval": true
}

Response

A Job object.

namestring

A name for the job.

creationStatusstring

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

deliveredAtstring date-time
statusstring

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

duestring date-time

An ISO string date.

idinteger

An id for the job.

isProcessinginteger

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

Example response

{
  "name": "My New Job",
  "creationStatus": "COMPLETE",
  "deliveredAt": "2021-06-03T13:43:00Z",
  "status": "active",
  "due": "2021-06-03T13:43:00Z",
  "id": 241,
  "stats": {
    "projects": [
      {
        "srcLang": "en",
        "srcLocale": "US",
        "trgLang": "fr",
        "trgLocale": "CA",
        "name": "My new project",
        "due": "2021-10-03T13:43:00.000Z",
        "state": "inProgress",
        "numSourceTokens": 2134,
        "createdAt": "2021-04-01T13:43:00.000Z",
        "updatedAt": "2021-06-03T13:43:00.000Z",
        "memoryId": 2134,
        "workflowStatus": "READY_TO_START",
        "workflowName": "Translate > Review > Analyst Review"
      }
    ],
    "uniqueLanguagePairs": 1,
    "uniqueLinguists": 1,
    "workflowStatus": "READY_TO_START"
  },
  "domains": [
    {
      "id": 12,
      "name": "Marketing"
    }
  ]
}

Changes

  • 99b66cc7808dRevision changes
    • breaking

      added required request body

    • info

      api operation id createJob was added

    • info

      added the non-success response with the status

    • info

      added the success response with the status