POST
/
v2
/
projects
Create a Project
curl --request POST \
  --url https://api.lilt.com/v2/projects \
  --header 'Content-Type: application/json' \
  --data '{
  "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,
  "is_plural": false,
  "require_batch_qa_translator": false,
  "enable_prompt_labeling": false,
  "job_type": "TRANSLATION",
  "additional_guidelines": "Provide consistent style across all chapters.",
  "is_enhanced_human_ai_optimized": false,
  "domainId": 234
}'
{
  "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,
  "archived": false,
  "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_in_progress": false,
      "import_succeeded": false,
      "import_error_message": "Could not parse XML.",
      "export_in_progress": false,
      "export_succeeded": false,
      "export_error_message": "Could not parse XML.",
      "is_pretranslating": false,
      "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
    }
  ]
}

Authorizations

​
key
string
query
required

Body

application/json

The Project resource to create.

​
name
string
required

A name for the Project.

Example:

"My new project"

​
memory_id
integer
required

The Memory to associate with this new Project.

Example:

1234

​
job_id
integer

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.

Example:

1234

​
due_date
integer

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

Example:

1489147692

​
metadata
object

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

Example:
{
  "connectorType": "github",
  "notes": "example metadata"
}
​
workflowTemplateId
integer

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.

Example:

14

​
workflow_template_name
string

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

Example:

"Translate > Review"

​
llm_provider
string

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

Example:

"neural"

​
external_model_id
integer

External model ID, if any. Must match the chosen llm_provider.

Example:

111

​
is_plural
boolean

Whether the documents in this project contain ICU plural forms.

Example:

false

​
require_batch_qa_translator
boolean

Whether to require batch QA from the translator side.

Example:

false

​
enable_prompt_labeling
boolean

Whether to enable prompt labeling for the project.

Example:

false

​
job_type
enum<string>

(Optional) A specialized job type for advanced features.

Available options:
TRANSLATION,
PROMPT_RESPONSE
​
additional_guidelines
string

(Optional) Additional instructions or guidelines.

Example:

"Provide consistent style across all chapters."

​
is_enhanced_human_ai_optimized
boolean

Whether the project is enhanced with AI optimization.

Example:

false

​
domainId
integer

A domain ID to categorize this project under.

Example:

234

Response

A Project object.

A Project is a collection of zero or more Documents. It 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.

​
id
integer

A unique number identifying the Project.

Example:

448

​
memory_id
integer

A unique number identifying the associated Memory.

Example:

1234

​
job_id
integer

A unique number identifying the associated Job.

Example:

1234

​
srclang
string

An ISO 639-1 language identifier.

Example:

"en"

​
trglang
string

An ISO 639-1 language identifier.

Example:

"fr"

​
srclocale
string

A locale identifier, supported for srclang.

Example:

"US"

​
trglocale
string

A locale identifier, supported for trglang.

Example:

"FR"

​
name
string

A name for the project.

Example:

"My New Project"

​
state
string

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

Example:

"backlog"

​
due_date
integer

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

Example:

1489147692

​
archived
boolean

The archived state of the Project.

Example:

false

​
metadata
object

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

Example:
{
  "connectorType": "github",
  "notes": "example metadata"
}
​
sample_review_percentage
integer

The project's sample review percentage.

Example:

20

​
created_at
integer

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

Example:

1489147692

​
updated_at
integer

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

Example:

1489147692

​
workflowStatus
enum<string>

The status of the Workflow for the current project. This may not be present for all project endpoints even with workflows enabled.

Available options:
READY_TO_START,
IN_PROGRESS,
DONE
Example:

"READY_TO_START"

​
document
object[]

A list of Documents.