|
1 | 1 | openapi: 3.0.1
|
2 | 2 | info:
|
3 |
| - contact: |
4 |
| - email: support@lilt.com |
5 |
| - name: Lilt REST API Support |
6 |
| - url: https://developers.lilt.com/ |
7 |
| - description: | |
8 |
| - The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: |
9 |
| - * Training of and translating with interactive, adaptive machine translation |
10 |
| - * Large-scale translation memory |
11 |
| - * The Lexicon (a large-scale termbase) |
12 |
| - * Programmatic control of the Lilt CAT environment |
13 |
| - * Translation memory synchronization |
14 |
| -
|
15 |
| - Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. |
16 |
| -
|
17 |
| - ## Authentication |
18 |
| -
|
19 |
| - Requests are authenticated via REST API key, which requires the Business plan. |
20 |
| -
|
21 |
| - Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. |
22 |
| -
|
23 |
| - 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. |
24 |
| -
|
25 |
| - ## Quotas |
26 |
| -
|
27 |
| - 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. |
| 3 | + description: "Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals\ |
| 4 | + \ \nThe Lilt REST API enables programmatic access to the full-range of Lilt\ |
| 5 | + \ backend services including:\n * Training of and translating with interactive,\ |
| 6 | + \ adaptive machine translation\n * Large-scale translation memory\n * The Lexicon\ |
| 7 | + \ (a large-scale termbase)\n * Programmatic control of the Lilt CAT environment\n\ |
| 8 | + \ * Translation memory synchronization\n\nRequests and responses are in JSON\ |
| 9 | + \ format. The REST API only responds to HTTPS / SSL requests. \nThe base url for\ |
| 10 | + \ this REST API is `https://api.lilt.com/`.\n\n## Authentication\n\nRequests are\ |
| 11 | + \ authenticated via REST API key, which requires the Business plan.\n\nRequests\ |
| 12 | + \ are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication).\ |
| 13 | + \ Add your REST API key as both the `username` and `password`.\n\nFor development,\ |
| 14 | + \ you may also pass the REST API key via the `key` query parameter. This is less\ |
| 15 | + \ secure than HTTP Basic Auth, and is not recommended for production use.\n\n\ |
| 16 | + ## Quotas\n\nOur services have a general quota of 4000 requests per minute. Should\ |
| 17 | + \ you hit the maximum requests per minute, you will need to wait 60 seconds before\ |
| 18 | + \ you can send another request.\n" |
28 | 19 | title: Lilt REST API
|
29 | 20 | version: v3.0
|
30 | 21 | servers:
|
31 |
| -- url: https://api.lilt.com/ |
| 22 | +- url: https://api.lilt.com |
32 | 23 | security:
|
33 | 24 | - ApiKeyAuth: []
|
34 | 25 | - BasicAuth: []
|
@@ -658,8 +649,12 @@ paths:
|
658 | 649 | content:
|
659 | 650 | application/json:
|
660 | 651 | schema:
|
661 |
| - $ref: '#/components/schemas/TranslationInfo' |
662 |
| - description: Translation info |
| 652 | + description: List of TranslationInfo objects |
| 653 | + items: |
| 654 | + $ref: '#/components/schemas/TranslationInfo' |
| 655 | + title: monitorFileTranslationResponse |
| 656 | + type: array |
| 657 | + description: Translation Info |
663 | 658 | default:
|
664 | 659 | content:
|
665 | 660 | application/json:
|
@@ -720,8 +715,12 @@ paths:
|
720 | 715 | content:
|
721 | 716 | application/json:
|
722 | 717 | schema:
|
723 |
| - $ref: '#/components/schemas/TranslationInfo' |
724 |
| - description: Translation info |
| 718 | + description: List of TranslationInfo objects |
| 719 | + items: |
| 720 | + $ref: '#/components/schemas/TranslationInfo' |
| 721 | + title: batchTranslateFileResponse |
| 722 | + type: array |
| 723 | + description: Translation Info |
725 | 724 | default:
|
726 | 725 | content:
|
727 | 726 | application/json:
|
@@ -828,9 +827,7 @@ paths:
|
828 | 827 | content:
|
829 | 828 | application/json:
|
830 | 829 | schema:
|
831 |
| - items: |
832 |
| - $ref: '#/components/schemas/LiltCreateContent' |
833 |
| - type: array |
| 830 | + $ref: '#/components/schemas/getLiltCreateContentResponse' |
834 | 831 | description: An object with a documents next task Workflow metadata.
|
835 | 832 | summary: Get Lilt Create content
|
836 | 833 | tags:
|
@@ -2789,35 +2786,31 @@ components:
|
2789 | 2786 | description: |
|
2790 | 2787 | Content Parameters for LiltCreate.
|
2791 | 2788 | example:
|
2792 |
| - summary: summary |
2793 |
| - tone: tone |
2794 |
| - terms: terms |
| 2789 | + template: template |
| 2790 | + preferences: |
| 2791 | + styleguide: styleguide |
| 2792 | + tone: tone |
| 2793 | + templateParams: |
| 2794 | + summary: summary |
| 2795 | + contentLength: 0 |
| 2796 | + language: language |
| 2797 | + sections: sections |
2795 | 2798 | language: language
|
2796 |
| - memoryId: memoryId |
2797 |
| - sections: |
2798 |
| - - sections |
2799 |
| - - sections |
2800 | 2799 | properties:
|
2801 |
| - tone: |
2802 |
| - description: The tone of the content. |
2803 |
| - type: string |
2804 |
| - terms: |
2805 |
| - description: The terms of the content. |
2806 |
| - type: string |
2807 |
| - summary: |
2808 |
| - description: The summary of the content. |
2809 |
| - type: string |
2810 | 2800 | language:
|
2811 | 2801 | description: The language of the content.
|
2812 | 2802 | type: string
|
2813 |
| - memoryId: |
2814 |
| - description: The memory ID of the content. |
| 2803 | + template: |
| 2804 | + description: The template of the content. |
2815 | 2805 | type: string
|
2816 |
| - sections: |
2817 |
| - description: The sections of the content. |
2818 |
| - items: |
2819 |
| - type: string |
2820 |
| - type: array |
| 2806 | + templateParams: |
| 2807 | + $ref: '#/components/schemas/LiltCreateContent_templateParams' |
| 2808 | + preferences: |
| 2809 | + $ref: '#/components/schemas/LiltCreateContent_preferences' |
| 2810 | + required: |
| 2811 | + - language |
| 2812 | + - template |
| 2813 | + - templateParams |
2821 | 2814 | type: object
|
2822 | 2815 | JobProject:
|
2823 | 2816 | description: |
|
@@ -4016,6 +4009,37 @@ components:
|
4016 | 4009 | type: boolean
|
4017 | 4010 | title: signLiltCreateTermsResponse
|
4018 | 4011 | type: object
|
| 4012 | + getLiltCreateContentResponse: |
| 4013 | + example: |
| 4014 | + contents: |
| 4015 | + - template: template |
| 4016 | + preferences: |
| 4017 | + styleguide: styleguide |
| 4018 | + tone: tone |
| 4019 | + templateParams: |
| 4020 | + summary: summary |
| 4021 | + contentLength: 0 |
| 4022 | + language: language |
| 4023 | + sections: sections |
| 4024 | + language: language |
| 4025 | + - template: template |
| 4026 | + preferences: |
| 4027 | + styleguide: styleguide |
| 4028 | + tone: tone |
| 4029 | + templateParams: |
| 4030 | + summary: summary |
| 4031 | + contentLength: 0 |
| 4032 | + language: language |
| 4033 | + sections: sections |
| 4034 | + language: language |
| 4035 | + properties: |
| 4036 | + contents: |
| 4037 | + description: List of LiltCreateContent objects |
| 4038 | + items: |
| 4039 | + $ref: '#/components/schemas/LiltCreateContent' |
| 4040 | + type: array |
| 4041 | + title: getLiltCreateContentResponse |
| 4042 | + type: object |
4019 | 4043 | inline_response_200:
|
4020 | 4044 | example:
|
4021 | 4045 | id: 0
|
@@ -4266,6 +4290,42 @@ components:
|
4266 | 4290 | type: string
|
4267 | 4291 | title: AddFileLabelRequest
|
4268 | 4292 | type: object
|
| 4293 | + LiltCreateContent_templateParams: |
| 4294 | + description: The template parameters of the content. |
| 4295 | + example: |
| 4296 | + summary: summary |
| 4297 | + contentLength: 0 |
| 4298 | + language: language |
| 4299 | + sections: sections |
| 4300 | + properties: |
| 4301 | + contentLength: |
| 4302 | + description: The length of the content. |
| 4303 | + type: integer |
| 4304 | + language: |
| 4305 | + description: The language of the content. |
| 4306 | + type: string |
| 4307 | + sections: |
| 4308 | + description: The section of the content. |
| 4309 | + type: string |
| 4310 | + summary: |
| 4311 | + description: The summary of the content. |
| 4312 | + type: string |
| 4313 | + required: |
| 4314 | + - language |
| 4315 | + type: object |
| 4316 | + LiltCreateContent_preferences: |
| 4317 | + description: The preferences of the content. |
| 4318 | + example: |
| 4319 | + styleguide: styleguide |
| 4320 | + tone: tone |
| 4321 | + properties: |
| 4322 | + tone: |
| 4323 | + description: The tone of the content. |
| 4324 | + type: string |
| 4325 | + styleguide: |
| 4326 | + description: The styleguide of the content. |
| 4327 | + type: string |
| 4328 | + type: object |
4269 | 4329 | DocumentWithoutSegments_status:
|
4270 | 4330 | description: A list of translations for the query term.
|
4271 | 4331 | example:
|
|
0 commit comments