Skip to content

lilt/lilt-python

Repository files navigation

lilt-python

Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals
The Lilt REST API enables programmatic access to the full-range of Lilt backend services including:

  • Training of and translating with interactive, adaptive machine translation
  • Large-scale translation memory
  • The Lexicon (a large-scale termbase)
  • Programmatic control of the Lilt CAT environment
  • Translation memory synchronization

Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is https://api.lilt.com/.

Authentication

Requests are authenticated via REST API key, which requires the Business plan.

Requests are authenticated using HTTP Basic Auth. Add your REST API key as both the username and password.

For development, you may also pass the REST API key via the key query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use.

Quotas

Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v3.0
  • Package version: 0.5.2
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/lilt/lilt-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/lilt/lilt-python.git)

Then import the package:

import lilt

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import lilt

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import lilt
from lilt.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.lilt.com
# See configuration.py for a list of all supported configuration parameters.
configuration = lilt.Configuration(
    host = "https://api.lilt.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration = lilt.Configuration(
    host = "https://api.lilt.com",
    api_key = {
        'key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['key'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = lilt.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)


# Enter a context with an instance of the API client
with lilt.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lilt.CreateApi(api_client)
    content_id = 56 # int | The content ID.

    try:
        # Delete Lilt Create content
        api_response = api_instance.delete_lilt_create_content(content_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CreateApi->delete_lilt_create_content: %s\n" % e)
    

Documentation for API Endpoints

All URIs are relative to https://api.lilt.com

Class Method HTTP request Description
CreateApi delete_lilt_create_content DELETE /v2/create/{contentId} Delete Lilt Create content
CreateApi generate_lilt_create_content POST /v2/create Generate new Lilt Create content
CreateApi get_lilt_create_by_id GET /v2/create/{contentId} Get Lilt Create content by ID.
CreateApi get_lilt_create_content GET /v2/create Get Lilt Create content
CreateApi get_lilt_create_preferences GET /v2/create/preferences Get Lilt Create preferences
CreateApi regenerate_lilt_create_content GET /v2/create/{contentId}/create Regenerate Lilt Create content
CreateApi sign_lilt_create_terms POST /v2/create/terms-and-conditions Sign the Lilt Create terms and conditions
CreateApi update_lilt_create_content PUT /v2/create/{contentId} Update Lilt Create content
CreateApi update_lilt_create_preferences PUT /v2/create/preferences Update Lilt Create preferences
DocumentsApi download_document GET /v2/documents/files Download a Document
DocumentsApi upload_document POST /v2/documents/files Upload a File
FilesApi add_label POST /v2/files/labels Add Label to File
FilesApi delete_file DELETE /v2/files Delete a File
FilesApi download GET /v2/files/download Download file
FilesApi get_files GET /v2/files Retrieve a File
FilesApi remove_label DELETE /v2/files/labels Remove Label from File
FilesApi upload_file POST /v2/files Upload a File
JobsApi archive_job POST /v2/jobs/{jobId}/archive Archive a Job
JobsApi create_job POST /v2/jobs Create a Job
JobsApi delete_job DELETE /v2/jobs/{jobId} Delete a Job
JobsApi deliver_job POST /v2/jobs/{jobId}/deliver Deliver a Job
JobsApi download_job GET /v2/jobs/{jobId}/downlod Download a Job
JobsApi export_job GET /v2/jobs/{jobId}/export Export a Job
JobsApi get_job GET /v2/jobs/{jobId} Retrieve a Job
JobsApi get_job_leverage_stats POST /v2/jobs/{jobId}/stats Retrieve Job Leverage Stats
JobsApi reactivate_job POST /v2/jobs/{jobId}/reactivate Reactivate a Job
JobsApi retrieve_all_jobs GET /v2/jobs Retrieve all Jobs
JobsApi unarchive_job POST /v2/jobs/{jobId}/unarchive Unarchive a Job
JobsApi update_job PUT /v2/jobs/{jobId} Update a Job
LanguagesApi get_languages GET /v2/languages Retrieve supported languages
MemoriesApi create_memory POST /v2/memories Create a Memory
MemoriesApi delete_memory DELETE /v2/memories Delete a Memory
MemoriesApi delete_segment_from_memory DELETE /v2/memories/segment Delete a segment from a memory.
MemoriesApi download_termbase GET /v2/memories/termbase/download Termbase download for a Memory
MemoriesApi export_termbase POST /v2/memories/termbase/export Termbase export for a Memory
MemoriesApi get_memory GET /v2/memories Retrieve a Memory
MemoriesApi import_memory_file POST /v2/memories/import File import for a Memory
MemoriesApi query_memory GET /v2/memories/query Query a Memory
MemoriesApi update_memory PUT /v2/memories Update the name of a Memory
ProjectsApi create_project POST /v2/projects Create a Project
ProjectsApi delete_project DELETE /v2/projects Delete a Project
ProjectsApi get_projects GET /v2/projects Retrieve a Project
TranslateApi batch_translate_file POST /v2/translate/file Translate a File
TranslateApi download_file GET /v2/translate/files Download translated file
TranslateApi monitor_file_translation GET /v2/translate/file Monitor file translation
TranslateApi translate_segment_post POST /v2/translate Translate a segment
WorkflowsApi get_workflow_templates GET /v2/workflows/templates Retrieve workflow templates

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: key
  • Location: URL query string

BasicAuth

  • Type: HTTP basic authentication

Author