API bindings for the Lilt REST API.
All URIs are relative to https://lilt.com/2
Method | HTTP request | Description |
---|---|---|
create_project | POST /projects | Create a Project |
delete_project | DELETE /projects | Delete a Project |
deliver_projects_bulk | POST /projects/bulk-deliver | Deliver multiple projects apart from their jobs. |
get_project_report | GET /projects/quote | Retrieve Project report |
get_project_revision_report | GET /projects/{id}/revision | Retrieve Project revision report |
get_project_status | GET /projects/status | Retrieve Project status |
get_projects | GET /projects | Retrieve a Project |
trigger_auto_assignment | POST /autoAssignment | Auto Assignment |
update_projects_bulk | PUT /projects/bulk-update | Update multiple Projects with a single payload |
Project create_project(body)
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.
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) body = lilt.ProjectCreateParameters() # ProjectCreateParameters |
try:
# Create a Project
api_response = api_instance.create_project(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->create_project: %s\n" % e) ```
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) body = lilt.ProjectCreateParameters() # ProjectCreateParameters |
try:
# Create a Project
api_response = api_instance.create_project(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->create_project: %s\n" % e) ```
Name | Type | Description | Notes |
---|---|---|---|
body | ProjectCreateParameters |
| Status code | Description | Response headers | |————-|————-|——————| 200 | A Project object. | - | 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProjectDeleteResponse delete_project(id=id)
Delete a Project
Delete a Project.
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) id = 56 # int | A unique Project identifier. (optional)
try:
# Delete a Project
api_response = api_instance.delete_project(id=id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->delete_project: %s\n" % e) ```
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) id = 56 # int | A unique Project identifier. (optional)
try:
# Delete a Project
api_response = api_instance.delete_project(id=id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->delete_project: %s\n" % e) ```
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique Project identifier. | [optional] |
| Status code | Description | Response headers | |————-|————-|——————| 200 | A status object. | - | 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deliver_projects_bulk(body, workflow_enabled=workflow_enabled)
Deliver multiple projects apart from their jobs.
Deliver mulitple projects apart from their jobs.
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) body = lilt.ProjectsToDeliver() # ProjectsToDeliver | workflow_enabled = True # bool | Whether the project has or not workflows enabled. (not used) (optional)
try:
# Deliver multiple projects apart from their jobs.
api_instance.deliver_projects_bulk(body, workflow_enabled=workflow_enabled)
except ApiException as e:
print("Exception when calling ProjectsApi->deliver_projects_bulk: %s\n" % e) ```
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) body = lilt.ProjectsToDeliver() # ProjectsToDeliver | workflow_enabled = True # bool | Whether the project has or not workflows enabled. (not used) (optional)
try:
# Deliver multiple projects apart from their jobs.
api_instance.deliver_projects_bulk(body, workflow_enabled=workflow_enabled)
except ApiException as e:
print("Exception when calling ProjectsApi->deliver_projects_bulk: %s\n" % e) ```
Name | Type | Description | Notes |
---|---|---|---|
body | ProjectsToDeliver | ||
workflow_enabled | bool | Whether the project has or not workflows enabled. (not used) | [optional] |
void (empty response body)
| Status code | Description | Response headers | |————-|————-|——————| 200 | Empty response if succeed. | - | 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProjectQuote get_project_report(id)
Retrieve Project report
Get information about a project that can be used for quoting. This includes: * A translation memory leverage report * Word count * Segment count
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) id = 56 # int | A unique Project identifier.
try:
# Retrieve Project report
api_response = api_instance.get_project_report(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->get_project_report: %s\n" % e) ```
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) id = 56 # int | A unique Project identifier.
try:
# Retrieve Project report
api_response = api_instance.get_project_report(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->get_project_report: %s\n" % e) ```
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique Project identifier. |
| Status code | Description | Response headers | |————-|————-|——————| 200 | An object that represents a Project quote. | - | 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_project_revision_report(id)
Retrieve Project revision report
Get information about a project’s revision report. This includes: * Stats on accepted segments * reviewer details * Error rate
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) id = 56 # int | A unique Project identifier.
try:
# Retrieve Project revision report
api_instance.get_project_revision_report(id)
except ApiException as e:
print("Exception when calling ProjectsApi->get_project_revision_report: %s\n" % e) ```
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) id = 56 # int | A unique Project identifier.
try:
# Retrieve Project revision report
api_instance.get_project_revision_report(id)
except ApiException as e:
print("Exception when calling ProjectsApi->get_project_revision_report: %s\n" % e) ```
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique Project identifier. |
void (empty response body)
| Status code | Description | Response headers | |————-|————-|——————| 200 | A csv file containing revision report. | - | 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProjectStatus get_project_status(id)
Retrieve Project status
Retrieve the status of a Project.
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) id = 56 # int | A unique Project identifier.
try:
# Retrieve Project status
api_response = api_instance.get_project_status(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->get_project_status: %s\n" % e) ```
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) id = 56 # int | A unique Project identifier.
try:
# Retrieve Project status
api_response = api_instance.get_project_status(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->get_project_status: %s\n" % e) ```
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique Project identifier. |
| Status code | Description | Response headers | |————-|————-|——————| 200 | An object that represents a Project status report. | - | 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[Project] get_projects(id=id, srclang=srclang, trglang=trglang, from_time=from_time, to_time=to_time, state=state, archived=archived, connector_id=connector_id)
Retrieve a Project
Retrieves one or more projects, including the documents associated with each project. Retrieving a project is the most efficient way to retrieve a single project or a list of all available projects. To retrieve a specific project, specify the id
request parameter. To retrieve all projects, omit the id
request parameter. To limit the retrieved projects to those with a particular source language or target language, specify the corresponding ISO 639-1 language codes in the srclang
and trglang
request parameters, respectively.
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lilt.ProjectsApi(api_client)
id = 56 # int | A unique Project identifier. (optional)
srclang = ‘srclang_example’ # str | An ISO 639-1 language code. (optional)
trglang = ‘trglang_example’ # str | An ISO 639-1 language code. (optional)
from_time = 56 # int | Unix time stamp (epoch, in seconds) of Projects with created_at
greater than or equal to the value. (optional)
to_time = 56 # int | Unix time stamp (epoch, in seconds) of Projects with created_at
less than the value. (optional)
state = ‘state_example’ # str | A project state (backlog, inProgress, inReview, inQA, done). (optional)
archived = True # bool | A flag that toggles whether to include archived projects in the response (the default is true
). (optional)
connector_id = 56 # int | A unique Connector identifier. (optional)
try:
# Retrieve a Project
api_response = api_instance.get_projects(id=id, srclang=srclang, trglang=trglang, from_time=from_time, to_time=to_time, state=state, archived=archived, connector_id=connector_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->get_projects: %s\n" % e) ```
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lilt.ProjectsApi(api_client)
id = 56 # int | A unique Project identifier. (optional)
srclang = ‘srclang_example’ # str | An ISO 639-1 language code. (optional)
trglang = ‘trglang_example’ # str | An ISO 639-1 language code. (optional)
from_time = 56 # int | Unix time stamp (epoch, in seconds) of Projects with created_at
greater than or equal to the value. (optional)
to_time = 56 # int | Unix time stamp (epoch, in seconds) of Projects with created_at
less than the value. (optional)
state = ‘state_example’ # str | A project state (backlog, inProgress, inReview, inQA, done). (optional)
archived = True # bool | A flag that toggles whether to include archived projects in the response (the default is true
). (optional)
connector_id = 56 # int | A unique Connector identifier. (optional)
try:
# Retrieve a Project
api_response = api_instance.get_projects(id=id, srclang=srclang, trglang=trglang, from_time=from_time, to_time=to_time, state=state, archived=archived, connector_id=connector_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->get_projects: %s\n" % e) ```
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique Project identifier. | [optional] |
srclang | str | An ISO 639-1 language code. | [optional] |
trglang | str | An ISO 639-1 language code. | [optional] |
from_time | int | Unix time stamp (epoch, in seconds) of Projects with `created_at` greater than or equal to the value. | [optional] |
to_time | int | Unix time stamp (epoch, in seconds) of Projects with `created_at` less than the value. | [optional] |
state | str | A project state (backlog, inProgress, inReview, inQA, done). | [optional] |
archived | bool | A flag that toggles whether to include archived projects in the response (the default is `true`). | [optional] |
connector_id | int | A unique Connector identifier. | [optional] |
| Status code | Description | Response headers | |————-|————-|——————| 200 | A list of Project objects. | - | 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[AutoAssignmentResponse] trigger_auto_assignment(project_ids, body=body)
Auto Assignment
Trigger automatic assignment of linguists. Requires auto-assignment to be enabled as a setting on the origanization level.
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) project_ids = ‘project_ids_example’ # str | The comma separated list of project ids to auto-assign. Can be sent in the body as an alternative but if both are specified the query has precedence. body = lilt.AutoAssignmentParameters() # AutoAssignmentParameters | (optional)
try:
# Auto Assignment
api_response = api_instance.trigger_auto_assignment(project_ids, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->trigger_auto_assignment: %s\n" % e) ```
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) project_ids = ‘project_ids_example’ # str | The comma separated list of project ids to auto-assign. Can be sent in the body as an alternative but if both are specified the query has precedence. body = lilt.AutoAssignmentParameters() # AutoAssignmentParameters | (optional)
try:
# Auto Assignment
api_response = api_instance.trigger_auto_assignment(project_ids, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->trigger_auto_assignment: %s\n" % e) ```
Name | Type | Description | Notes |
---|---|---|---|
project_ids | str | The comma separated list of project ids to auto-assign. Can be sent in the body as an alternative but if both are specified the query has precedence. | |
body | AutoAssignmentParameters | [optional] |
| Status code | Description | Response headers | |————-|————-|——————| 200 | An auto assignment response. | - | 400 | Bad request. Possible causes include no permission to the projects and the auto-assignment setting not being enabled. | - | 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[Project] update_projects_bulk(body)
Update multiple Projects with a single payload
Update multiple Projects with a single payload.
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) body = lilt.ProjectsToUpdate() # ProjectsToUpdate |
try:
# Update multiple Projects with a single payload
api_response = api_instance.update_projects_bulk(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->update_projects_bulk: %s\n" % e) ```
configuration = lilt.Configuration( host = “https://lilt.com/2” )
configuration = lilt.Configuration( host = “https://lilt.com/2”, api_key = { ‘key’: ‘YOUR_API_KEY’ } )
configuration = lilt.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )
with lilt.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = lilt.ProjectsApi(api_client) body = lilt.ProjectsToUpdate() # ProjectsToUpdate |
try:
# Update multiple Projects with a single payload
api_response = api_instance.update_projects_bulk(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectsApi->update_projects_bulk: %s\n" % e) ```
Name | Type | Description | Notes |
---|---|---|---|
body | ProjectsToUpdate |
| Status code | Description | Response headers | |————-|————-|——————| 200 | The updated Project objects. | - | 0 | Unexpected error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]