-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDeepL API.postman_collection.json
More file actions
1691 lines (1691 loc) · 84.8 KB
/
DeepL API.postman_collection.json
File metadata and controls
1691 lines (1691 loc) · 84.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"info": {
"_postman_id": "e9e2969d-d589-4d3d-9df6-cc514cf3ee5e",
"name": "DeepL API",
"description": "This is a Postman collection covering the DeepL API. For a more in depth look at how things work, check out the [official documentation](https://www.deepl.com/docs-api).\n\n### Getting started\n\nTo get started, [sign up for a developer account at deepl.com](https://www.deepl.com/pro-checkout/account?productId=1200&yearly=false&trial=false) and get your authentication key from [your account page](https://www.deepl.com/account/summary).\n\nFrom there, fork this `DeepL API` collection, and select the relevant `baseUrl` variable depending on you subscription (`https://api.deepl.com/v2` for **Pro**, `https://api-free.deepl.com/v2` for **Free**).\n\nIn the Authorization section of your forked collection, you will see the value `DeepL-Auth-Key [yourAuthKey]`. Change `[yourAuthKey]` for your own key and you're ready to go!\n\nWant to get even more involved? [Join the DeepL community on our Discord!](https://discord.gg/deepl)",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "10725074",
"_collection_link": "https://www.postman.com/deepl-api/deepl-api-developers/collection/8fu9jq9/deepl-api?action=share&source=collection_link&creator=10725074"
},
"item": [
{
"name": "usage",
"item": [
{
"name": "Check Usage and Limits",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/usage",
"host": [
"{{baseUrl}}"
],
"path": [
"usage"
]
},
"description": "Retrieve usage information within the current billing period together with the corresponding account limits. Usage is returned for:\n- translated characters\n- translated documents\n- translated documents, team totals (for team accounts only)\n\nCharacter usage includes both text and document translations, and is measured by the source text length in Unicode code points,\nso for example \"A\", \"Δ\", \"あ\", and \"深\" are each counted as a single character.\n\nDocument usage only includes document translations, and is measured in individual documents.\n\nDepending on the user account type, some usage types will be omitted.\nCharacter usage is only included for developer accounts.\nDocument usage is only included for non-developer accounts, and team-combined document usage is only included for non-developer team accounts.\n"
},
"response": [
{
"name": "The account's usage and limits.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/usage",
"host": [
"{{baseUrl}}"
],
"path": [
"usage"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"character_count\": \"<long>\",\n \"character_limit\": \"<long>\",\n \"document_limit\": \"<long>\",\n \"document_count\": \"<long>\",\n \"team_document_limit\": \"<long>\",\n \"team_document_count\": \"<long>\"\n}"
}
]
}
]
},
{
"name": "translate",
"item": [
{
"name": "Request Translation",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "text",
"value": "Hello, world!",
"description": "(Required) Text to be translated. Only UTF-8-encoded plain text is supported. The parameter may be specified multiple times and translations are returned in the same order as they are requested. Each of the parameter values may contain multiple sentences."
},
{
"key": "target_lang",
"value": "DE",
"description": "(Required) The language into which the text should be translated. Options currently available:\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English (unspecified variant for backward compatibility; please select `EN-GB` or `EN-US` instead)\n * `EN-GB` - English (British)\n * `EN-US` - English (American)\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokmål)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (unspecified variant for backward compatibility; please select `PT-BR` or `PT-PT` instead)\n * `PT-BR` - Portuguese (Brazilian)\n * `PT-PT` - Portuguese (all Portuguese varieties excluding Brazilian Portuguese)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese (simplified)\n"
},
{
"key": "source_lang",
"value": "",
"description": "Language of the text to be translated. Options currently available:\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokmål)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (all Portuguese varieties mixed)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese\n\nIf this parameter is omitted, the API will attempt to detect the language of the text and translate it.\n"
},
{
"key": "split_sentences",
"value": "1",
"description": "Sets whether the translation engine should first split the input into sentences. For text translations where\n`tag_handling` is not set to `html`, the default value is `1`, meaning the engine splits on punctuation and on newlines.\n\nFor text translations where `tag_handling=html`, the default value is `nonewlines`, meaning the engine splits on punctuation only, ignoring newlines.\n\nThe use of `nonewlines` as the default value for text translations where `tag_handling=html` is new behavior that was implemented in November 2022,\nwhen HTML handling was moved out of beta.\n\nPossible values are:\n\n * `0` - no splitting at all, whole input is treated as one sentence\n * `1` (default when `tag_handling` is not set to `html`) - splits on punctuation and on newlines\n * `nonewlines` (default when `tag_handling=html`) - splits on punctuation only, ignoring newlines\n\nFor applications that send one sentence per text parameter, we recommend setting `split_sentences` to `0`, in order to prevent the engine from splitting the sentence unintentionally.\n\n\nPlease note that newlines will split sentences when `split_sentences=1`. We recommend cleaning files so they don't contain breaking sentences or setting the parameter `split_sentences` to `nonewlines`.\n",
"disabled": true
},
{
"key": "preserve_formatting",
"value": "0",
"description": "Sets whether the translation engine should respect the original formatting, even if it would usually correct some aspects. Possible values are:\n * `0` (default)\n * `1`\n\nThe formatting aspects affected by this setting include:\n * Punctuation at the beginning and end of the sentence\n * Upper/lower case at the beginning of the sentence\n",
"disabled": true
},
{
"key": "formality",
"value": "default",
"description": "Sets whether the translated text should lean towards formal or informal language.\nThis feature currently only works for target languages\n`DE` (German),\n`FR` (French),\n`IT` (Italian),\n`ES` (Spanish),\n`NL` (Dutch),\n`PL` (Polish),\n`PT-PT`,\n`PT-BR` (Portuguese)\nand `RU` (Russian).\nSetting this parameter with a target language that does not support formality will fail,\nunless one of the `prefer_...` options are used.\nPossible options are:\n * `default` (default)\n * `more` - for a more formal language\n * `less` - for a more informal language\n * `prefer_more` - for a more formal language if available, otherwise fallback to default formality\n * `prefer_less` - for a more informal language if available, otherwise fallback to default formality\n",
"disabled": true
},
{
"key": "glossary_id",
"value": "<string>",
"description": "Specify the glossary to use for the translation. **Important:** This requires the `source_lang` parameter to be set and the language pair of the glossary has to match the language pair of the request.\n",
"disabled": true
},
{
"key": "tag_handling",
"value": "html",
"description": "Sets which kind of tags should be handled. Options currently available:\n * `xml`: Enable XML tag handling; see :apiDocsLink{section=\"xml\"}.\n * `html`: Enable HTML tag handling; see :apiDocsLink{section=\"html\"}.\n",
"disabled": true
},
{
"key": "non_splitting_tags",
"value": "<string>",
"description": "Comma-separated list of XML tags which never split sentences.\n\n\nFor some XML files, finding tags with textual content and splitting sentences using those tags won't yield the best results. The following example shows the engine splitting sentences on `par` tags and proceeding to translate the parts separately, resulting in an incorrect translation:\n * Example request:\n```\n<par>The firm said it had been </par><par> conducting an internal investigation.</par>\n```\n * Example response:\n```\n<par>Die Firma sagte, es sei eine gute Idee gewesen.</par><par> Durchführung einer internen Untersuchung.</par>\n```\n\n\nAs this can lead to bad translations, this type of structure should either be avoided, or the `non_splitting_tags` parameter should be set. The following example shows the same call, with the parameter set to `par`:\n * Example request:\n```\n<par>The firm said it had been </par><par> conducting an internal investigation.</par>\n```\n * Example response:\n```\n<par>Die Firma sagte, dass sie</par><par> eine interne Untersuchung durchgeführt</par><par> habe</par><par>.</par>\n```\n\n\nThis time, the sentence is translated as a whole. The XML tags are now considered markup and copied into the translated sentence. As the translation of the words \"had been\" has moved to another position in the German sentence, the two par tags are duplicated (which is expected here).\n",
"disabled": true
},
{
"key": "outline_detection",
"value": "0",
"description": "The automatic detection of the XML structure won't yield best results in all XML files. You can disable this automatic mechanism altogether by setting the `outline_detection` parameter to `0` and selecting the tags that should be considered structure tags. This will split sentences using the `splitting_tags` parameter.\n\n\nIn the example below, we achieve the same results as the automatic engine by disabling automatic detection with `outline_detection=0` and setting the parameters manually to `tag_handling=xml`, `split_sentences=nonewlines`, and `splitting_tags=par,title`.\n * Example request:\n ```\n <document>\n <meta>\n <title>A document's title</title>\n </meta>\n <content>\n <par>This is the first sentence. Followed by a second one.</par>\n <par>This is the third sentence.</par>\n </content>\n </document>\n ```\n * Example response:\n ```\n <document>\n <meta>\n <title>Der Titel eines Dokuments</title>\n </meta>\n <content>\n <par>Das ist der erste Satz. Gefolgt von einem zweiten.</par>\n <par>Dies ist der dritte Satz.</par>\n </content>\n </document>\n ```\nWhile this approach is slightly more complicated, it allows for greater control over the structure of the translation output.\n",
"disabled": true
},
{
"key": "splitting_tags",
"value": "<string>",
"description": "Comma-separated list of XML tags which always cause splits.\n\n\nSee the example in the `outline_detection` parameter's description.\n",
"disabled": true
},
{
"key": "ignore_tags",
"value": "<string>",
"description": "Comma-separated list of XML tags that indicate text not to be translated.\n\n\nUse this paramter to ensure that elements in the original text are not altered in the translation (e.g., trademarks, product names) and insert tags into your original text. In the following example, the `ignore_tags` parameter is set to `keep`:\n * Example request:\n ```\n Please open the page <keep>Settings</keep> to configure your system.\n ```\n * Example response:\n ```\n Bitte öffnen Sie die Seite <keep>Settings</keep> um Ihr System zu konfigurieren.\n ```\n",
"disabled": true
}
]
},
"url": {
"raw": "{{baseUrl}}/translate",
"host": [
"{{baseUrl}}"
],
"path": [
"translate"
]
},
"description": "The translate function.\n\nThe total request body size must not exceed 128 KiB (128 · 1024 bytes). Please split up your text into multiple \ncalls if it exceeds this limit."
},
"response": [
{
"name": "The translate function returns a JSON representation of the translations in the order the text parameters have been specified.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "text",
"value": "Hello, world!",
"description": "(Required) Text to be translated. Only UTF-8-encoded plain text is supported. The parameter may be specified multiple times and translations are returned in the same order as they are requested. Each of the parameter values may contain multiple sentences."
},
{
"key": "target_lang",
"value": "DE",
"description": "(Required) The language into which the text should be translated. Options currently available:\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English (unspecified variant for backward compatibility; please select `EN-GB` or `EN-US` instead)\n * `EN-GB` - English (British)\n * `EN-US` - English (American)\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokmål)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (unspecified variant for backward compatibility; please select `PT-BR` or `PT-PT` instead)\n * `PT-BR` - Portuguese (Brazilian)\n * `PT-PT` - Portuguese (all Portuguese varieties excluding Brazilian Portuguese)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese (simplified)\n"
},
{
"key": "source_lang",
"value": "",
"description": "Language of the text to be translated. Options currently available:\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokmål)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (all Portuguese varieties mixed)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese\n\nIf this parameter is omitted, the API will attempt to detect the language of the text and translate it.\n"
},
{
"key": "split_sentences",
"value": "1",
"description": "Sets whether the translation engine should first split the input into sentences. For text translations where\n`tag_handling` is not set to `html`, the default value is `1`, meaning the engine splits on punctuation and on newlines.\n\nFor text translations where `tag_handling=html`, the default value is `nonewlines`, meaning the engine splits on punctuation only, ignoring newlines.\n\nThe use of `nonewlines` as the default value for text translations where `tag_handling=html` is new behavior that was implemented in November 2022,\nwhen HTML handling was moved out of beta.\n\nPossible values are:\n\n * `0` - no splitting at all, whole input is treated as one sentence\n * `1` (default when `tag_handling` is not set to `html`) - splits on punctuation and on newlines\n * `nonewlines` (default when `tag_handling=html`) - splits on punctuation only, ignoring newlines\n\nFor applications that send one sentence per text parameter, we recommend setting `split_sentences` to `0`, in order to prevent the engine from splitting the sentence unintentionally.\n\n\nPlease note that newlines will split sentences when `split_sentences=1`. We recommend cleaning files so they don't contain breaking sentences or setting the parameter `split_sentences` to `nonewlines`.\n",
"disabled": true
},
{
"key": "preserve_formatting",
"value": "0",
"description": "Sets whether the translation engine should respect the original formatting, even if it would usually correct some aspects. Possible values are:\n * `0` (default)\n * `1`\n\nThe formatting aspects affected by this setting include:\n * Punctuation at the beginning and end of the sentence\n * Upper/lower case at the beginning of the sentence\n",
"disabled": true
},
{
"key": "formality",
"value": "default",
"description": "Sets whether the translated text should lean towards formal or informal language.\nThis feature currently only works for target languages\n`DE` (German),\n`FR` (French),\n`IT` (Italian),\n`ES` (Spanish),\n`NL` (Dutch),\n`PL` (Polish),\n`PT-PT`,\n`PT-BR` (Portuguese)\nand `RU` (Russian).\nSetting this parameter with a target language that does not support formality will fail,\nunless one of the `prefer_...` options are used.\nPossible options are:\n * `default` (default)\n * `more` - for a more formal language\n * `less` - for a more informal language\n * `prefer_more` - for a more formal language if available, otherwise fallback to default formality\n * `prefer_less` - for a more informal language if available, otherwise fallback to default formality\n",
"disabled": true
},
{
"key": "glossary_id",
"value": "<string>",
"description": "Specify the glossary to use for the translation. **Important:** This requires the `source_lang` parameter to be set and the language pair of the glossary has to match the language pair of the request.\n",
"disabled": true
},
{
"key": "tag_handling",
"value": "html",
"description": "Sets which kind of tags should be handled. Options currently available:\n * `xml`: Enable XML tag handling; see :apiDocsLink{section=\"xml\"}.\n * `html`: Enable HTML tag handling; see :apiDocsLink{section=\"html\"}.\n",
"disabled": true
},
{
"key": "non_splitting_tags",
"value": "<string>",
"description": "Comma-separated list of XML tags which never split sentences.\n\n\nFor some XML files, finding tags with textual content and splitting sentences using those tags won't yield the best results. The following example shows the engine splitting sentences on `par` tags and proceeding to translate the parts separately, resulting in an incorrect translation:\n * Example request:\n```\n<par>The firm said it had been </par><par> conducting an internal investigation.</par>\n```\n * Example response:\n```\n<par>Die Firma sagte, es sei eine gute Idee gewesen.</par><par> Durchführung einer internen Untersuchung.</par>\n```\n\n\nAs this can lead to bad translations, this type of structure should either be avoided, or the `non_splitting_tags` parameter should be set. The following example shows the same call, with the parameter set to `par`:\n * Example request:\n```\n<par>The firm said it had been </par><par> conducting an internal investigation.</par>\n```\n * Example response:\n```\n<par>Die Firma sagte, dass sie</par><par> eine interne Untersuchung durchgeführt</par><par> habe</par><par>.</par>\n```\n\n\nThis time, the sentence is translated as a whole. The XML tags are now considered markup and copied into the translated sentence. As the translation of the words \"had been\" has moved to another position in the German sentence, the two par tags are duplicated (which is expected here).\n",
"disabled": true
},
{
"key": "outline_detection",
"value": "0",
"description": "The automatic detection of the XML structure won't yield best results in all XML files. You can disable this automatic mechanism altogether by setting the `outline_detection` parameter to `0` and selecting the tags that should be considered structure tags. This will split sentences using the `splitting_tags` parameter.\n\n\nIn the example below, we achieve the same results as the automatic engine by disabling automatic detection with `outline_detection=0` and setting the parameters manually to `tag_handling=xml`, `split_sentences=nonewlines`, and `splitting_tags=par,title`.\n * Example request:\n ```\n <document>\n <meta>\n <title>A document's title</title>\n </meta>\n <content>\n <par>This is the first sentence. Followed by a second one.</par>\n <par>This is the third sentence.</par>\n </content>\n </document>\n ```\n * Example response:\n ```\n <document>\n <meta>\n <title>Der Titel eines Dokuments</title>\n </meta>\n <content>\n <par>Das ist der erste Satz. Gefolgt von einem zweiten.</par>\n <par>Dies ist der dritte Satz.</par>\n </content>\n </document>\n ```\nWhile this approach is slightly more complicated, it allows for greater control over the structure of the translation output.\n",
"disabled": true
},
{
"key": "splitting_tags",
"value": "<string>",
"description": "Comma-separated list of XML tags which always cause splits.\n\n\nSee the example in the `outline_detection` parameter's description.\n",
"disabled": true
},
{
"key": "ignore_tags",
"value": "<string>",
"description": "Comma-separated list of XML tags that indicate text not to be translated.\n\n\nUse this paramter to ensure that elements in the original text are not altered in the translation (e.g., trademarks, product names) and insert tags into your original text. In the following example, the `ignore_tags` parameter is set to `keep`:\n * Example request:\n ```\n Please open the page <keep>Settings</keep> to configure your system.\n ```\n * Example response:\n ```\n Bitte öffnen Sie die Seite <keep>Settings</keep> um Ihr System zu konfigurieren.\n ```\n",
"disabled": true
}
]
},
"url": {
"raw": "{{baseUrl}}/translate",
"host": [
"{{baseUrl}}"
],
"path": [
"translate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"type": "text"
}
],
"cookie": [],
"body": "{\n \"translations\": [\n {\n \"detected_source_language\": \"NB\",\n \"text\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Context parameter example",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "text",
"value": "Hello, world!",
"description": "(Required) Text to be translated. Only UTF-8-encoded plain text is supported. The parameter may be specified multiple times and translations are returned in the same order as they are requested. Each of the parameter values may contain multiple sentences."
},
{
"key": "target_lang",
"value": "FR",
"description": "(Required) The language into which the text should be translated. Options currently available:\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English (unspecified variant for backward compatibility; please select `EN-GB` or `EN-US` instead)\n * `EN-GB` - English (British)\n * `EN-US` - English (American)\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokmål)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (unspecified variant for backward compatibility; please select `PT-BR` or `PT-PT` instead)\n * `PT-BR` - Portuguese (Brazilian)\n * `PT-PT` - Portuguese (all Portuguese varieties excluding Brazilian Portuguese)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese (simplified)\n"
},
{
"key": "source_lang",
"value": "EN",
"description": "Language of the text to be translated. Options currently available:\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokmål)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (all Portuguese varieties mixed)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese\n\nIf this parameter is omitted, the API will attempt to detect the language of the text and translate it.\n"
},
{
"key": "context",
"value": "This is a classic programming example saying hello to the earth",
"description": "Try enabling and disabling this paramater to see how additional context can benefit translation accuracy",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/translate",
"host": [
"{{baseUrl}}"
],
"path": [
"translate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"type": "text"
}
],
"cookie": [],
"body": "{\n \"translations\": [\n {\n \"detected_source_language\": \"NB\",\n \"text\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Ignore tags example",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "text",
"value": "Please translate everything in this sentence <do_not_translate>except for this content</do_not_translate>",
"description": "(Required) Text to be translated. Only UTF-8-encoded plain text is supported. The parameter may be specified multiple times and translations are returned in the same order as they are requested. Each of the parameter values may contain multiple sentences."
},
{
"key": "target_lang",
"value": "DE",
"description": "(Required) The language into which the text should be translated. Options currently available:\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English (unspecified variant for backward compatibility; please select `EN-GB` or `EN-US` instead)\n * `EN-GB` - English (British)\n * `EN-US` - English (American)\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokmål)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (unspecified variant for backward compatibility; please select `PT-BR` or `PT-PT` instead)\n * `PT-BR` - Portuguese (Brazilian)\n * `PT-PT` - Portuguese (all Portuguese varieties excluding Brazilian Portuguese)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese (simplified)\n"
},
{
"key": "source_lang",
"value": "",
"description": "Language of the text to be translated. Options currently available:\n * `BG` - Bulgarian\n * `CS` - Czech\n * `DA` - Danish\n * `DE` - German\n * `EL` - Greek\n * `EN` - English\n * `ES` - Spanish\n * `ET` - Estonian\n * `FI` - Finnish\n * `FR` - French\n * `HU` - Hungarian\n * `ID` - Indonesian\n * `IT` - Italian\n * `JA` - Japanese\n * `KO` - Korean\n * `LT` - Lithuanian\n * `LV` - Latvian\n * `NB` - Norwegian (Bokmål)\n * `NL` - Dutch\n * `PL` - Polish\n * `PT` - Portuguese (all Portuguese varieties mixed)\n * `RO` - Romanian\n * `RU` - Russian\n * `SK` - Slovak\n * `SL` - Slovenian\n * `SV` - Swedish\n * `TR` - Turkish\n * `UK` - Ukrainian\n * `ZH` - Chinese\n\nIf this parameter is omitted, the API will attempt to detect the language of the text and translate it.\n",
"disabled": true
},
{
"key": "split_sentences",
"value": "1",
"description": "Sets whether the translation engine should first split the input into sentences. For text translations where\n`tag_handling` is not set to `html`, the default value is `1`, meaning the engine splits on punctuation and on newlines.\n\nFor text translations where `tag_handling=html`, the default value is `nonewlines`, meaning the engine splits on punctuation only, ignoring newlines.\n\nThe use of `nonewlines` as the default value for text translations where `tag_handling=html` is new behavior that was implemented in November 2022,\nwhen HTML handling was moved out of beta.\n\nPossible values are:\n\n * `0` - no splitting at all, whole input is treated as one sentence\n * `1` (default when `tag_handling` is not set to `html`) - splits on punctuation and on newlines\n * `nonewlines` (default when `tag_handling=html`) - splits on punctuation only, ignoring newlines\n\nFor applications that send one sentence per text parameter, we recommend setting `split_sentences` to `0`, in order to prevent the engine from splitting the sentence unintentionally.\n\n\nPlease note that newlines will split sentences when `split_sentences=1`. We recommend cleaning files so they don't contain breaking sentences or setting the parameter `split_sentences` to `nonewlines`.\n",
"disabled": true
},
{
"key": "preserve_formatting",
"value": "0",
"description": "Sets whether the translation engine should respect the original formatting, even if it would usually correct some aspects. Possible values are:\n * `0` (default)\n * `1`\n\nThe formatting aspects affected by this setting include:\n * Punctuation at the beginning and end of the sentence\n * Upper/lower case at the beginning of the sentence\n",
"disabled": true
},
{
"key": "formality",
"value": "default",
"description": "Sets whether the translated text should lean towards formal or informal language.\nThis feature currently only works for target languages\n`DE` (German),\n`FR` (French),\n`IT` (Italian),\n`ES` (Spanish),\n`NL` (Dutch),\n`PL` (Polish),\n`PT-PT`,\n`PT-BR` (Portuguese)\nand `RU` (Russian).\nSetting this parameter with a target language that does not support formality will fail,\nunless one of the `prefer_...` options are used.\nPossible options are:\n * `default` (default)\n * `more` - for a more formal language\n * `less` - for a more informal language\n * `prefer_more` - for a more formal language if available, otherwise fallback to default formality\n * `prefer_less` - for a more informal language if available, otherwise fallback to default formality\n",
"disabled": true
},
{
"key": "glossary_id",
"value": "<string>",
"description": "Specify the glossary to use for the translation. **Important:** This requires the `source_lang` parameter to be set and the language pair of the glossary has to match the language pair of the request.\n",
"disabled": true
},
{
"key": "tag_handling",
"value": "xml",
"description": "Sets which kind of tags should be handled. Options currently available:\n * `xml`: Enable XML tag handling; see :apiDocsLink{section=\"xml\"}.\n * `html`: Enable HTML tag handling; see :apiDocsLink{section=\"html\"}.\n"
},
{
"key": "non_splitting_tags",
"value": "<string>",
"description": "Comma-separated list of XML tags which never split sentences.\n\n\nFor some XML files, finding tags with textual content and splitting sentences using those tags won't yield the best results. The following example shows the engine splitting sentences on `par` tags and proceeding to translate the parts separately, resulting in an incorrect translation:\n * Example request:\n```\n<par>The firm said it had been </par><par> conducting an internal investigation.</par>\n```\n * Example response:\n```\n<par>Die Firma sagte, es sei eine gute Idee gewesen.</par><par> Durchführung einer internen Untersuchung.</par>\n```\n\n\nAs this can lead to bad translations, this type of structure should either be avoided, or the `non_splitting_tags` parameter should be set. The following example shows the same call, with the parameter set to `par`:\n * Example request:\n```\n<par>The firm said it had been </par><par> conducting an internal investigation.</par>\n```\n * Example response:\n```\n<par>Die Firma sagte, dass sie</par><par> eine interne Untersuchung durchgeführt</par><par> habe</par><par>.</par>\n```\n\n\nThis time, the sentence is translated as a whole. The XML tags are now considered markup and copied into the translated sentence. As the translation of the words \"had been\" has moved to another position in the German sentence, the two par tags are duplicated (which is expected here).\n",
"disabled": true
},
{
"key": "outline_detection",
"value": "0",
"description": "The automatic detection of the XML structure won't yield best results in all XML files. You can disable this automatic mechanism altogether by setting the `outline_detection` parameter to `0` and selecting the tags that should be considered structure tags. This will split sentences using the `splitting_tags` parameter.\n\n\nIn the example below, we achieve the same results as the automatic engine by disabling automatic detection with `outline_detection=0` and setting the parameters manually to `tag_handling=xml`, `split_sentences=nonewlines`, and `splitting_tags=par,title`.\n * Example request:\n ```\n <document>\n <meta>\n <title>A document's title</title>\n </meta>\n <content>\n <par>This is the first sentence. Followed by a second one.</par>\n <par>This is the third sentence.</par>\n </content>\n </document>\n ```\n * Example response:\n ```\n <document>\n <meta>\n <title>Der Titel eines Dokuments</title>\n </meta>\n <content>\n <par>Das ist der erste Satz. Gefolgt von einem zweiten.</par>\n <par>Dies ist der dritte Satz.</par>\n </content>\n </document>\n ```\nWhile this approach is slightly more complicated, it allows for greater control over the structure of the translation output.\n",
"disabled": true
},
{
"key": "splitting_tags",
"value": "<string>",
"description": "Comma-separated list of XML tags which always cause splits.\n\n\nSee the example in the `outline_detection` parameter's description.\n",
"disabled": true
},
{
"key": "ignore_tags",
"value": "do_not_translate",
"description": "Comma-separated list of XML tags that indicate text not to be translated.\n\n\nUse this paramter to ensure that elements in the original text are not altered in the translation (e.g., trademarks, product names) and insert tags into your original text. In the following example, the `ignore_tags` parameter is set to `keep`:\n * Example request:\n ```\n Please open the page <keep>Settings</keep> to configure your system.\n ```\n * Example response:\n ```\n Bitte öffnen Sie die Seite <keep>Settings</keep> um Ihr System zu konfigurieren.\n ```\n"
}
]
},
"url": {
"raw": "{{baseUrl}}/translate",
"host": [
"{{baseUrl}}"
],
"path": [
"translate"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [],
"body": null
}
]
}
]
},
{
"name": "languages",
"item": [
{
"name": "Retrieve Supported Languages",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/languages?type=source",
"host": [
"{{baseUrl}}"
],
"path": [
"languages"
],
"query": [
{
"key": "type",
"value": "source",
"description": "Sets whether source or target languages should be listed. Possible options are:\n * `source` (default): For languages that can be used in the `source_lang` parameter of :apiDocsLink[translate]{operationId=translateText} requests.\n * `target`: For languages that can be used in the `target_lang` parameter of :apiDocsLink[translate]{operationId=translateText} requests.\n"
}
]
},
"description": "Retrieve the list of languages that are currently supported for translation, either as source or target language, respectively."
},
"response": [
{
"name": "JSON array where each item represents a supported language.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/languages?type=source",
"host": [
"{{baseUrl}}"
],
"path": [
"languages"
],
"query": [
{
"key": "type",
"value": "source",
"description": "Sets whether source or target languages should be listed. Possible options are:\n * `source` (default): For languages that can be used in the `source_lang` parameter of :apiDocsLink[translate]{operationId=translateText} requests.\n * `target`: For languages that can be used in the `target_lang` parameter of :apiDocsLink[translate]{operationId=translateText} requests.\n"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "[\n {\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"supports_formality\": \"<boolean>\"\n },\n {\n \"language\": \"<string>\",\n \"name\": \"<string>\",\n \"supports_formality\": \"<boolean>\"\n }\n]"
}
]
}
]
},
{
"name": "glossary-language-pairs",
"item": [
{
"name": "List Language Pairs Supported by Glossaries",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/glossary-language-pairs",
"host": [
"{{baseUrl}}"
],
"path": [
"glossary-language-pairs"
]
},
"description": "Retrieve the list of language pairs supported by the glossary feature."
},
"response": [
{
"name": "A JSON object containing the language pairs in its `supported_languages` property.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/glossary-language-pairs",
"host": [
"{{baseUrl}}"
],
"path": [
"glossary-language-pairs"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"supported_languages\": [\n {\n \"source_lang\": \"<string>\",\n \"target_lang\": \"<string>\"\n },\n {\n \"source_lang\": \"<string>\",\n \"target_lang\": \"<string>\"\n }\n ]\n}"
}
]
}
]
},
{
"name": "glossaries",
"item": [
{
"name": "{glossary_id}",
"item": [
{
"name": "entries",
"item": [
{
"name": "Retrieve Glossary Entries",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "text/tab-separated-values"
}
],
"url": {
"raw": "{{baseUrl}}/glossaries/:glossary_id/entries",
"host": [
"{{baseUrl}}"
],
"path": [
"glossaries",
":glossary_id",
"entries"
],
"variable": [
{
"key": "glossary_id",
"value": "<string>"
}
]
},
"description": "List the entries of a single glossary in the format specified by the `Accept` header."
},
"response": [
{
"name": "The entries in the requested format.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "text/tab-separated-values"
},
{
"key": "Authorization",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/glossaries/:glossary_id/entries",
"host": [
"{{baseUrl}}"
],
"path": [
"glossaries",
":glossary_id",
"entries"
],
"variable": [
{
"key": "glossary_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/tab-separated-values"
}
],
"cookie": [],
"body": "{\n \"example\": \"Hello!\\tGuten Tag!\"\n}"
}
]
}
]
},
{
"name": "Retrieve Glossary Details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/glossaries/:glossary_id",
"host": [
"{{baseUrl}}"
],
"path": [
"glossaries",
":glossary_id"
],
"variable": [
{
"key": "glossary_id",
"value": "<string>"
}
]
},
"description": "Retrieve meta information for a single glossary, omitting the glossary entries."
},
"response": [
{
"name": "JSON object containing the glossary meta-information.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/glossaries/:glossary_id",
"host": [
"{{baseUrl}}"
],
"path": [
"glossaries",
":glossary_id"
],
"variable": [
{
"key": "glossary_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"glossary_id\": \"<string>\",\n \"name\": \"<string>\",\n \"ready\": \"<boolean>\",\n \"source_lang\": \"ja\",\n \"target_lang\": \"fr\",\n \"creation_time\": \"<dateTime>\",\n \"entry_count\": \"<integer>\"\n}"
}
]
},
{
"name": "Delete a Glossary",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/glossaries/:glossary_id",
"host": [
"{{baseUrl}}"
],
"path": [
"glossaries",
":glossary_id"
],
"variable": [
{
"key": "glossary_id",
"value": "<string>"
}
]
},
"description": "Deletes the specified glossary."
},
"response": [
{
"name": "Returns no content upon success.\n",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Authorization",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"url": {
"raw": "{{baseUrl}}/glossaries/:glossary_id",
"host": [
"{{baseUrl}}"
],
"path": [
"glossaries",
":glossary_id"
],
"variable": [
{
"key": "glossary_id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": null
}
]
}
]
},
{
"name": "Create a Glossary",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "name",
"value": "<string>",
"description": "(Required) Name to be associated with the glossary."
},
{
"key": "source_lang",
"value": "de",
"description": "(Required) The language in which the source texts in the glossary are specified."
},
{
"key": "target_lang",
"value": "it",
"description": "(Required) The language in which the target texts in the glossary are specified."
},
{
"key": "entries",
"value": "<string>",
"description": "(Required) The entries of the glossary. The entries have to be specified in the format provided by the `entries_format` parameter."
},
{
"key": "entries_format",
"value": "tsv",
"description": "(Required) The format in which the glossary entries are provided. Formats currently available:\n- `tsv` (default) - tab-separated values\n- `csv` - comma-separated values\n\nSee :apiDocsLink{section=glossaries/formats} for details about each format.\n"
}
]
},
"url": {
"raw": "{{baseUrl}}/glossaries",
"host": [
"{{baseUrl}}"
],
"path": [
"glossaries"
]
},
"description": "**Please note Postman does not support TSV format**"
},
"response": [
{
"name": "The function for creating a glossary returns a JSON object containing the ID of the newly created glossary and a boolean flag that indicates if the created glossary can already be used in translate requests.\n",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "name",
"value": "<string>",
"description": "(Required) Name to be associated with the glossary."
},
{
"key": "source_lang",
"value": "de",
"description": "(Required) The language in which the source texts in the glossary are specified."
},
{
"key": "target_lang",
"value": "it",
"description": "(Required) The language in which the target texts in the glossary are specified."
},
{
"key": "entries",
"value": "<string>",
"description": "(Required) The entries of the glossary. The entries have to be specified in the format provided by the `entries_format` parameter."
},
{
"key": "entries_format",
"value": "tsv",
"description": "(Required) The format in which the glossary entries are provided. Formats currently available:\n- `tsv` (default) - tab-separated values\n- `csv` - comma-separated values\n\nSee :apiDocsLink{section=glossaries/formats} for details about each format.\n"
}
]
},
"url": {
"raw": "{{baseUrl}}/glossaries",
"host": [
"{{baseUrl}}"
],
"path": [
"glossaries"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"glossary_id\": \"<string>\",\n \"name\": \"<string>\",\n \"ready\": \"<boolean>\",\n \"source_lang\": \"ja\",\n \"target_lang\": \"fr\",\n \"creation_time\": \"<dateTime>\",\n \"entry_count\": \"<integer>\"\n}"
},
{
"name": "Create a Glossary example",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/x-www-form-urlencoded"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "name",
"value": "Standardized greeting",
"description": "(Required) Name to be associated with the glossary."
},
{
"key": "source_lang",