v1

latestOpenAPI 3.0.3LILT Platform Terms and Conditions2026-07-26651658.7 KB

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.

post/v2/projects

Request body

namestring required

A name for the Project.

memory_idinteger required

The Memory to associate with this new Project.

job_idinteger

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_dateinteger

The due date. Measured in seconds since the Unix epoch.

metadataobject

A JSON object of key/value string pairs. Stores custom project information.

workflowTemplateIdinteger

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.

workflow_template_namestring

Name of the workflow for the project, if a workflowTemplateId is passed, this field will be ignored.

llm_providerstring

The LLM provider to use for the project. Defaults to "neural".

external_model_idinteger

An optional parameter to specify a third-party model ID to use for translation. This allows you to use external MT providers instead of Lilt's built-in MT system. Must match the chosen llm_provider.

is_pluralboolean

Whether the documents in this project contain ICU plural forms.

require_batch_qa_translatorboolean

Whether to require batch QA from the translator side.

enable_prompt_labelingboolean

Whether to enable prompt labeling for the project.

job_type'TRANSLATION' | 'PROMPT_RESPONSE'

(Optional) A specialized job type for advanced features.

additional_guidelinesstring

(Optional) Additional instructions or guidelines.

is_enhanced_human_ai_optimizedboolean

Whether the project is enhanced with AI optimization.

domainIdinteger

A domain ID to categorize this project under.

Example request

{
  "name": "My new project",
  "memory_id": 1234,
  "job_id": 1234,
  "due_date": 1489147692,
  "metadata": {
    "connectorType": "github",
    "notes": "example metadata"
  },
  "workflowTemplateId": 14,
  "workflow_template_name": "Translate > Review",
  "llm_provider": "neural",
  "external_model_id": 111,
  "additional_guidelines": "Provide consistent style across all chapters.",
  "domainId": 234
}

Response

A Project object.

idinteger

A unique number identifying the Project.

memory_idinteger

A unique number identifying the associated Memory.

job_idinteger

A unique number identifying the associated Job.

srclangstring

An ISO 639-1 language identifier.

trglangstring

An ISO 639-1 language identifier.

srclocalestring

A locale identifier, supported for srclang.

trglocalestring

A locale identifier, supported for trglang.

namestring

A name for the project.

statestring

The project's state. The possible states are backlog, inProgress, inReview, inQA, and done.

due_dateinteger

The due date. Measured in seconds since the Unix epoch.

archivedboolean

The archived state of the Project.

metadataobject

A JSON object of key/value string pairs. Stores custom project information.

sample_review_percentageinteger

The project's sample review percentage.

created_atinteger

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_atinteger

Time at which the object was created. Measured in seconds since the Unix epoch.

workflowStatus'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.

Example response

{
  "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,
  "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_error_message": "Could not parse XML.",
      "export_error_message": "Could not parse XML.",
      "status": {
        "pretranslation": "idle"
      },
      "translator_email": "translator@example.com",
      "reviewer_email": "reviewer@example.com",
      "customer_reviewer_email": "reviewer@example.com",
      "created_at": 1489147692,
      "updated_at": 1489147692,
      "is_review_complete": true
    }
  ]
}