Create a Project
curl --request POST \
--url https://api.lilt.com/v2/projects \
--header 'Authorization: Basic <encoded-value>' \
--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,
"additional_guidelines": "Provide consistent style across all chapters.",
"is_enhanced_human_ai_optimized": false,
"domainId": 234
}
'import requests
url = "https://api.lilt.com/v2/projects"
payload = {
"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,
"additional_guidelines": "Provide consistent style across all chapters.",
"is_enhanced_human_ai_optimized": False,
"domainId": 234
}
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 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,
additional_guidelines: 'Provide consistent style across all chapters.',
is_enhanced_human_ai_optimized: false,
domainId: 234
})
};
fetch('https://api.lilt.com/v2/projects', 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/projects",
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 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,
'additional_guidelines' => 'Provide consistent style across all chapters.',
'is_enhanced_human_ai_optimized' => false,
'domainId' => 234
]),
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/projects"
payload := strings.NewReader("{\n \"name\": \"My new project\",\n \"memory_id\": 1234,\n \"job_id\": 1234,\n \"due_date\": 1489147692,\n \"metadata\": {\n \"connectorType\": \"github\",\n \"notes\": \"example metadata\"\n },\n \"workflowTemplateId\": 14,\n \"workflow_template_name\": \"Translate > Review\",\n \"llm_provider\": \"neural\",\n \"external_model_id\": 111,\n \"is_plural\": false,\n \"require_batch_qa_translator\": false,\n \"enable_prompt_labeling\": false,\n \"additional_guidelines\": \"Provide consistent style across all chapters.\",\n \"is_enhanced_human_ai_optimized\": false,\n \"domainId\": 234\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/projects")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My new project\",\n \"memory_id\": 1234,\n \"job_id\": 1234,\n \"due_date\": 1489147692,\n \"metadata\": {\n \"connectorType\": \"github\",\n \"notes\": \"example metadata\"\n },\n \"workflowTemplateId\": 14,\n \"workflow_template_name\": \"Translate > Review\",\n \"llm_provider\": \"neural\",\n \"external_model_id\": 111,\n \"is_plural\": false,\n \"require_batch_qa_translator\": false,\n \"enable_prompt_labeling\": false,\n \"additional_guidelines\": \"Provide consistent style across all chapters.\",\n \"is_enhanced_human_ai_optimized\": false,\n \"domainId\": 234\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lilt.com/v2/projects")
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 project\",\n \"memory_id\": 1234,\n \"job_id\": 1234,\n \"due_date\": 1489147692,\n \"metadata\": {\n \"connectorType\": \"github\",\n \"notes\": \"example metadata\"\n },\n \"workflowTemplateId\": 14,\n \"workflow_template_name\": \"Translate > Review\",\n \"llm_provider\": \"neural\",\n \"external_model_id\": 111,\n \"is_plural\": false,\n \"require_batch_qa_translator\": false,\n \"enable_prompt_labeling\": false,\n \"additional_guidelines\": \"Provide consistent style across all chapters.\",\n \"is_enhanced_human_ai_optimized\": false,\n \"domainId\": 234\n}"
response = http.request(request)
puts response.read_body{
"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
}
]
}"<string>"{
"message": "Internal server error."
}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
Create a Project
curl --request POST \
--url https://api.lilt.com/v2/projects \
--header 'Authorization: Basic <encoded-value>' \
--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,
"additional_guidelines": "Provide consistent style across all chapters.",
"is_enhanced_human_ai_optimized": false,
"domainId": 234
}
'import requests
url = "https://api.lilt.com/v2/projects"
payload = {
"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,
"additional_guidelines": "Provide consistent style across all chapters.",
"is_enhanced_human_ai_optimized": False,
"domainId": 234
}
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 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,
additional_guidelines: 'Provide consistent style across all chapters.',
is_enhanced_human_ai_optimized: false,
domainId: 234
})
};
fetch('https://api.lilt.com/v2/projects', 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/projects",
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 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,
'additional_guidelines' => 'Provide consistent style across all chapters.',
'is_enhanced_human_ai_optimized' => false,
'domainId' => 234
]),
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/projects"
payload := strings.NewReader("{\n \"name\": \"My new project\",\n \"memory_id\": 1234,\n \"job_id\": 1234,\n \"due_date\": 1489147692,\n \"metadata\": {\n \"connectorType\": \"github\",\n \"notes\": \"example metadata\"\n },\n \"workflowTemplateId\": 14,\n \"workflow_template_name\": \"Translate > Review\",\n \"llm_provider\": \"neural\",\n \"external_model_id\": 111,\n \"is_plural\": false,\n \"require_batch_qa_translator\": false,\n \"enable_prompt_labeling\": false,\n \"additional_guidelines\": \"Provide consistent style across all chapters.\",\n \"is_enhanced_human_ai_optimized\": false,\n \"domainId\": 234\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/projects")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My new project\",\n \"memory_id\": 1234,\n \"job_id\": 1234,\n \"due_date\": 1489147692,\n \"metadata\": {\n \"connectorType\": \"github\",\n \"notes\": \"example metadata\"\n },\n \"workflowTemplateId\": 14,\n \"workflow_template_name\": \"Translate > Review\",\n \"llm_provider\": \"neural\",\n \"external_model_id\": 111,\n \"is_plural\": false,\n \"require_batch_qa_translator\": false,\n \"enable_prompt_labeling\": false,\n \"additional_guidelines\": \"Provide consistent style across all chapters.\",\n \"is_enhanced_human_ai_optimized\": false,\n \"domainId\": 234\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lilt.com/v2/projects")
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 project\",\n \"memory_id\": 1234,\n \"job_id\": 1234,\n \"due_date\": 1489147692,\n \"metadata\": {\n \"connectorType\": \"github\",\n \"notes\": \"example metadata\"\n },\n \"workflowTemplateId\": 14,\n \"workflow_template_name\": \"Translate > Review\",\n \"llm_provider\": \"neural\",\n \"external_model_id\": 111,\n \"is_plural\": false,\n \"require_batch_qa_translator\": false,\n \"enable_prompt_labeling\": false,\n \"additional_guidelines\": \"Provide consistent style across all chapters.\",\n \"is_enhanced_human_ai_optimized\": false,\n \"domainId\": 234\n}"
response = http.request(request)
puts response.read_body{
"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
}
]
}"<string>"{
"message": "Internal server error."
}Authorizations
BasicAuthApiKeyAuth
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
The Project resource to create.
A name for the Project.
Example:
"My new project"
The Memory to associate with this new Project.
Example:
1234
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
The due date. Measured in seconds since the Unix epoch.
Example:
1489147692
A JSON object of key/value string pairs. Stores custom project information.
Example:
{ "connectorType": "github", "notes": "example metadata" }
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
Name of the workflow for the project, if a workflowTemplateId is passed, this field will be ignored.
Example:
"Translate > Review"
The LLM provider to use for the project. Defaults to "neural".
Example:
"neural"
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.
Example:
111
Whether the documents in this project contain ICU plural forms.
Example:
false
Whether to require batch QA from the translator side.
Example:
false
Whether to enable prompt labeling for the project.
Example:
false
(Optional) A specialized job type for advanced features.
Available options:
TRANSLATION, PROMPT_RESPONSE (Optional) Additional instructions or guidelines.
Example:
"Provide consistent style across all chapters."
Whether the project is enhanced with AI optimization.
Example:
false
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.
A unique number identifying the Project.
Example:
448
A unique number identifying the associated Memory.
Example:
1234
A unique number identifying the associated Job.
Example:
1234
An ISO 639-1 language identifier.
Example:
"en"
An ISO 639-1 language identifier.
Example:
"fr"
A locale identifier, supported for srclang.
Example:
"US"
A locale identifier, supported for trglang.
Example:
"FR"
A name for the project.
Example:
"My New Project"
The project's state. The possible states are backlog, inProgress, inReview, inQA, and done.
Example:
"backlog"
The due date. Measured in seconds since the Unix epoch.
Example:
1489147692
The archived state of the Project.
Example:
false
A JSON object of key/value string pairs. Stores custom project information.
Example:
{ "connectorType": "github", "notes": "example metadata" }
The project's sample review percentage.
Example:
20
Time at which the object was created. Measured in seconds since the Unix epoch.
Example:
1489147692
Time at which the object was created. Measured in seconds since the Unix epoch.
Example:
1489147692
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"
A list of Documents.
Show child attributes
Show child attributes
Was this page helpful?