@generaltranslation/api 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/index.cjs +163 -111
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +595 -648
  5. package/dist/index.d.mts +595 -648
  6. package/dist/index.mjs +163 -110
  7. package/dist/index.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/spec/openapi.json +1731 -1766
package/spec/openapi.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "General Translation API",
5
5
  "version": "2026-03-06.v1",
6
- "description": "The public General Translation API. Use it to upload source content and translated files, download translations, queue and translate content, create projects, manage branches and tags, and read project and job status.\n\nMost endpoints operate on a single project. All endpoints live under `https://api.gtx.dev`.\n\nAuthenticate every request with an API key as a bearer token in the standard `Authorization: Bearer <key>` header. Project keys (`gtx-api-`, `gtx-dev-`) are bound to one project. Organization keys (`gtx-org-`) work across projects but must include the target project in the `gt-project-id` header for project-scoped routes. Organization-scoped routes, such as `POST /v2/projects`, derive the organization from the key and do not use a `gt-project-id` header.",
6
+ "description": "The public General Translation API. Use it to upload source content and translated files, download translations, queue and translate content, create projects, manage branches and tags, and read project and job status.\n\nMost endpoints operate on a single project. All endpoints live under `https://api.gtx.dev`.\n\nAuthenticate every request with an API key as a bearer token in the standard `Authorization: Bearer <key>` header. Project keys (`gtx-api-`, `gtx-dev-`) are bound to one project. Organization keys (`gtx-org-`) work across projects but must include the target project in the `gt-project-id` header for project-scoped routes. Organization-scoped routes, such as `POST /v2/orgs/{orgId}/projects`, require the target organization in the `orgId` path parameter. The credential must have access to that organization.",
7
7
  "contact": {
8
8
  "name": "General Translation Support",
9
9
  "email": "support@generaltranslation.com",
@@ -42,7 +42,14 @@
42
42
  "securitySchemes": {
43
43
  "BearerAuth": {
44
44
  "type": "http",
45
- "scheme": "bearer"
45
+ "scheme": "bearer",
46
+ "description": "Project or organization API key."
47
+ },
48
+ "UserBearerAuth": {
49
+ "type": "http",
50
+ "scheme": "bearer",
51
+ "bearerFormat": "JWT",
52
+ "description": "OAuth 2.1 user access token."
46
53
  }
47
54
  },
48
55
  "schemas": {
@@ -72,20 +79,53 @@
72
79
  "TWILIO_CONTENT_JSON",
73
80
  "LOTTIE",
74
81
  "SVG",
82
+ "XCSTRINGS",
75
83
  "DOT_STRINGS",
76
84
  "DOT_STRINGSDICT",
77
- "ANDROID_STRINGS",
78
- "XCSTRINGS"
85
+ "ANDROID_STRINGS"
79
86
  ]
80
87
  },
81
- "ModelProvider": {
82
- "type": "string",
83
- "enum": ["ANTHROPIC", "OPENAI", "XAI", "GOOGLE"]
84
- },
85
- "JsonObject": {
88
+ "RuntimeTranslationResponse": {
86
89
  "type": "object",
87
90
  "additionalProperties": {
88
- "$ref": "#/components/schemas/JsonValue"
91
+ "oneOf": [
92
+ {
93
+ "type": "object",
94
+ "properties": {
95
+ "success": {
96
+ "type": "boolean",
97
+ "enum": [true]
98
+ },
99
+ "translation": {
100
+ "$ref": "#/components/schemas/JsonValue"
101
+ },
102
+ "dataFormat": {
103
+ "type": "string",
104
+ "enum": ["JSX", "ICU", "I18NEXT", "STRING"]
105
+ },
106
+ "locale": {
107
+ "type": "string"
108
+ }
109
+ },
110
+ "required": ["success", "dataFormat", "locale"]
111
+ },
112
+ {
113
+ "type": "object",
114
+ "properties": {
115
+ "success": {
116
+ "type": "boolean",
117
+ "enum": [false]
118
+ },
119
+ "error": {
120
+ "type": "string"
121
+ },
122
+ "code": {
123
+ "type": "number"
124
+ }
125
+ },
126
+ "required": ["success", "error", "code"]
127
+ }
128
+ ]
89
129
  }
90
130
  },
91
131
  "JsonValue": {
@@ -130,61 +170,6 @@
130
170
  }
131
171
  ]
132
172
  },
133
- "Branch": {
134
- "type": "object",
135
- "properties": {
136
- "id": {
137
- "type": "string"
138
- },
139
- "name": {
140
- "type": "string"
141
- }
142
- },
143
- "required": ["id", "name"]
144
- },
145
- "RuntimeTranslationResponse": {
146
- "type": "object",
147
- "additionalProperties": {
148
- "oneOf": [
149
- {
150
- "type": "object",
151
- "properties": {
152
- "success": {
153
- "type": "boolean",
154
- "enum": [true]
155
- },
156
- "translation": {
157
- "$ref": "#/components/schemas/JsonValue"
158
- },
159
- "dataFormat": {
160
- "type": "string",
161
- "enum": ["JSX", "ICU", "I18NEXT", "STRING"]
162
- },
163
- "locale": {
164
- "type": "string"
165
- }
166
- },
167
- "required": ["success", "dataFormat", "locale"]
168
- },
169
- {
170
- "type": "object",
171
- "properties": {
172
- "success": {
173
- "type": "boolean",
174
- "enum": [false]
175
- },
176
- "error": {
177
- "type": "string"
178
- },
179
- "code": {
180
- "type": "number"
181
- }
182
- },
183
- "required": ["success", "error", "code"]
184
- }
185
- ]
186
- }
187
- },
188
173
  "RuntimeTranslationRequest": {
189
174
  "type": "object",
190
175
  "properties": {
@@ -268,6 +253,28 @@
268
253
  },
269
254
  "required": ["requests", "targetLocale", "sourceLocale", "metadata"]
270
255
  },
256
+ "ModelProvider": {
257
+ "type": "string",
258
+ "enum": ["ANTHROPIC", "OPENAI", "XAI", "GOOGLE"]
259
+ },
260
+ "Branch": {
261
+ "type": "object",
262
+ "properties": {
263
+ "id": {
264
+ "type": "string"
265
+ },
266
+ "name": {
267
+ "type": "string"
268
+ }
269
+ },
270
+ "required": ["id", "name"]
271
+ },
272
+ "JsonObject": {
273
+ "type": "object",
274
+ "additionalProperties": {
275
+ "$ref": "#/components/schemas/JsonValue"
276
+ }
277
+ },
271
278
  "CreateCliWizardSessionResponse": {
272
279
  "type": "object",
273
280
  "properties": {
@@ -350,17 +357,29 @@
350
357
  "parameters": {}
351
358
  },
352
359
  "paths": {
353
- "/v2/projects": {
360
+ "/v2/orgs/{orgId}/projects": {
354
361
  "post": {
355
362
  "operationId": "createProject",
356
363
  "summary": "Create a Project",
357
- "description": "Create a Project in the Organization associated with an Organization API key. The key must have the `org:projects:create` permission. Project keys cannot use this endpoint. Enabling CDN delivery also requires `project:write`.",
364
+ "description": "Create a Project in the Organization selected by the orgId path parameter. Requires org:projects:create. Enabling CDN delivery also requires project:write.",
358
365
  "security": [
359
366
  {
360
367
  "BearerAuth": []
368
+ },
369
+ {
370
+ "UserBearerAuth": []
361
371
  }
362
372
  ],
363
373
  "parameters": [
374
+ {
375
+ "schema": {
376
+ "type": "string",
377
+ "minLength": 1
378
+ },
379
+ "required": true,
380
+ "name": "orgId",
381
+ "in": "path"
382
+ },
364
383
  {
365
384
  "schema": {
366
385
  "type": "string",
@@ -542,17 +561,29 @@
542
561
  "tags": ["Project"]
543
562
  }
544
563
  },
545
- "/v2/project/files/upload-files": {
564
+ "/v2/projects/{projectId}/api-keys": {
546
565
  "post": {
547
- "operationId": "uploadSourceFiles",
548
- "summary": "Upload source files",
549
- "description": "Upload one or more source files to the project. Max 100 files per request.",
566
+ "operationId": "createProjectApiKey",
567
+ "summary": "Create a Project API Key",
568
+ "description": "Create an API key for the selected Project. Requires project:api_keys:write and delegates only Project permissions held by the request identity.",
550
569
  "security": [
551
570
  {
552
571
  "BearerAuth": []
572
+ },
573
+ {
574
+ "UserBearerAuth": []
553
575
  }
554
576
  ],
555
577
  "parameters": [
578
+ {
579
+ "schema": {
580
+ "type": "string",
581
+ "minLength": 1
582
+ },
583
+ "required": true,
584
+ "name": "projectId",
585
+ "in": "path"
586
+ },
556
587
  {
557
588
  "schema": {
558
589
  "type": "string",
@@ -568,16 +599,6 @@
568
599
  "description": "API contract version. Defaults to the oldest supported version.",
569
600
  "name": "gt-api-version",
570
601
  "in": "header"
571
- },
572
- {
573
- "schema": {
574
- "type": "string",
575
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
576
- },
577
- "required": false,
578
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
579
- "name": "gt-project-id",
580
- "in": "header"
581
602
  }
582
603
  ],
583
604
  "requestBody": {
@@ -587,149 +608,55 @@
587
608
  "schema": {
588
609
  "type": "object",
589
610
  "properties": {
590
- "data": {
591
- "type": "array",
592
- "items": {
593
- "type": "object",
594
- "properties": {
595
- "source": {
596
- "type": "object",
597
- "properties": {
598
- "content": {
599
- "type": "string"
600
- },
601
- "fileName": {
602
- "type": "string",
603
- "minLength": 1
604
- },
605
- "fileFormat": {
606
- "type": "string",
607
- "enum": [
608
- "GTJSON",
609
- "MDX",
610
- "JSON",
611
- "YAML",
612
- "MD",
613
- "TS",
614
- "JS",
615
- "HTML",
616
- "TXT",
617
- "PO",
618
- "POT",
619
- "TWILIO_CONTENT_JSON",
620
- "LOTTIE",
621
- "SVG",
622
- "DOT_STRINGS",
623
- "DOT_STRINGSDICT",
624
- "ANDROID_STRINGS",
625
- "XCSTRINGS"
626
- ]
627
- },
628
- "dataFormat": {
629
- "type": "string"
630
- },
631
- "locale": {
632
- "type": "string",
633
- "minLength": 1
634
- },
635
- "fileId": {
636
- "type": "string",
637
- "minLength": 1
638
- },
639
- "versionId": {
640
- "type": "string",
641
- "minLength": 1
642
- },
643
- "branchId": {
644
- "type": "string",
645
- "minLength": 1
646
- },
647
- "checkedOutBranchId": {
648
- "type": "string",
649
- "minLength": 1
650
- },
651
- "incomingBranchId": {
652
- "type": "string",
653
- "minLength": 1
654
- },
655
- "formatMetadata": {
656
- "type": "object",
657
- "additionalProperties": {}
658
- }
659
- },
660
- "required": [
661
- "content",
662
- "fileName",
663
- "fileFormat",
664
- "locale"
665
- ]
666
- }
667
- },
668
- "required": ["source"]
669
- },
670
- "minItems": 1,
671
- "maxItems": 100
611
+ "name": {
612
+ "type": "string",
613
+ "minLength": 1,
614
+ "maxLength": 255
672
615
  },
673
- "sourceLocale": {
674
- "type": "string"
616
+ "type": {
617
+ "type": "string",
618
+ "enum": ["production", "development"],
619
+ "default": "production"
675
620
  }
676
621
  },
677
- "required": ["data"]
622
+ "required": ["name"],
623
+ "additionalProperties": false
678
624
  }
679
625
  }
680
626
  }
681
627
  },
682
628
  "responses": {
683
629
  "201": {
684
- "description": "Uploaded source files",
630
+ "description": "Project API key created",
685
631
  "content": {
686
632
  "application/json": {
687
633
  "schema": {
688
634
  "type": "object",
689
635
  "properties": {
690
- "uploadedFiles": {
691
- "type": "array",
692
- "items": {
693
- "type": "object",
694
- "properties": {
695
- "branchId": {
696
- "type": "string"
697
- },
698
- "fileId": {
699
- "type": "string"
700
- },
701
- "versionId": {
702
- "type": "string"
703
- },
704
- "fileName": {
705
- "type": "string"
706
- },
707
- "fileFormat": {
708
- "$ref": "#/components/schemas/FileFormat"
709
- },
710
- "dataFormat": {
711
- "type": "string"
712
- },
713
- "locale": {
714
- "type": "string"
715
- }
636
+ "apiKey": {
637
+ "type": "object",
638
+ "properties": {
639
+ "id": {
640
+ "type": "string"
716
641
  },
717
- "required": [
718
- "fileId",
719
- "versionId",
720
- "fileName",
721
- "fileFormat"
722
- ]
723
- }
724
- },
725
- "count": {
726
- "type": "number"
727
- },
728
- "message": {
729
- "type": "string"
642
+ "name": {
643
+ "type": "string"
644
+ },
645
+ "key": {
646
+ "type": "string"
647
+ },
648
+ "projectId": {
649
+ "type": "string"
650
+ },
651
+ "type": {
652
+ "type": "string",
653
+ "enum": ["production", "development"]
654
+ }
655
+ },
656
+ "required": ["id", "name", "key", "projectId", "type"]
730
657
  }
731
658
  },
732
- "required": ["uploadedFiles", "count", "message"]
659
+ "required": ["apiKey"]
733
660
  }
734
661
  }
735
662
  }
@@ -838,24 +765,9 @@
838
765
  }
839
766
  }
840
767
  }
841
- },
842
- "503": {
843
- "description": "Request error",
844
- "content": {
845
- "application/json": {
846
- "schema": {
847
- "$ref": "#/components/schemas/ErrorResponse"
848
- }
849
- },
850
- "text/html": {
851
- "schema": {
852
- "type": "string"
853
- }
854
- }
855
- }
856
768
  }
857
769
  },
858
- "tags": ["Files"]
770
+ "tags": ["Project"]
859
771
  }
860
772
  },
861
773
  "/v2/project/files/upload-translations": {
@@ -866,6 +778,9 @@
866
778
  "security": [
867
779
  {
868
780
  "BearerAuth": []
781
+ },
782
+ {
783
+ "UserBearerAuth": []
869
784
  }
870
785
  ],
871
786
  "parameters": [
@@ -888,10 +803,10 @@
888
803
  {
889
804
  "schema": {
890
805
  "type": "string",
891
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
806
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
892
807
  },
893
808
  "required": false,
894
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
809
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
895
810
  "name": "gt-project-id",
896
811
  "in": "header"
897
812
  }
@@ -935,10 +850,10 @@
935
850
  "TWILIO_CONTENT_JSON",
936
851
  "LOTTIE",
937
852
  "SVG",
853
+ "XCSTRINGS",
938
854
  "DOT_STRINGS",
939
855
  "DOT_STRINGSDICT",
940
- "ANDROID_STRINGS",
941
- "XCSTRINGS"
856
+ "ANDROID_STRINGS"
942
857
  ]
943
858
  },
944
859
  "dataFormat": {
@@ -1009,10 +924,10 @@
1009
924
  "TWILIO_CONTENT_JSON",
1010
925
  "LOTTIE",
1011
926
  "SVG",
927
+ "XCSTRINGS",
1012
928
  "DOT_STRINGS",
1013
929
  "DOT_STRINGSDICT",
1014
- "ANDROID_STRINGS",
1015
- "XCSTRINGS"
930
+ "ANDROID_STRINGS"
1016
931
  ]
1017
932
  },
1018
933
  "dataFormat": {
@@ -1039,10 +954,10 @@
1039
954
  "TWILIO_CONTENT_JSON",
1040
955
  "LOTTIE",
1041
956
  "SVG",
957
+ "XCSTRINGS",
1042
958
  "DOT_STRINGS",
1043
959
  "DOT_STRINGSDICT",
1044
- "ANDROID_STRINGS",
1045
- "XCSTRINGS"
960
+ "ANDROID_STRINGS"
1046
961
  ]
1047
962
  }
1048
963
  },
@@ -1249,17 +1164,29 @@
1249
1164
  "tags": ["Files"]
1250
1165
  }
1251
1166
  },
1252
- "/v2/project/assets": {
1167
+ "/v2/project/info/{projectId}": {
1253
1168
  "post": {
1254
- "operationId": "uploadAssets",
1255
- "summary": "Upload Project assets",
1256
- "description": "Upload OpenType or TrueType fonts through a Project and make them available to Lottie translation workflows across its Organization. Each font is keyed by a normalized identity derived from its family, weight, and italic style (from the supplied `family` and `style`, or from the font metadata and file name). Re-uploading the same identity overwrites the existing asset, so complete retries after a `500` response are safe.",
1169
+ "operationId": "updateProjectInfo",
1170
+ "summary": "Update Project information",
1171
+ "description": "Update the Project's default locale or CDN delivery setting.",
1257
1172
  "security": [
1258
1173
  {
1259
1174
  "BearerAuth": []
1175
+ },
1176
+ {
1177
+ "UserBearerAuth": []
1260
1178
  }
1261
1179
  ],
1262
1180
  "parameters": [
1181
+ {
1182
+ "schema": {
1183
+ "type": "string",
1184
+ "minLength": 1
1185
+ },
1186
+ "required": true,
1187
+ "name": "projectId",
1188
+ "in": "path"
1189
+ },
1263
1190
  {
1264
1191
  "schema": {
1265
1192
  "type": "string",
@@ -1279,10 +1206,10 @@
1279
1206
  {
1280
1207
  "schema": {
1281
1208
  "type": "string",
1282
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
1209
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
1283
1210
  },
1284
1211
  "required": false,
1285
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
1212
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
1286
1213
  "name": "gt-project-id",
1287
1214
  "in": "header"
1288
1215
  }
@@ -1294,79 +1221,31 @@
1294
1221
  "schema": {
1295
1222
  "type": "object",
1296
1223
  "properties": {
1297
- "assets": {
1298
- "type": "array",
1299
- "items": {
1300
- "type": "object",
1301
- "properties": {
1302
- "assetType": {
1303
- "type": "string",
1304
- "enum": ["FONT"]
1305
- },
1306
- "content": {
1307
- "type": "string",
1308
- "minLength": 1
1309
- },
1310
- "fileName": {
1311
- "type": "string",
1312
- "minLength": 1,
1313
- "maxLength": 255,
1314
- "pattern": "\\.([tT][tT][fF]|[oO][tT][fF])$"
1315
- },
1316
- "family": {
1317
- "type": "string",
1318
- "minLength": 1,
1319
- "maxLength": 255
1320
- },
1321
- "style": {
1322
- "type": "string",
1323
- "minLength": 1,
1324
- "maxLength": 100
1325
- }
1326
- },
1327
- "required": ["assetType", "content", "fileName"]
1328
- },
1329
- "minItems": 1,
1330
- "maxItems": 50
1224
+ "defaultLocale": {
1225
+ "type": "string"
1226
+ },
1227
+ "cdnEnabled": {
1228
+ "type": "boolean"
1331
1229
  }
1332
- },
1333
- "required": ["assets"]
1230
+ }
1334
1231
  }
1335
1232
  }
1336
1233
  }
1337
1234
  },
1338
1235
  "responses": {
1339
- "201": {
1340
- "description": "Uploaded assets",
1236
+ "200": {
1237
+ "description": "Project settings updated",
1341
1238
  "content": {
1342
1239
  "application/json": {
1343
1240
  "schema": {
1344
1241
  "type": "object",
1345
1242
  "properties": {
1346
- "assets": {
1347
- "type": "array",
1348
- "items": {
1349
- "type": "object",
1350
- "properties": {
1351
- "id": {
1352
- "type": "string"
1353
- },
1354
- "assetKey": {
1355
- "type": "string"
1356
- },
1357
- "fileName": {
1358
- "type": "string"
1359
- }
1360
- },
1361
- "required": ["id", "assetKey", "fileName"]
1362
- }
1363
- },
1364
- "count": {
1365
- "type": "integer",
1366
- "minimum": 0
1243
+ "success": {
1244
+ "type": "boolean",
1245
+ "enum": [true]
1367
1246
  }
1368
1247
  },
1369
- "required": ["assets", "count"]
1248
+ "required": ["success"]
1370
1249
  }
1371
1250
  }
1372
1251
  }
@@ -1478,19 +1357,29 @@
1478
1357
  }
1479
1358
  },
1480
1359
  "tags": ["Project"]
1481
- }
1482
- },
1483
- "/v2/project/files/diffs": {
1484
- "post": {
1485
- "operationId": "submitUserEditDiffs",
1486
- "summary": "Submit translation diffs",
1487
- "description": "Overwrite translations with user-provided localized content.",
1360
+ },
1361
+ "get": {
1362
+ "operationId": "getProjectInfo",
1363
+ "summary": "Get Project information",
1364
+ "description": "Read the authenticated Project's name, Organization ID, locale settings, and auto-approval setting.",
1488
1365
  "security": [
1489
1366
  {
1490
1367
  "BearerAuth": []
1368
+ },
1369
+ {
1370
+ "UserBearerAuth": []
1491
1371
  }
1492
1372
  ],
1493
1373
  "parameters": [
1374
+ {
1375
+ "schema": {
1376
+ "type": "string",
1377
+ "minLength": 1
1378
+ },
1379
+ "required": true,
1380
+ "name": "projectId",
1381
+ "in": "path"
1382
+ },
1494
1383
  {
1495
1384
  "schema": {
1496
1385
  "type": "string",
@@ -1510,96 +1399,59 @@
1510
1399
  {
1511
1400
  "schema": {
1512
1401
  "type": "string",
1513
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
1402
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
1514
1403
  },
1515
1404
  "required": false,
1516
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
1405
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
1517
1406
  "name": "gt-project-id",
1518
1407
  "in": "header"
1519
1408
  }
1520
1409
  ],
1521
- "requestBody": {
1522
- "required": true,
1523
- "content": {
1524
- "application/json": {
1525
- "schema": {
1526
- "type": "object",
1527
- "properties": {
1528
- "projectId": {
1529
- "type": "string"
1530
- },
1531
- "diffs": {
1532
- "type": "array",
1533
- "items": {
1534
- "type": "object",
1535
- "properties": {
1536
- "locale": {
1537
- "type": "string",
1538
- "minLength": 1
1539
- },
1540
- "diff": {
1541
- "type": "string"
1542
- },
1543
- "branchId": {
1544
- "type": "string",
1545
- "minLength": 1
1546
- },
1547
- "versionId": {
1548
- "type": "string",
1549
- "minLength": 1
1550
- },
1551
- "fileId": {
1552
- "type": "string",
1553
- "minLength": 1
1554
- },
1555
- "localContent": {
1556
- "type": "string"
1557
- }
1558
- },
1559
- "required": [
1560
- "locale",
1561
- "diff",
1562
- "versionId",
1563
- "fileId",
1564
- "localContent"
1565
- ]
1566
- },
1567
- "minItems": 1
1568
- }
1569
- },
1570
- "required": ["diffs"]
1571
- }
1572
- }
1573
- }
1574
- },
1575
1410
  "responses": {
1576
1411
  "200": {
1577
- "description": "Processed user translation edits",
1412
+ "description": "Project information",
1578
1413
  "content": {
1579
1414
  "application/json": {
1580
1415
  "schema": {
1581
1416
  "type": "object",
1582
1417
  "properties": {
1583
- "filesProcessed": {
1584
- "type": "integer",
1585
- "minimum": 0
1418
+ "id": {
1419
+ "type": "string"
1586
1420
  },
1587
- "entriesReceived": {
1588
- "type": "integer",
1589
- "minimum": 0
1421
+ "name": {
1422
+ "type": "string"
1590
1423
  },
1591
- "message": {
1424
+ "orgId": {
1592
1425
  "type": "string"
1593
- }
1594
- },
1595
- "required": ["filesProcessed", "entriesReceived", "message"]
1596
- }
1597
- }
1598
- }
1599
- },
1600
- "400": {
1601
- "description": "Request error",
1602
- "content": {
1426
+ },
1427
+ "defaultLocale": {
1428
+ "type": ["string", "null"]
1429
+ },
1430
+ "currentLocales": {
1431
+ "type": "array",
1432
+ "items": {
1433
+ "type": "string"
1434
+ }
1435
+ },
1436
+ "autoApprove": {
1437
+ "type": "boolean"
1438
+ }
1439
+ },
1440
+ "required": [
1441
+ "id",
1442
+ "name",
1443
+ "orgId",
1444
+ "defaultLocale",
1445
+ "currentLocales",
1446
+ "autoApprove"
1447
+ ]
1448
+ }
1449
+ }
1450
+ }
1451
+ },
1452
+ "400": {
1453
+ "description": "Request error",
1454
+ "content": {
1603
1455
  "application/json": {
1604
1456
  "schema": {
1605
1457
  "$ref": "#/components/schemas/ErrorResponse"
@@ -1642,7 +1494,7 @@
1642
1494
  }
1643
1495
  }
1644
1496
  },
1645
- "413": {
1497
+ "404": {
1646
1498
  "description": "Request error",
1647
1499
  "content": {
1648
1500
  "application/json": {
@@ -1688,18 +1540,20 @@
1688
1540
  }
1689
1541
  }
1690
1542
  },
1691
- "tags": ["Files"]
1543
+ "tags": ["Project"]
1692
1544
  }
1693
1545
  },
1694
- "/v2/project/setup/should-generate": {
1695
- "get": {
1696
- "operationId": "shouldGenerateProjectContext",
1697
- "summary": "Check if context generation is needed",
1698
- "deprecated": true,
1699
- "description": "Check whether the Project needs translation context generated. This deprecated endpoint is retained for backward compatibility and is no longer called by current clients.",
1546
+ "/v2/translate": {
1547
+ "post": {
1548
+ "operationId": "translate",
1549
+ "summary": "Translate content at runtime",
1550
+ "description": "Translate one or more strings or structured content entries with caching and memoization. Development API keys are accepted for this endpoint.",
1700
1551
  "security": [
1701
1552
  {
1702
1553
  "BearerAuth": []
1554
+ },
1555
+ {
1556
+ "UserBearerAuth": []
1703
1557
  }
1704
1558
  ],
1705
1559
  "parameters": [
@@ -1722,27 +1576,41 @@
1722
1576
  {
1723
1577
  "schema": {
1724
1578
  "type": "string",
1725
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
1579
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
1726
1580
  },
1727
1581
  "required": false,
1728
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
1582
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
1729
1583
  "name": "gt-project-id",
1730
1584
  "in": "header"
1731
1585
  }
1732
1586
  ],
1587
+ "requestBody": {
1588
+ "required": true,
1589
+ "content": {
1590
+ "application/json": {
1591
+ "schema": {
1592
+ "$ref": "#/components/schemas/RuntimeTranslationRequest"
1593
+ }
1594
+ }
1595
+ }
1596
+ },
1733
1597
  "responses": {
1734
1598
  "200": {
1735
- "description": "Whether project context should be generated",
1599
+ "description": "All translations were served from cache",
1736
1600
  "content": {
1737
1601
  "application/json": {
1738
1602
  "schema": {
1739
- "type": "object",
1740
- "properties": {
1741
- "shouldSetupProject": {
1742
- "type": "boolean"
1743
- }
1744
- },
1745
- "required": ["shouldSetupProject"]
1603
+ "$ref": "#/components/schemas/RuntimeTranslationResponse"
1604
+ }
1605
+ }
1606
+ }
1607
+ },
1608
+ "201": {
1609
+ "description": "Translations completed",
1610
+ "content": {
1611
+ "application/json": {
1612
+ "schema": {
1613
+ "$ref": "#/components/schemas/RuntimeTranslationResponse"
1746
1614
  }
1747
1615
  }
1748
1616
  }
@@ -1777,6 +1645,21 @@
1777
1645
  }
1778
1646
  }
1779
1647
  },
1648
+ "402": {
1649
+ "description": "Request error",
1650
+ "content": {
1651
+ "application/json": {
1652
+ "schema": {
1653
+ "$ref": "#/components/schemas/ErrorResponse"
1654
+ }
1655
+ },
1656
+ "text/html": {
1657
+ "schema": {
1658
+ "type": "string"
1659
+ }
1660
+ }
1661
+ }
1662
+ },
1780
1663
  "403": {
1781
1664
  "description": "Request error",
1782
1665
  "content": {
@@ -1807,6 +1690,21 @@
1807
1690
  }
1808
1691
  }
1809
1692
  },
1693
+ "413": {
1694
+ "description": "Request error",
1695
+ "content": {
1696
+ "application/json": {
1697
+ "schema": {
1698
+ "$ref": "#/components/schemas/ErrorResponse"
1699
+ }
1700
+ },
1701
+ "text/html": {
1702
+ "schema": {
1703
+ "type": "string"
1704
+ }
1705
+ }
1706
+ }
1707
+ },
1810
1708
  "429": {
1811
1709
  "description": "Request error",
1812
1710
  "content": {
@@ -1838,20 +1736,48 @@
1838
1736
  }
1839
1737
  }
1840
1738
  },
1841
- "tags": ["Context"]
1739
+ "tags": ["Translation"]
1842
1740
  }
1843
1741
  },
1844
- "/v2/project/setup/generate": {
1845
- "post": {
1846
- "operationId": "generateProjectContext",
1847
- "summary": "Generate translation context",
1848
- "description": "Generate glossaries and translation instructions for the project.",
1742
+ "/v2/project/translations/files/status/{fileId}": {
1743
+ "get": {
1744
+ "operationId": "getTranslationStatus",
1745
+ "summary": "Get translation status for a file",
1746
+ "description": "Return translation progress and availability by locale for one source file, along with its source metadata.",
1849
1747
  "security": [
1850
1748
  {
1851
1749
  "BearerAuth": []
1750
+ },
1751
+ {
1752
+ "UserBearerAuth": []
1852
1753
  }
1853
1754
  ],
1854
1755
  "parameters": [
1756
+ {
1757
+ "schema": {
1758
+ "type": "string",
1759
+ "minLength": 1
1760
+ },
1761
+ "required": true,
1762
+ "name": "fileId",
1763
+ "in": "path"
1764
+ },
1765
+ {
1766
+ "schema": {
1767
+ "type": "string"
1768
+ },
1769
+ "required": false,
1770
+ "name": "versionId",
1771
+ "in": "query"
1772
+ },
1773
+ {
1774
+ "schema": {
1775
+ "type": "string"
1776
+ },
1777
+ "required": false,
1778
+ "name": "branchId",
1779
+ "in": "query"
1780
+ },
1855
1781
  {
1856
1782
  "schema": {
1857
1783
  "type": "string",
@@ -1871,90 +1797,119 @@
1871
1797
  {
1872
1798
  "schema": {
1873
1799
  "type": "string",
1874
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
1800
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
1875
1801
  },
1876
1802
  "required": false,
1877
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
1803
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
1878
1804
  "name": "gt-project-id",
1879
1805
  "in": "header"
1880
1806
  }
1881
1807
  ],
1882
- "requestBody": {
1883
- "required": true,
1884
- "content": {
1885
- "application/json": {
1886
- "schema": {
1887
- "type": "object",
1888
- "properties": {
1889
- "files": {
1890
- "type": "array",
1891
- "items": {
1808
+ "responses": {
1809
+ "200": {
1810
+ "description": "Translation status",
1811
+ "content": {
1812
+ "application/json": {
1813
+ "schema": {
1814
+ "type": "object",
1815
+ "properties": {
1816
+ "translations": {
1817
+ "type": "array",
1818
+ "items": {
1819
+ "type": "object",
1820
+ "properties": {
1821
+ "locale": {
1822
+ "type": "string"
1823
+ },
1824
+ "completedAt": {
1825
+ "type": ["string", "null"],
1826
+ "format": "date-time"
1827
+ },
1828
+ "approvedAt": {
1829
+ "type": ["string", "null"],
1830
+ "format": "date-time"
1831
+ },
1832
+ "publishedAt": {
1833
+ "type": ["string", "null"],
1834
+ "format": "date-time"
1835
+ },
1836
+ "createdAt": {
1837
+ "type": ["string", "null"],
1838
+ "format": "date-time"
1839
+ },
1840
+ "updatedAt": {
1841
+ "type": ["string", "null"],
1842
+ "format": "date-time"
1843
+ }
1844
+ },
1845
+ "required": [
1846
+ "locale",
1847
+ "completedAt",
1848
+ "approvedAt",
1849
+ "publishedAt",
1850
+ "createdAt",
1851
+ "updatedAt"
1852
+ ]
1853
+ }
1854
+ },
1855
+ "sourceFile": {
1892
1856
  "type": "object",
1893
1857
  "properties": {
1858
+ "id": {
1859
+ "type": "string"
1860
+ },
1894
1861
  "branchId": {
1895
- "type": "string",
1896
- "minLength": 1
1862
+ "type": "string"
1897
1863
  },
1898
1864
  "fileId": {
1899
- "type": "string",
1900
- "minLength": 1
1865
+ "type": "string"
1901
1866
  },
1902
1867
  "versionId": {
1868
+ "type": "string"
1869
+ },
1870
+ "fileName": {
1871
+ "type": "string"
1872
+ },
1873
+ "sourceLocale": {
1874
+ "type": "string"
1875
+ },
1876
+ "fileFormat": {
1877
+ "$ref": "#/components/schemas/FileFormat"
1878
+ },
1879
+ "dataFormat": {
1880
+ "type": ["string", "null"]
1881
+ },
1882
+ "createdAt": {
1903
1883
  "type": "string",
1904
- "minLength": 1
1884
+ "format": "date-time"
1885
+ },
1886
+ "updatedAt": {
1887
+ "type": "string",
1888
+ "format": "date-time"
1889
+ },
1890
+ "locales": {
1891
+ "type": "array",
1892
+ "items": {
1893
+ "type": "string"
1894
+ }
1905
1895
  }
1906
1896
  },
1907
- "required": ["fileId", "versionId"]
1908
- },
1909
- "minItems": 1
1910
- },
1911
- "locales": {
1912
- "type": "array",
1913
- "items": {
1914
- "type": "string"
1897
+ "required": [
1898
+ "id",
1899
+ "branchId",
1900
+ "fileId",
1901
+ "versionId",
1902
+ "fileName",
1903
+ "sourceLocale",
1904
+ "fileFormat",
1905
+ "dataFormat",
1906
+ "createdAt",
1907
+ "updatedAt",
1908
+ "locales"
1909
+ ]
1915
1910
  }
1916
1911
  },
1917
- "force": {
1918
- "type": "boolean",
1919
- "default": false
1920
- }
1921
- },
1922
- "required": ["files"]
1923
- }
1924
- }
1925
- }
1926
- },
1927
- "responses": {
1928
- "200": {
1929
- "description": "Context generation status",
1930
- "content": {
1931
- "application/json": {
1932
- "schema": {
1933
- "anyOf": [
1934
- {
1935
- "type": "object",
1936
- "properties": {
1937
- "status": {
1938
- "type": "string",
1939
- "enum": ["completed"]
1940
- }
1941
- },
1942
- "required": ["status"]
1943
- },
1944
- {
1945
- "type": "object",
1946
- "properties": {
1947
- "setupJobId": {
1948
- "type": "string"
1949
- },
1950
- "status": {
1951
- "type": "string",
1952
- "enum": ["queued"]
1953
- }
1954
- },
1955
- "required": ["setupJobId", "status"]
1956
- }
1957
- ]
1912
+ "required": ["translations", "sourceFile"]
1958
1913
  }
1959
1914
  }
1960
1915
  }
@@ -2019,21 +1974,6 @@
2019
1974
  }
2020
1975
  }
2021
1976
  },
2022
- "413": {
2023
- "description": "Request error",
2024
- "content": {
2025
- "application/json": {
2026
- "schema": {
2027
- "$ref": "#/components/schemas/ErrorResponse"
2028
- }
2029
- },
2030
- "text/html": {
2031
- "schema": {
2032
- "type": "string"
2033
- }
2034
- }
2035
- }
2036
- },
2037
1977
  "429": {
2038
1978
  "description": "Request error",
2039
1979
  "content": {
@@ -2065,30 +2005,23 @@
2065
2005
  }
2066
2006
  }
2067
2007
  },
2068
- "tags": ["Context"]
2008
+ "tags": ["Files"]
2069
2009
  }
2070
2010
  },
2071
- "/v2/project/setup/status/{jobId}": {
2072
- "get": {
2073
- "operationId": "getProjectContextGenerationStatus",
2074
- "summary": "Get context generation job status",
2075
- "deprecated": true,
2076
- "description": "Track a context generation job. This deprecated endpoint is retained for backward compatibility; new integrations should use `POST /v2/project/jobs/info`.",
2011
+ "/v2/project/branches/info": {
2012
+ "post": {
2013
+ "operationId": "getBranchInfo",
2014
+ "summary": "Get branch information",
2015
+ "description": "Return the Project's default branch and any branches requested by name.",
2077
2016
  "security": [
2078
2017
  {
2079
2018
  "BearerAuth": []
2019
+ },
2020
+ {
2021
+ "UserBearerAuth": []
2080
2022
  }
2081
2023
  ],
2082
2024
  "parameters": [
2083
- {
2084
- "schema": {
2085
- "type": "string",
2086
- "minLength": 1
2087
- },
2088
- "required": true,
2089
- "name": "jobId",
2090
- "in": "path"
2091
- },
2092
2025
  {
2093
2026
  "schema": {
2094
2027
  "type": "string",
@@ -2108,45 +2041,59 @@
2108
2041
  {
2109
2042
  "schema": {
2110
2043
  "type": "string",
2111
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
2044
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
2112
2045
  },
2113
2046
  "required": false,
2114
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
2047
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
2115
2048
  "name": "gt-project-id",
2116
2049
  "in": "header"
2117
2050
  }
2118
2051
  ],
2052
+ "requestBody": {
2053
+ "required": true,
2054
+ "content": {
2055
+ "application/json": {
2056
+ "schema": {
2057
+ "type": "object",
2058
+ "properties": {
2059
+ "branchNames": {
2060
+ "type": "array",
2061
+ "items": {
2062
+ "type": "string"
2063
+ },
2064
+ "default": []
2065
+ }
2066
+ }
2067
+ }
2068
+ }
2069
+ }
2070
+ },
2119
2071
  "responses": {
2120
2072
  "200": {
2121
- "description": "Context generation job status",
2073
+ "description": "Branch information",
2122
2074
  "content": {
2123
2075
  "application/json": {
2124
2076
  "schema": {
2125
- "anyOf": [
2126
- {
2127
- "type": "object",
2128
- "properties": {
2129
- "status": {
2130
- "type": "string",
2131
- "enum": ["completed"]
2132
- }
2133
- },
2134
- "required": ["status"]
2077
+ "type": "object",
2078
+ "properties": {
2079
+ "branches": {
2080
+ "type": "array",
2081
+ "items": {
2082
+ "$ref": "#/components/schemas/Branch"
2083
+ }
2135
2084
  },
2136
- {
2137
- "type": "object",
2138
- "properties": {
2139
- "jobId": {
2140
- "type": "string"
2085
+ "defaultBranch": {
2086
+ "allOf": [
2087
+ {
2088
+ "$ref": "#/components/schemas/Branch"
2141
2089
  },
2142
- "status": {
2143
- "type": "string",
2144
- "enum": ["queued", "processing", "failed", "unknown"]
2090
+ {
2091
+ "type": ["object", "null"]
2145
2092
  }
2146
- },
2147
- "required": ["jobId", "status"]
2093
+ ]
2148
2094
  }
2149
- ]
2095
+ },
2096
+ "required": ["branches", "defaultBranch"]
2150
2097
  }
2151
2098
  }
2152
2099
  }
@@ -2196,7 +2143,7 @@
2196
2143
  }
2197
2144
  }
2198
2145
  },
2199
- "404": {
2146
+ "413": {
2200
2147
  "description": "Request error",
2201
2148
  "content": {
2202
2149
  "application/json": {
@@ -2242,17 +2189,20 @@
2242
2189
  }
2243
2190
  }
2244
2191
  },
2245
- "tags": ["Context"]
2192
+ "tags": ["Project"]
2246
2193
  }
2247
2194
  },
2248
- "/v2/project/translations/enqueue": {
2195
+ "/v2/project/branches/create": {
2249
2196
  "post": {
2250
- "operationId": "enqueueFileTranslations",
2251
- "summary": "Queue files for translation",
2252
- "description": "Enqueue uploaded source files for background translation. Max 100 files per request. The response shape depends on the requested `gt-api-version`.",
2197
+ "operationId": "createBranch",
2198
+ "summary": "Create a branch",
2199
+ "description": "Create a new branch, or rename and confirm the default branch.",
2253
2200
  "security": [
2254
2201
  {
2255
2202
  "BearerAuth": []
2203
+ },
2204
+ {
2205
+ "UserBearerAuth": []
2256
2206
  }
2257
2207
  ],
2258
2208
  "parameters": [
@@ -2275,10 +2225,10 @@
2275
2225
  {
2276
2226
  "schema": {
2277
2227
  "type": "string",
2278
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
2228
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
2279
2229
  },
2280
2230
  "required": false,
2281
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
2231
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
2282
2232
  "name": "gt-project-id",
2283
2233
  "in": "header"
2284
2234
  }
@@ -2290,297 +2240,38 @@
2290
2240
  "schema": {
2291
2241
  "type": "object",
2292
2242
  "properties": {
2293
- "files": {
2294
- "type": "array",
2295
- "items": {
2296
- "type": "object",
2297
- "properties": {
2298
- "branchId": {
2299
- "type": "string",
2300
- "minLength": 1
2301
- },
2302
- "fileId": {
2303
- "type": "string",
2304
- "minLength": 1
2305
- },
2306
- "versionId": {
2307
- "type": "string",
2308
- "minLength": 1
2309
- },
2310
- "fileName": {
2311
- "type": "string"
2312
- },
2313
- "transformFormat": {
2314
- "type": "string",
2315
- "enum": [
2316
- "GTJSON",
2317
- "MDX",
2318
- "JSON",
2319
- "YAML",
2320
- "MD",
2321
- "TS",
2322
- "JS",
2323
- "HTML",
2324
- "TXT",
2325
- "PO",
2326
- "POT",
2327
- "TWILIO_CONTENT_JSON",
2328
- "LOTTIE",
2329
- "SVG",
2330
- "DOT_STRINGS",
2331
- "DOT_STRINGSDICT",
2332
- "ANDROID_STRINGS",
2333
- "XCSTRINGS"
2334
- ]
2335
- }
2336
- },
2337
- "required": ["fileId", "versionId"]
2338
- },
2339
- "minItems": 1,
2340
- "maxItems": 100
2341
- },
2342
- "targetLocales": {
2343
- "type": "array",
2344
- "items": {
2345
- "type": "string"
2346
- }
2347
- },
2348
- "sourceLocale": {
2349
- "type": "string"
2243
+ "branchName": {
2244
+ "type": "string",
2245
+ "minLength": 1
2350
2246
  },
2351
- "force": {
2247
+ "defaultBranch": {
2352
2248
  "type": "boolean",
2353
2249
  "default": false
2354
- },
2355
- "modelProvider": {
2356
- "$ref": "#/components/schemas/ModelProvider"
2357
- },
2358
- "publish": {
2359
- "type": "boolean"
2360
2250
  }
2361
2251
  },
2362
- "required": ["files"]
2252
+ "required": ["branchName"]
2363
2253
  }
2364
2254
  }
2365
2255
  }
2366
2256
  },
2367
2257
  "responses": {
2368
2258
  "200": {
2369
- "description": "Enqueued translations. Shape depends on gt-api-version (legacy before 2025-11-03.v1).",
2259
+ "description": "Created or existing branch",
2370
2260
  "content": {
2371
2261
  "application/json": {
2372
2262
  "schema": {
2373
- "anyOf": [
2374
- {
2375
- "type": "object",
2376
- "properties": {
2377
- "jobData": {
2378
- "type": "object",
2379
- "additionalProperties": {
2380
- "type": "object",
2381
- "properties": {
2382
- "kind": {
2383
- "type": "string",
2384
- "enum": ["file_translation"]
2385
- },
2386
- "sourceFileId": {
2387
- "type": "string"
2388
- },
2389
- "fileId": {
2390
- "type": "string"
2391
- },
2392
- "versionId": {
2393
- "type": "string"
2394
- },
2395
- "branchId": {
2396
- "type": "string"
2397
- },
2398
- "targetLocale": {
2399
- "type": "string"
2400
- },
2401
- "projectId": {
2402
- "type": "string"
2403
- },
2404
- "force": {
2405
- "type": "boolean"
2406
- },
2407
- "outputFileFormat": {
2408
- "$ref": "#/components/schemas/FileFormat"
2409
- },
2410
- "modelProvider": {
2411
- "$ref": "#/components/schemas/ModelProvider"
2412
- },
2413
- "glossaryRetranslate": {
2414
- "type": "boolean"
2415
- },
2416
- "changedGlossaryTerms": {
2417
- "type": "array",
2418
- "items": {
2419
- "type": "string"
2420
- }
2421
- },
2422
- "onComplete": {
2423
- "type": "object",
2424
- "properties": {
2425
- "kind": {
2426
- "type": "string",
2427
- "enum": ["google_drive_apply"]
2428
- },
2429
- "userId": {
2430
- "type": "string"
2431
- }
2432
- },
2433
- "required": ["kind"]
2434
- }
2435
- },
2436
- "required": [
2437
- "sourceFileId",
2438
- "fileId",
2439
- "versionId",
2440
- "branchId",
2441
- "targetLocale",
2442
- "projectId",
2443
- "force"
2444
- ]
2445
- }
2446
- },
2447
- "locales": {
2448
- "type": "array",
2449
- "items": {
2450
- "type": "string"
2451
- }
2452
- },
2453
- "message": {
2454
- "type": "string"
2455
- }
2456
- },
2457
- "required": ["jobData", "locales", "message"]
2458
- },
2459
- {
2460
- "type": "object",
2461
- "properties": {
2462
- "translations": {
2463
- "type": "array",
2464
- "items": {
2465
- "type": "object",
2466
- "properties": {
2467
- "locale": {
2468
- "type": "string"
2469
- },
2470
- "metadata": {},
2471
- "fileId": {
2472
- "type": "string"
2473
- },
2474
- "fileName": {
2475
- "type": "string"
2476
- },
2477
- "versionId": {
2478
- "type": "string"
2479
- },
2480
- "branchId": {
2481
- "type": "string"
2482
- },
2483
- "id": {
2484
- "type": "string"
2485
- },
2486
- "isReady": {
2487
- "type": "boolean"
2488
- },
2489
- "downloadUrl": {
2490
- "type": "string"
2491
- }
2492
- },
2493
- "required": [
2494
- "locale",
2495
- "fileId",
2496
- "fileName",
2497
- "versionId",
2498
- "branchId",
2499
- "id",
2500
- "isReady",
2501
- "downloadUrl"
2502
- ]
2503
- }
2504
- },
2505
- "data": {
2506
- "type": "object",
2507
- "additionalProperties": {
2508
- "type": "object",
2509
- "properties": {
2510
- "fileName": {
2511
- "type": "string"
2512
- },
2513
- "versionId": {
2514
- "type": "string"
2515
- }
2516
- },
2517
- "required": ["fileName", "versionId"]
2518
- }
2519
- },
2520
- "locales": {
2521
- "type": "array",
2522
- "items": {
2523
- "type": "string"
2524
- }
2525
- },
2526
- "message": {
2527
- "type": "string"
2528
- }
2529
- },
2530
- "required": ["translations", "data", "locales", "message"]
2263
+ "type": "object",
2264
+ "properties": {
2265
+ "branch": {
2266
+ "$ref": "#/components/schemas/Branch"
2531
2267
  }
2532
- ]
2268
+ },
2269
+ "required": ["branch"]
2533
2270
  }
2534
2271
  }
2535
2272
  }
2536
2273
  },
2537
2274
  "400": {
2538
- "description": "Invalid request or missing source files",
2539
- "content": {
2540
- "application/json": {
2541
- "schema": {
2542
- "anyOf": [
2543
- {
2544
- "$ref": "#/components/schemas/ErrorResponse"
2545
- },
2546
- {
2547
- "type": "object",
2548
- "properties": {
2549
- "error": {
2550
- "type": "string"
2551
- },
2552
- "missing": {
2553
- "type": "array",
2554
- "items": {
2555
- "type": "object",
2556
- "properties": {
2557
- "fileId": {
2558
- "type": "string"
2559
- },
2560
- "versionId": {
2561
- "type": "string"
2562
- }
2563
- },
2564
- "required": ["fileId", "versionId"]
2565
- }
2566
- },
2567
- "count": {
2568
- "type": "number"
2569
- }
2570
- },
2571
- "required": ["error", "missing", "count"]
2572
- }
2573
- ]
2574
- }
2575
- },
2576
- "text/html": {
2577
- "schema": {
2578
- "type": "string"
2579
- }
2580
- }
2581
- }
2582
- },
2583
- "401": {
2584
2275
  "description": "Request error",
2585
2276
  "content": {
2586
2277
  "application/json": {
@@ -2595,7 +2286,7 @@
2595
2286
  }
2596
2287
  }
2597
2288
  },
2598
- "402": {
2289
+ "401": {
2599
2290
  "description": "Request error",
2600
2291
  "content": {
2601
2292
  "application/json": {
@@ -2625,7 +2316,7 @@
2625
2316
  }
2626
2317
  }
2627
2318
  },
2628
- "404": {
2319
+ "409": {
2629
2320
  "description": "Request error",
2630
2321
  "content": {
2631
2322
  "application/json": {
@@ -2686,17 +2377,20 @@
2686
2377
  }
2687
2378
  }
2688
2379
  },
2689
- "tags": ["Translation"]
2380
+ "tags": ["Project"]
2690
2381
  }
2691
2382
  },
2692
- "/v2/project/files/publish": {
2383
+ "/v2/project/tags/create": {
2693
2384
  "post": {
2694
- "operationId": "publishFiles",
2695
- "summary": "Publish or unpublish files",
2696
- "description": "Publish or unpublish translated files to the CDN. Requires CDN to be enabled.",
2385
+ "operationId": "createTag",
2386
+ "summary": "Create or update a tag",
2387
+ "description": "Create or upsert a tag that points at a set of file versions.",
2697
2388
  "security": [
2698
2389
  {
2699
2390
  "BearerAuth": []
2391
+ },
2392
+ {
2393
+ "UserBearerAuth": []
2700
2394
  }
2701
2395
  ],
2702
2396
  "parameters": [
@@ -2719,10 +2413,10 @@
2719
2413
  {
2720
2414
  "schema": {
2721
2415
  "type": "string",
2722
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
2416
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
2723
2417
  },
2724
2418
  "required": false,
2725
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
2419
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
2726
2420
  "name": "gt-project-id",
2727
2421
  "in": "header"
2728
2422
  }
@@ -2734,6 +2428,11 @@
2734
2428
  "schema": {
2735
2429
  "type": "object",
2736
2430
  "properties": {
2431
+ "tagId": {
2432
+ "type": "string",
2433
+ "minLength": 1,
2434
+ "maxLength": 255
2435
+ },
2737
2436
  "files": {
2738
2437
  "type": "array",
2739
2438
  "items": {
@@ -2750,83 +2449,66 @@
2750
2449
  "branchId": {
2751
2450
  "type": "string",
2752
2451
  "minLength": 1
2753
- },
2754
- "publish": {
2755
- "type": "boolean"
2756
2452
  }
2757
2453
  },
2758
- "required": ["fileId", "versionId", "publish"]
2454
+ "required": ["fileId", "versionId", "branchId"]
2759
2455
  },
2760
2456
  "minItems": 1
2457
+ },
2458
+ "message": {
2459
+ "type": "string",
2460
+ "maxLength": 255
2761
2461
  }
2762
2462
  },
2763
- "required": ["files"]
2463
+ "required": ["tagId", "files"]
2764
2464
  }
2765
2465
  }
2766
2466
  }
2767
2467
  },
2768
2468
  "responses": {
2769
2469
  "200": {
2770
- "description": "File publish results",
2470
+ "description": "Created or updated file tag",
2771
2471
  "content": {
2772
2472
  "application/json": {
2773
2473
  "schema": {
2774
2474
  "type": "object",
2775
2475
  "properties": {
2776
- "results": {
2777
- "type": "array",
2778
- "items": {
2779
- "type": "object",
2780
- "properties": {
2781
- "fileId": {
2782
- "type": "string"
2783
- },
2784
- "versionId": {
2785
- "type": "string"
2786
- },
2787
- "locale": {
2788
- "type": "string"
2789
- },
2790
- "branchId": {
2791
- "type": "string"
2792
- },
2793
- "success": {
2794
- "type": "boolean"
2795
- },
2796
- "error": {
2797
- "type": "string"
2798
- }
2476
+ "tag": {
2477
+ "type": "object",
2478
+ "properties": {
2479
+ "id": {
2480
+ "type": "string"
2799
2481
  },
2800
- "required": [
2801
- "fileId",
2802
- "versionId",
2803
- "branchId",
2804
- "success"
2805
- ]
2806
- }
2807
- }
2808
- },
2809
- "required": ["results"]
2810
- }
2811
- }
2812
- }
2813
- },
2814
- "400": {
2815
- "description": "Request error",
2816
- "content": {
2817
- "application/json": {
2818
- "schema": {
2819
- "$ref": "#/components/schemas/ErrorResponse"
2820
- }
2821
- },
2822
- "text/html": {
2823
- "schema": {
2824
- "type": "string"
2825
- }
2826
- }
2827
- }
2482
+ "tagId": {
2483
+ "type": "string"
2484
+ },
2485
+ "message": {
2486
+ "type": ["string", "null"]
2487
+ },
2488
+ "createdAt": {
2489
+ "type": "string",
2490
+ "format": "date-time"
2491
+ },
2492
+ "updatedAt": {
2493
+ "type": "string",
2494
+ "format": "date-time"
2495
+ }
2496
+ },
2497
+ "required": [
2498
+ "id",
2499
+ "tagId",
2500
+ "message",
2501
+ "createdAt",
2502
+ "updatedAt"
2503
+ ]
2504
+ }
2505
+ },
2506
+ "required": ["tag"]
2507
+ }
2508
+ }
2509
+ }
2828
2510
  },
2829
- "401": {
2511
+ "400": {
2830
2512
  "description": "Request error",
2831
2513
  "content": {
2832
2514
  "application/json": {
@@ -2841,7 +2523,7 @@
2841
2523
  }
2842
2524
  }
2843
2525
  },
2844
- "403": {
2526
+ "401": {
2845
2527
  "description": "Request error",
2846
2528
  "content": {
2847
2529
  "application/json": {
@@ -2856,7 +2538,7 @@
2856
2538
  }
2857
2539
  }
2858
2540
  },
2859
- "404": {
2541
+ "403": {
2860
2542
  "description": "Request error",
2861
2543
  "content": {
2862
2544
  "application/json": {
@@ -2917,54 +2599,23 @@
2917
2599
  }
2918
2600
  }
2919
2601
  },
2920
- "tags": ["Files"]
2602
+ "tags": ["Project"]
2921
2603
  }
2922
2604
  },
2923
- "/v2/project/files/download/{fileId}": {
2924
- "get": {
2925
- "operationId": "downloadFile",
2926
- "summary": "Download a single file",
2927
- "deprecated": true,
2928
- "description": "Download a single source or translated file. This deprecated endpoint is retained for backward compatibility; new integrations should use `POST /v2/project/files/download`.",
2605
+ "/v2/project/assets": {
2606
+ "post": {
2607
+ "operationId": "uploadAssets",
2608
+ "summary": "Upload Project assets",
2609
+ "description": "Upload OpenType or TrueType fonts through a Project and make them available to Lottie translation workflows across its Organization. Each font is keyed by a normalized identity derived from its family, weight, and italic style (from the supplied `family` and `style`, or from the font metadata and file name). Re-uploading the same identity overwrites the existing asset, so complete retries after a `500` response are safe.",
2929
2610
  "security": [
2930
2611
  {
2931
2612
  "BearerAuth": []
2613
+ },
2614
+ {
2615
+ "UserBearerAuth": []
2932
2616
  }
2933
2617
  ],
2934
2618
  "parameters": [
2935
- {
2936
- "schema": {
2937
- "type": "string",
2938
- "minLength": 1
2939
- },
2940
- "required": true,
2941
- "name": "fileId",
2942
- "in": "path"
2943
- },
2944
- {
2945
- "schema": {
2946
- "type": "string"
2947
- },
2948
- "required": false,
2949
- "name": "branchId",
2950
- "in": "query"
2951
- },
2952
- {
2953
- "schema": {
2954
- "type": "string"
2955
- },
2956
- "required": false,
2957
- "name": "versionId",
2958
- "in": "query"
2959
- },
2960
- {
2961
- "schema": {
2962
- "type": "string"
2963
- },
2964
- "required": false,
2965
- "name": "locale",
2966
- "in": "query"
2967
- },
2968
2619
  {
2969
2620
  "schema": {
2970
2621
  "type": "string",
@@ -2984,27 +2635,94 @@
2984
2635
  {
2985
2636
  "schema": {
2986
2637
  "type": "string",
2987
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
2638
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
2988
2639
  },
2989
2640
  "required": false,
2990
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
2641
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
2991
2642
  "name": "gt-project-id",
2992
2643
  "in": "header"
2993
2644
  }
2994
2645
  ],
2646
+ "requestBody": {
2647
+ "required": true,
2648
+ "content": {
2649
+ "application/json": {
2650
+ "schema": {
2651
+ "type": "object",
2652
+ "properties": {
2653
+ "assets": {
2654
+ "type": "array",
2655
+ "items": {
2656
+ "type": "object",
2657
+ "properties": {
2658
+ "assetType": {
2659
+ "type": "string",
2660
+ "enum": ["FONT"]
2661
+ },
2662
+ "content": {
2663
+ "type": "string",
2664
+ "minLength": 1
2665
+ },
2666
+ "fileName": {
2667
+ "type": "string",
2668
+ "minLength": 1,
2669
+ "maxLength": 255,
2670
+ "pattern": "\\.([tT][tT][fF]|[oO][tT][fF])$"
2671
+ },
2672
+ "family": {
2673
+ "type": "string",
2674
+ "minLength": 1,
2675
+ "maxLength": 255
2676
+ },
2677
+ "style": {
2678
+ "type": "string",
2679
+ "minLength": 1,
2680
+ "maxLength": 100
2681
+ }
2682
+ },
2683
+ "required": ["assetType", "content", "fileName"]
2684
+ },
2685
+ "minItems": 1,
2686
+ "maxItems": 50
2687
+ }
2688
+ },
2689
+ "required": ["assets"]
2690
+ }
2691
+ }
2692
+ }
2693
+ },
2995
2694
  "responses": {
2996
- "200": {
2997
- "description": "Downloaded file",
2695
+ "201": {
2696
+ "description": "Uploaded assets",
2998
2697
  "content": {
2999
2698
  "application/json": {
3000
2699
  "schema": {
3001
2700
  "type": "object",
3002
2701
  "properties": {
3003
- "data": {
3004
- "type": "string"
2702
+ "assets": {
2703
+ "type": "array",
2704
+ "items": {
2705
+ "type": "object",
2706
+ "properties": {
2707
+ "id": {
2708
+ "type": "string"
2709
+ },
2710
+ "assetKey": {
2711
+ "type": "string"
2712
+ },
2713
+ "fileName": {
2714
+ "type": "string"
2715
+ }
2716
+ },
2717
+ "required": ["id", "assetKey", "fileName"]
2718
+ }
2719
+ },
2720
+ "count": {
2721
+ "type": "integer",
2722
+ "minimum": 0
3005
2723
  }
3006
2724
  },
3007
- "required": ["data"]
2725
+ "required": ["assets", "count"]
3008
2726
  }
3009
2727
  }
3010
2728
  }
@@ -3069,22 +2787,17 @@
3069
2787
  }
3070
2788
  }
3071
2789
  },
3072
- "425": {
3073
- "description": "Translation is still processing",
2790
+ "413": {
2791
+ "description": "Request error",
3074
2792
  "content": {
3075
2793
  "application/json": {
3076
2794
  "schema": {
3077
- "type": "object",
3078
- "properties": {
3079
- "status": {
3080
- "type": "string",
3081
- "enum": ["processing"]
3082
- },
3083
- "message": {
3084
- "type": "string"
3085
- }
3086
- },
3087
- "required": ["status", "message"]
2795
+ "$ref": "#/components/schemas/ErrorResponse"
2796
+ }
2797
+ },
2798
+ "text/html": {
2799
+ "schema": {
2800
+ "type": "string"
3088
2801
  }
3089
2802
  }
3090
2803
  }
@@ -3120,17 +2833,20 @@
3120
2833
  }
3121
2834
  }
3122
2835
  },
3123
- "tags": ["Files"]
2836
+ "tags": ["Project"]
3124
2837
  }
3125
2838
  },
3126
- "/v2/project/files/download": {
2839
+ "/v2/project/files/diffs": {
3127
2840
  "post": {
3128
- "operationId": "downloadFiles",
3129
- "summary": "Download multiple files",
3130
- "description": "Download up to 100 source or translated files in one request.",
2841
+ "operationId": "submitUserEditDiffs",
2842
+ "summary": "Submit translation diffs",
2843
+ "description": "Overwrite translations with user-provided localized content.",
3131
2844
  "security": [
3132
2845
  {
3133
2846
  "BearerAuth": []
2847
+ },
2848
+ {
2849
+ "UserBearerAuth": []
3134
2850
  }
3135
2851
  ],
3136
2852
  "parameters": [
@@ -3153,10 +2869,10 @@
3153
2869
  {
3154
2870
  "schema": {
3155
2871
  "type": "string",
3156
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
2872
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
3157
2873
  },
3158
2874
  "required": false,
3159
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
2875
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
3160
2876
  "name": "gt-project-id",
3161
2877
  "in": "header"
3162
2878
  }
@@ -3166,121 +2882,76 @@
3166
2882
  "content": {
3167
2883
  "application/json": {
3168
2884
  "schema": {
3169
- "type": "array",
3170
- "items": {
2885
+ "type": "object",
2886
+ "properties": {
2887
+ "projectId": {
2888
+ "type": "string"
2889
+ },
2890
+ "diffs": {
2891
+ "type": "array",
2892
+ "items": {
2893
+ "type": "object",
2894
+ "properties": {
2895
+ "locale": {
2896
+ "type": "string",
2897
+ "minLength": 1
2898
+ },
2899
+ "diff": {
2900
+ "type": "string"
2901
+ },
2902
+ "branchId": {
2903
+ "type": "string",
2904
+ "minLength": 1
2905
+ },
2906
+ "versionId": {
2907
+ "type": "string",
2908
+ "minLength": 1
2909
+ },
2910
+ "fileId": {
2911
+ "type": "string",
2912
+ "minLength": 1
2913
+ },
2914
+ "localContent": {
2915
+ "type": "string"
2916
+ }
2917
+ },
2918
+ "required": [
2919
+ "locale",
2920
+ "diff",
2921
+ "versionId",
2922
+ "fileId",
2923
+ "localContent"
2924
+ ]
2925
+ },
2926
+ "minItems": 1
2927
+ }
2928
+ },
2929
+ "required": ["diffs"]
2930
+ }
2931
+ }
2932
+ }
2933
+ },
2934
+ "responses": {
2935
+ "200": {
2936
+ "description": "Processed user translation edits",
2937
+ "content": {
2938
+ "application/json": {
2939
+ "schema": {
3171
2940
  "type": "object",
3172
2941
  "properties": {
3173
- "fileId": {
3174
- "type": "string",
3175
- "minLength": 1
2942
+ "filesProcessed": {
2943
+ "type": "integer",
2944
+ "minimum": 0
3176
2945
  },
3177
- "branchId": {
3178
- "type": "string",
3179
- "minLength": 1
3180
- },
3181
- "versionId": {
3182
- "type": "string",
3183
- "minLength": 1
3184
- },
3185
- "locale": {
3186
- "type": "string",
3187
- "minLength": 1
3188
- },
3189
- "useLatestAvailableVersion": {
3190
- "type": "boolean"
3191
- }
3192
- },
3193
- "required": ["fileId"]
3194
- },
3195
- "minItems": 1,
3196
- "maxItems": 100
3197
- }
3198
- }
3199
- }
3200
- },
3201
- "responses": {
3202
- "200": {
3203
- "description": "Downloaded files",
3204
- "content": {
3205
- "application/json": {
3206
- "schema": {
3207
- "type": "object",
3208
- "properties": {
3209
- "files": {
3210
- "type": "array",
3211
- "items": {
3212
- "type": "object",
3213
- "properties": {
3214
- "id": {
3215
- "type": "string"
3216
- },
3217
- "branchId": {
3218
- "type": "string"
3219
- },
3220
- "fileId": {
3221
- "type": "string"
3222
- },
3223
- "versionId": {
3224
- "type": "string"
3225
- },
3226
- "locale": {
3227
- "type": "string"
3228
- },
3229
- "fileName": {
3230
- "type": "string"
3231
- },
3232
- "data": {
3233
- "type": "string"
3234
- },
3235
- "metadata": {
3236
- "$ref": "#/components/schemas/JsonObject"
3237
- },
3238
- "fileFormat": {
3239
- "$ref": "#/components/schemas/FileFormat"
3240
- }
3241
- },
3242
- "required": [
3243
- "id",
3244
- "branchId",
3245
- "fileId",
3246
- "versionId",
3247
- "data",
3248
- "metadata",
3249
- "fileFormat"
3250
- ]
3251
- }
3252
- },
3253
- "count": {
3254
- "type": "number"
2946
+ "entriesReceived": {
2947
+ "type": "integer",
2948
+ "minimum": 0
3255
2949
  },
3256
- "pending": {
3257
- "type": "array",
3258
- "items": {
3259
- "type": "object",
3260
- "properties": {
3261
- "branchId": {
3262
- "type": "string"
3263
- },
3264
- "fileId": {
3265
- "type": "string"
3266
- },
3267
- "locale": {
3268
- "type": "string"
3269
- },
3270
- "versionId": {
3271
- "type": "string"
3272
- }
3273
- },
3274
- "required": [
3275
- "branchId",
3276
- "fileId",
3277
- "locale",
3278
- "versionId"
3279
- ]
3280
- }
2950
+ "message": {
2951
+ "type": "string"
3281
2952
  }
3282
2953
  },
3283
- "required": ["files", "count"]
2954
+ "required": ["filesProcessed", "entriesReceived", "message"]
3284
2955
  }
3285
2956
  }
3286
2957
  }
@@ -3379,14 +3050,17 @@
3379
3050
  "tags": ["Files"]
3380
3051
  }
3381
3052
  },
3382
- "/v2/project/branches/info": {
3053
+ "/v2/project/files/moves": {
3383
3054
  "post": {
3384
- "operationId": "getBranchInfo",
3385
- "summary": "Get branch information",
3386
- "description": "Return the Project's default branch and any branches requested by name.",
3055
+ "operationId": "processFileMoves",
3056
+ "summary": "Move or rename files",
3057
+ "description": "Clone source files and their translations under new file IDs.",
3387
3058
  "security": [
3388
3059
  {
3389
3060
  "BearerAuth": []
3061
+ },
3062
+ {
3063
+ "UserBearerAuth": []
3390
3064
  }
3391
3065
  ],
3392
3066
  "parameters": [
@@ -3409,10 +3083,10 @@
3409
3083
  {
3410
3084
  "schema": {
3411
3085
  "type": "string",
3412
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
3086
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
3413
3087
  },
3414
3088
  "required": false,
3415
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
3089
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
3416
3090
  "name": "gt-project-id",
3417
3091
  "in": "header"
3418
3092
  }
@@ -3424,44 +3098,91 @@
3424
3098
  "schema": {
3425
3099
  "type": "object",
3426
3100
  "properties": {
3427
- "branchNames": {
3101
+ "branchId": {
3102
+ "type": "string"
3103
+ },
3104
+ "moves": {
3428
3105
  "type": "array",
3429
3106
  "items": {
3430
- "type": "string"
3431
- },
3432
- "default": []
3107
+ "type": "object",
3108
+ "properties": {
3109
+ "oldFileId": {
3110
+ "type": "string",
3111
+ "minLength": 1
3112
+ },
3113
+ "newFileId": {
3114
+ "type": "string",
3115
+ "minLength": 1
3116
+ },
3117
+ "newFileName": {
3118
+ "type": "string",
3119
+ "minLength": 1
3120
+ }
3121
+ },
3122
+ "required": ["oldFileId", "newFileId", "newFileName"]
3123
+ }
3433
3124
  }
3434
- }
3125
+ },
3126
+ "required": ["moves"]
3435
3127
  }
3436
3128
  }
3437
3129
  }
3438
3130
  },
3439
3131
  "responses": {
3440
3132
  "200": {
3441
- "description": "Branch information",
3133
+ "description": "File move results",
3442
3134
  "content": {
3443
3135
  "application/json": {
3444
3136
  "schema": {
3445
3137
  "type": "object",
3446
3138
  "properties": {
3447
- "branches": {
3139
+ "results": {
3448
3140
  "type": "array",
3449
3141
  "items": {
3450
- "$ref": "#/components/schemas/Branch"
3142
+ "type": "object",
3143
+ "properties": {
3144
+ "oldFileId": {
3145
+ "type": "string"
3146
+ },
3147
+ "newFileId": {
3148
+ "type": "string"
3149
+ },
3150
+ "success": {
3151
+ "type": "boolean"
3152
+ },
3153
+ "newSourceFileId": {
3154
+ "type": "string"
3155
+ },
3156
+ "clonedTranslationsCount": {
3157
+ "type": "integer"
3158
+ },
3159
+ "error": {
3160
+ "type": "string"
3161
+ }
3162
+ },
3163
+ "required": ["oldFileId", "newFileId", "success"]
3451
3164
  }
3452
3165
  },
3453
- "defaultBranch": {
3454
- "allOf": [
3455
- {
3456
- "$ref": "#/components/schemas/Branch"
3166
+ "summary": {
3167
+ "type": "object",
3168
+ "properties": {
3169
+ "total": {
3170
+ "type": "integer",
3171
+ "minimum": 0
3457
3172
  },
3458
- {
3459
- "type": ["object", "null"]
3173
+ "succeeded": {
3174
+ "type": "integer",
3175
+ "minimum": 0
3176
+ },
3177
+ "failed": {
3178
+ "type": "integer",
3179
+ "minimum": 0
3460
3180
  }
3461
- ]
3181
+ },
3182
+ "required": ["total", "succeeded", "failed"]
3462
3183
  }
3463
3184
  },
3464
- "required": ["branches", "defaultBranch"]
3185
+ "required": ["results"]
3465
3186
  }
3466
3187
  }
3467
3188
  }
@@ -3511,6 +3232,21 @@
3511
3232
  }
3512
3233
  }
3513
3234
  },
3235
+ "404": {
3236
+ "description": "Request error",
3237
+ "content": {
3238
+ "application/json": {
3239
+ "schema": {
3240
+ "$ref": "#/components/schemas/ErrorResponse"
3241
+ }
3242
+ },
3243
+ "text/html": {
3244
+ "schema": {
3245
+ "type": "string"
3246
+ }
3247
+ }
3248
+ }
3249
+ },
3514
3250
  "413": {
3515
3251
  "description": "Request error",
3516
3252
  "content": {
@@ -3557,17 +3293,20 @@
3557
3293
  }
3558
3294
  }
3559
3295
  },
3560
- "tags": ["Project"]
3296
+ "tags": ["Files"]
3561
3297
  }
3562
3298
  },
3563
- "/v2/project/branches/create": {
3299
+ "/v2/project/files/orphaned": {
3564
3300
  "post": {
3565
- "operationId": "createBranch",
3566
- "summary": "Create a branch",
3567
- "description": "Create a new branch, or rename and confirm the default branch.",
3301
+ "operationId": "getOrphanedFiles",
3302
+ "summary": "Find orphaned files",
3303
+ "description": "Return files on a branch that are not present in the provided file ID list.",
3568
3304
  "security": [
3569
3305
  {
3570
3306
  "BearerAuth": []
3307
+ },
3308
+ {
3309
+ "UserBearerAuth": []
3571
3310
  }
3572
3311
  ],
3573
3312
  "parameters": [
@@ -3590,10 +3329,10 @@
3590
3329
  {
3591
3330
  "schema": {
3592
3331
  "type": "string",
3593
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
3332
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
3594
3333
  },
3595
3334
  "required": false,
3596
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
3335
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
3597
3336
  "name": "gt-project-id",
3598
3337
  "in": "header"
3599
3338
  }
@@ -3605,44 +3344,62 @@
3605
3344
  "schema": {
3606
3345
  "type": "object",
3607
3346
  "properties": {
3608
- "branchName": {
3347
+ "branchId": {
3609
3348
  "type": "string",
3610
3349
  "minLength": 1
3611
3350
  },
3612
- "defaultBranch": {
3613
- "type": "boolean",
3614
- "default": false
3351
+ "fileIds": {
3352
+ "type": "array",
3353
+ "items": {
3354
+ "type": "string"
3355
+ },
3356
+ "default": []
3615
3357
  }
3616
3358
  },
3617
- "required": ["branchName"]
3359
+ "required": ["branchId"]
3618
3360
  }
3619
3361
  }
3620
3362
  }
3621
3363
  },
3622
3364
  "responses": {
3623
3365
  "200": {
3624
- "description": "Created or existing branch",
3366
+ "description": "Files present on the branch but absent from the request",
3625
3367
  "content": {
3626
3368
  "application/json": {
3627
3369
  "schema": {
3628
3370
  "type": "object",
3629
3371
  "properties": {
3630
- "branch": {
3631
- "$ref": "#/components/schemas/Branch"
3632
- }
3633
- },
3634
- "required": ["branch"]
3635
- }
3636
- }
3637
- }
3638
- },
3639
- "400": {
3640
- "description": "Request error",
3641
- "content": {
3642
- "application/json": {
3643
- "schema": {
3644
- "$ref": "#/components/schemas/ErrorResponse"
3645
- }
3372
+ "orphanedFiles": {
3373
+ "type": "array",
3374
+ "items": {
3375
+ "type": "object",
3376
+ "properties": {
3377
+ "fileId": {
3378
+ "type": "string"
3379
+ },
3380
+ "versionId": {
3381
+ "type": "string"
3382
+ },
3383
+ "fileName": {
3384
+ "type": "string"
3385
+ }
3386
+ },
3387
+ "required": ["fileId", "versionId", "fileName"]
3388
+ }
3389
+ }
3390
+ },
3391
+ "required": ["orphanedFiles"]
3392
+ }
3393
+ }
3394
+ }
3395
+ },
3396
+ "400": {
3397
+ "description": "Request error",
3398
+ "content": {
3399
+ "application/json": {
3400
+ "schema": {
3401
+ "$ref": "#/components/schemas/ErrorResponse"
3402
+ }
3646
3403
  },
3647
3404
  "text/html": {
3648
3405
  "schema": {
@@ -3681,7 +3438,7 @@
3681
3438
  }
3682
3439
  }
3683
3440
  },
3684
- "409": {
3441
+ "404": {
3685
3442
  "description": "Request error",
3686
3443
  "content": {
3687
3444
  "application/json": {
@@ -3742,17 +3499,20 @@
3742
3499
  }
3743
3500
  }
3744
3501
  },
3745
- "tags": ["Project"]
3502
+ "tags": ["Files"]
3746
3503
  }
3747
3504
  },
3748
- "/v2/project/tags/create": {
3505
+ "/v2/project/files/info": {
3749
3506
  "post": {
3750
- "operationId": "createTag",
3751
- "summary": "Create or update a tag",
3752
- "description": "Create or upsert a tag that points at a set of file versions.",
3507
+ "operationId": "getFileInfo",
3508
+ "summary": "Get file metadata",
3509
+ "description": "Get detailed metadata for specific source and translated files.",
3753
3510
  "security": [
3754
3511
  {
3755
3512
  "BearerAuth": []
3513
+ },
3514
+ {
3515
+ "UserBearerAuth": []
3756
3516
  }
3757
3517
  ],
3758
3518
  "parameters": [
@@ -3775,10 +3535,10 @@
3775
3535
  {
3776
3536
  "schema": {
3777
3537
  "type": "string",
3778
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
3538
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
3779
3539
  },
3780
3540
  "required": false,
3781
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
3541
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
3782
3542
  "name": "gt-project-id",
3783
3543
  "in": "header"
3784
3544
  }
@@ -3790,12 +3550,7 @@
3790
3550
  "schema": {
3791
3551
  "type": "object",
3792
3552
  "properties": {
3793
- "tagId": {
3794
- "type": "string",
3795
- "minLength": 1,
3796
- "maxLength": 255
3797
- },
3798
- "files": {
3553
+ "sourceFiles": {
3799
3554
  "type": "array",
3800
3555
  "items": {
3801
3556
  "type": "object",
@@ -3814,58 +3569,167 @@
3814
3569
  }
3815
3570
  },
3816
3571
  "required": ["fileId", "versionId", "branchId"]
3817
- },
3818
- "minItems": 1
3572
+ }
3819
3573
  },
3820
- "message": {
3821
- "type": "string",
3822
- "maxLength": 255
3574
+ "translatedFiles": {
3575
+ "type": "array",
3576
+ "items": {
3577
+ "type": "object",
3578
+ "properties": {
3579
+ "fileId": {
3580
+ "type": "string",
3581
+ "minLength": 1
3582
+ },
3583
+ "versionId": {
3584
+ "type": "string",
3585
+ "minLength": 1
3586
+ },
3587
+ "branchId": {
3588
+ "type": "string",
3589
+ "minLength": 1
3590
+ },
3591
+ "locale": {
3592
+ "type": "string",
3593
+ "minLength": 1
3594
+ }
3595
+ },
3596
+ "required": ["fileId", "versionId", "branchId", "locale"]
3597
+ }
3823
3598
  }
3824
- },
3825
- "required": ["tagId", "files"]
3599
+ }
3826
3600
  }
3827
3601
  }
3828
3602
  }
3829
3603
  },
3830
3604
  "responses": {
3831
3605
  "200": {
3832
- "description": "Created or updated file tag",
3606
+ "description": "File information",
3833
3607
  "content": {
3834
3608
  "application/json": {
3835
3609
  "schema": {
3836
3610
  "type": "object",
3837
3611
  "properties": {
3838
- "tag": {
3839
- "type": "object",
3840
- "properties": {
3841
- "id": {
3842
- "type": "string"
3843
- },
3844
- "tagId": {
3845
- "type": "string"
3846
- },
3847
- "message": {
3848
- "type": ["string", "null"]
3612
+ "sourceFiles": {
3613
+ "type": "array",
3614
+ "items": {
3615
+ "type": "object",
3616
+ "properties": {
3617
+ "branchId": {
3618
+ "type": "string"
3619
+ },
3620
+ "fileId": {
3621
+ "type": "string"
3622
+ },
3623
+ "versionId": {
3624
+ "type": "string"
3625
+ },
3626
+ "fileName": {
3627
+ "type": "string"
3628
+ },
3629
+ "fileFormat": {
3630
+ "$ref": "#/components/schemas/FileFormat"
3631
+ },
3632
+ "dataFormat": {
3633
+ "type": ["string", "null"]
3634
+ },
3635
+ "createdAt": {
3636
+ "type": "string",
3637
+ "format": "date-time"
3638
+ },
3639
+ "updatedAt": {
3640
+ "type": "string",
3641
+ "format": "date-time"
3642
+ },
3643
+ "publishedAt": {
3644
+ "type": ["string", "null"],
3645
+ "format": "date-time"
3646
+ },
3647
+ "locales": {
3648
+ "type": "array",
3649
+ "items": {
3650
+ "type": "string"
3651
+ }
3652
+ },
3653
+ "sourceLocale": {
3654
+ "type": "string"
3655
+ }
3849
3656
  },
3850
- "createdAt": {
3851
- "type": "string",
3852
- "format": "date-time"
3657
+ "required": [
3658
+ "branchId",
3659
+ "fileId",
3660
+ "versionId",
3661
+ "fileName",
3662
+ "fileFormat",
3663
+ "dataFormat",
3664
+ "createdAt",
3665
+ "updatedAt",
3666
+ "publishedAt",
3667
+ "locales",
3668
+ "sourceLocale"
3669
+ ]
3670
+ }
3671
+ },
3672
+ "translatedFiles": {
3673
+ "type": "array",
3674
+ "items": {
3675
+ "type": "object",
3676
+ "properties": {
3677
+ "branchId": {
3678
+ "type": "string"
3679
+ },
3680
+ "fileId": {
3681
+ "type": "string"
3682
+ },
3683
+ "versionId": {
3684
+ "type": "string"
3685
+ },
3686
+ "fileFormat": {
3687
+ "$ref": "#/components/schemas/FileFormat"
3688
+ },
3689
+ "dataFormat": {
3690
+ "type": ["string", "null"]
3691
+ },
3692
+ "createdAt": {
3693
+ "type": "string",
3694
+ "format": "date-time"
3695
+ },
3696
+ "updatedAt": {
3697
+ "type": "string",
3698
+ "format": "date-time"
3699
+ },
3700
+ "approvedAt": {
3701
+ "type": ["string", "null"],
3702
+ "format": "date-time"
3703
+ },
3704
+ "publishedAt": {
3705
+ "type": ["string", "null"],
3706
+ "format": "date-time"
3707
+ },
3708
+ "completedAt": {
3709
+ "type": ["string", "null"],
3710
+ "format": "date-time"
3711
+ },
3712
+ "locale": {
3713
+ "type": "string"
3714
+ }
3853
3715
  },
3854
- "updatedAt": {
3855
- "type": "string",
3856
- "format": "date-time"
3857
- }
3858
- },
3859
- "required": [
3860
- "id",
3861
- "tagId",
3862
- "message",
3863
- "createdAt",
3864
- "updatedAt"
3865
- ]
3716
+ "required": [
3717
+ "branchId",
3718
+ "fileId",
3719
+ "versionId",
3720
+ "fileFormat",
3721
+ "dataFormat",
3722
+ "createdAt",
3723
+ "updatedAt",
3724
+ "approvedAt",
3725
+ "publishedAt",
3726
+ "completedAt",
3727
+ "locale"
3728
+ ]
3729
+ }
3866
3730
  }
3867
3731
  },
3868
- "required": ["tag"]
3732
+ "required": ["sourceFiles", "translatedFiles"]
3869
3733
  }
3870
3734
  }
3871
3735
  }
@@ -3961,29 +3825,23 @@
3961
3825
  }
3962
3826
  }
3963
3827
  },
3964
- "tags": ["Project"]
3828
+ "tags": ["Files"]
3965
3829
  }
3966
3830
  },
3967
- "/v2/project/info/{projectId}": {
3968
- "get": {
3969
- "operationId": "getProjectInfo",
3970
- "summary": "Get Project information",
3971
- "description": "Read the authenticated Project's name, Organization ID, locale settings, and auto-approval setting.",
3831
+ "/v2/project/files/download": {
3832
+ "post": {
3833
+ "operationId": "downloadFiles",
3834
+ "summary": "Download multiple files",
3835
+ "description": "Download up to 100 source or translated files in one request.",
3972
3836
  "security": [
3973
3837
  {
3974
3838
  "BearerAuth": []
3839
+ },
3840
+ {
3841
+ "UserBearerAuth": []
3975
3842
  }
3976
3843
  ],
3977
3844
  "parameters": [
3978
- {
3979
- "schema": {
3980
- "type": "string",
3981
- "minLength": 1
3982
- },
3983
- "required": true,
3984
- "name": "projectId",
3985
- "in": "path"
3986
- },
3987
3845
  {
3988
3846
  "schema": {
3989
3847
  "type": "string",
@@ -4003,52 +3861,134 @@
4003
3861
  {
4004
3862
  "schema": {
4005
3863
  "type": "string",
4006
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
3864
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
4007
3865
  },
4008
3866
  "required": false,
4009
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
3867
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
4010
3868
  "name": "gt-project-id",
4011
3869
  "in": "header"
4012
3870
  }
4013
3871
  ],
4014
- "responses": {
4015
- "200": {
4016
- "description": "Project information",
4017
- "content": {
4018
- "application/json": {
4019
- "schema": {
3872
+ "requestBody": {
3873
+ "required": true,
3874
+ "content": {
3875
+ "application/json": {
3876
+ "schema": {
3877
+ "type": "array",
3878
+ "items": {
4020
3879
  "type": "object",
4021
3880
  "properties": {
4022
- "id": {
4023
- "type": "string"
3881
+ "fileId": {
3882
+ "type": "string",
3883
+ "minLength": 1
4024
3884
  },
4025
- "name": {
4026
- "type": "string"
3885
+ "branchId": {
3886
+ "type": "string",
3887
+ "minLength": 1
4027
3888
  },
4028
- "orgId": {
4029
- "type": "string"
3889
+ "versionId": {
3890
+ "type": "string",
3891
+ "minLength": 1
4030
3892
  },
4031
- "defaultLocale": {
4032
- "type": ["string", "null"]
3893
+ "locale": {
3894
+ "type": "string",
3895
+ "minLength": 1
4033
3896
  },
4034
- "currentLocales": {
3897
+ "useLatestAvailableVersion": {
3898
+ "type": "boolean"
3899
+ }
3900
+ },
3901
+ "required": ["fileId"]
3902
+ },
3903
+ "minItems": 1,
3904
+ "maxItems": 100
3905
+ }
3906
+ }
3907
+ }
3908
+ },
3909
+ "responses": {
3910
+ "200": {
3911
+ "description": "Downloaded files",
3912
+ "content": {
3913
+ "application/json": {
3914
+ "schema": {
3915
+ "type": "object",
3916
+ "properties": {
3917
+ "files": {
4035
3918
  "type": "array",
4036
3919
  "items": {
4037
- "type": "string"
3920
+ "type": "object",
3921
+ "properties": {
3922
+ "id": {
3923
+ "type": "string"
3924
+ },
3925
+ "branchId": {
3926
+ "type": "string"
3927
+ },
3928
+ "fileId": {
3929
+ "type": "string"
3930
+ },
3931
+ "versionId": {
3932
+ "type": "string"
3933
+ },
3934
+ "locale": {
3935
+ "type": "string"
3936
+ },
3937
+ "fileName": {
3938
+ "type": "string"
3939
+ },
3940
+ "data": {
3941
+ "type": "string"
3942
+ },
3943
+ "metadata": {
3944
+ "$ref": "#/components/schemas/JsonObject"
3945
+ },
3946
+ "fileFormat": {
3947
+ "$ref": "#/components/schemas/FileFormat"
3948
+ }
3949
+ },
3950
+ "required": [
3951
+ "id",
3952
+ "branchId",
3953
+ "fileId",
3954
+ "versionId",
3955
+ "data",
3956
+ "metadata",
3957
+ "fileFormat"
3958
+ ]
4038
3959
  }
4039
3960
  },
4040
- "autoApprove": {
4041
- "type": "boolean"
3961
+ "count": {
3962
+ "type": "number"
3963
+ },
3964
+ "pending": {
3965
+ "type": "array",
3966
+ "items": {
3967
+ "type": "object",
3968
+ "properties": {
3969
+ "branchId": {
3970
+ "type": "string"
3971
+ },
3972
+ "fileId": {
3973
+ "type": "string"
3974
+ },
3975
+ "locale": {
3976
+ "type": "string"
3977
+ },
3978
+ "versionId": {
3979
+ "type": "string"
3980
+ }
3981
+ },
3982
+ "required": [
3983
+ "branchId",
3984
+ "fileId",
3985
+ "locale",
3986
+ "versionId"
3987
+ ]
3988
+ }
4042
3989
  }
4043
3990
  },
4044
- "required": [
4045
- "id",
4046
- "name",
4047
- "orgId",
4048
- "defaultLocale",
4049
- "currentLocales",
4050
- "autoApprove"
4051
- ]
3991
+ "required": ["files", "count"]
4052
3992
  }
4053
3993
  }
4054
3994
  }
@@ -4098,7 +4038,7 @@
4098
4038
  }
4099
4039
  }
4100
4040
  },
4101
- "404": {
4041
+ "413": {
4102
4042
  "description": "Request error",
4103
4043
  "content": {
4104
4044
  "application/json": {
@@ -4144,15 +4084,21 @@
4144
4084
  }
4145
4085
  }
4146
4086
  },
4147
- "tags": ["Project"]
4148
- },
4149
- "post": {
4150
- "operationId": "updateProjectInfo",
4151
- "summary": "Update Project information",
4152
- "description": "Update the Project's default locale or CDN delivery setting.",
4087
+ "tags": ["Files"]
4088
+ }
4089
+ },
4090
+ "/v2/project/files/download/{fileId}": {
4091
+ "get": {
4092
+ "operationId": "downloadFile",
4093
+ "summary": "Download a single file",
4094
+ "deprecated": true,
4095
+ "description": "Download a single source or translated file. This deprecated endpoint is retained for backward compatibility; new integrations should use `POST /v2/project/files/download`.",
4153
4096
  "security": [
4154
4097
  {
4155
4098
  "BearerAuth": []
4099
+ },
4100
+ {
4101
+ "UserBearerAuth": []
4156
4102
  }
4157
4103
  ],
4158
4104
  "parameters": [
@@ -4162,9 +4108,33 @@
4162
4108
  "minLength": 1
4163
4109
  },
4164
4110
  "required": true,
4165
- "name": "projectId",
4111
+ "name": "fileId",
4166
4112
  "in": "path"
4167
4113
  },
4114
+ {
4115
+ "schema": {
4116
+ "type": "string"
4117
+ },
4118
+ "required": false,
4119
+ "name": "branchId",
4120
+ "in": "query"
4121
+ },
4122
+ {
4123
+ "schema": {
4124
+ "type": "string"
4125
+ },
4126
+ "required": false,
4127
+ "name": "versionId",
4128
+ "in": "query"
4129
+ },
4130
+ {
4131
+ "schema": {
4132
+ "type": "string"
4133
+ },
4134
+ "required": false,
4135
+ "name": "locale",
4136
+ "in": "query"
4137
+ },
4168
4138
  {
4169
4139
  "schema": {
4170
4140
  "type": "string",
@@ -4184,46 +4154,27 @@
4184
4154
  {
4185
4155
  "schema": {
4186
4156
  "type": "string",
4187
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
4157
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
4188
4158
  },
4189
4159
  "required": false,
4190
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
4160
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
4191
4161
  "name": "gt-project-id",
4192
4162
  "in": "header"
4193
4163
  }
4194
4164
  ],
4195
- "requestBody": {
4196
- "required": true,
4197
- "content": {
4198
- "application/json": {
4199
- "schema": {
4200
- "type": "object",
4201
- "properties": {
4202
- "defaultLocale": {
4203
- "type": "string"
4204
- },
4205
- "cdnEnabled": {
4206
- "type": "boolean"
4207
- }
4208
- }
4209
- }
4210
- }
4211
- }
4212
- },
4213
4165
  "responses": {
4214
4166
  "200": {
4215
- "description": "Project settings updated",
4167
+ "description": "Downloaded file",
4216
4168
  "content": {
4217
4169
  "application/json": {
4218
4170
  "schema": {
4219
4171
  "type": "object",
4220
4172
  "properties": {
4221
- "success": {
4222
- "type": "boolean",
4223
- "enum": [true]
4173
+ "data": {
4174
+ "type": "string"
4224
4175
  }
4225
4176
  },
4226
- "required": ["success"]
4177
+ "required": ["data"]
4227
4178
  }
4228
4179
  }
4229
4180
  }
@@ -4288,17 +4239,22 @@
4288
4239
  }
4289
4240
  }
4290
4241
  },
4291
- "413": {
4292
- "description": "Request error",
4242
+ "425": {
4243
+ "description": "Translation is still processing",
4293
4244
  "content": {
4294
4245
  "application/json": {
4295
4246
  "schema": {
4296
- "$ref": "#/components/schemas/ErrorResponse"
4297
- }
4298
- },
4299
- "text/html": {
4300
- "schema": {
4301
- "type": "string"
4247
+ "type": "object",
4248
+ "properties": {
4249
+ "status": {
4250
+ "type": "string",
4251
+ "enum": ["processing"]
4252
+ },
4253
+ "message": {
4254
+ "type": "string"
4255
+ }
4256
+ },
4257
+ "required": ["status", "message"]
4302
4258
  }
4303
4259
  }
4304
4260
  }
@@ -4334,7 +4290,7 @@
4334
4290
  }
4335
4291
  }
4336
4292
  },
4337
- "tags": ["Project"]
4293
+ "tags": ["Files"]
4338
4294
  }
4339
4295
  },
4340
4296
  "/v2/project/jobs/info": {
@@ -4345,6 +4301,9 @@
4345
4301
  "security": [
4346
4302
  {
4347
4303
  "BearerAuth": []
4304
+ },
4305
+ {
4306
+ "UserBearerAuth": []
4348
4307
  }
4349
4308
  ],
4350
4309
  "parameters": [
@@ -4367,10 +4326,10 @@
4367
4326
  {
4368
4327
  "schema": {
4369
4328
  "type": "string",
4370
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
4329
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
4371
4330
  },
4372
4331
  "required": false,
4373
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
4332
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
4374
4333
  "name": "gt-project-id",
4375
4334
  "in": "header"
4376
4335
  }
@@ -4594,14 +4553,17 @@
4594
4553
  "tags": ["Translation"]
4595
4554
  }
4596
4555
  },
4597
- "/v2/translate": {
4556
+ "/v2/project/setup/generate": {
4598
4557
  "post": {
4599
- "operationId": "translate",
4600
- "summary": "Translate content at runtime",
4601
- "description": "Translate one or more strings or structured content entries with caching and memoization. Development API keys are accepted for this endpoint.",
4558
+ "operationId": "generateProjectContext",
4559
+ "summary": "Generate translation context",
4560
+ "description": "Generate glossaries and translation instructions for the project.",
4602
4561
  "security": [
4603
4562
  {
4604
4563
  "BearerAuth": []
4564
+ },
4565
+ {
4566
+ "UserBearerAuth": []
4605
4567
  }
4606
4568
  ],
4607
4569
  "parameters": [
@@ -4624,10 +4586,10 @@
4624
4586
  {
4625
4587
  "schema": {
4626
4588
  "type": "string",
4627
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
4589
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
4628
4590
  },
4629
4591
  "required": false,
4630
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
4592
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
4631
4593
  "name": "gt-project-id",
4632
4594
  "in": "header"
4633
4595
  }
@@ -4637,48 +4599,82 @@
4637
4599
  "content": {
4638
4600
  "application/json": {
4639
4601
  "schema": {
4640
- "$ref": "#/components/schemas/RuntimeTranslationRequest"
4641
- }
4642
- }
4643
- }
4644
- },
4645
- "responses": {
4646
- "200": {
4647
- "description": "All translations were served from cache",
4648
- "content": {
4649
- "application/json": {
4650
- "schema": {
4651
- "$ref": "#/components/schemas/RuntimeTranslationResponse"
4652
- }
4653
- }
4654
- }
4655
- },
4656
- "201": {
4657
- "description": "Translations completed",
4658
- "content": {
4659
- "application/json": {
4660
- "schema": {
4661
- "$ref": "#/components/schemas/RuntimeTranslationResponse"
4662
- }
4602
+ "type": "object",
4603
+ "properties": {
4604
+ "files": {
4605
+ "type": "array",
4606
+ "items": {
4607
+ "type": "object",
4608
+ "properties": {
4609
+ "branchId": {
4610
+ "type": "string",
4611
+ "minLength": 1
4612
+ },
4613
+ "fileId": {
4614
+ "type": "string",
4615
+ "minLength": 1
4616
+ },
4617
+ "versionId": {
4618
+ "type": "string",
4619
+ "minLength": 1
4620
+ }
4621
+ },
4622
+ "required": ["fileId", "versionId"]
4623
+ },
4624
+ "minItems": 1
4625
+ },
4626
+ "locales": {
4627
+ "type": "array",
4628
+ "items": {
4629
+ "type": "string"
4630
+ }
4631
+ },
4632
+ "force": {
4633
+ "type": "boolean",
4634
+ "default": false
4635
+ }
4636
+ },
4637
+ "required": ["files"]
4663
4638
  }
4664
4639
  }
4665
- },
4666
- "400": {
4667
- "description": "Request error",
4640
+ }
4641
+ },
4642
+ "responses": {
4643
+ "200": {
4644
+ "description": "Context generation status",
4668
4645
  "content": {
4669
4646
  "application/json": {
4670
4647
  "schema": {
4671
- "$ref": "#/components/schemas/ErrorResponse"
4672
- }
4673
- },
4674
- "text/html": {
4675
- "schema": {
4676
- "type": "string"
4648
+ "anyOf": [
4649
+ {
4650
+ "type": "object",
4651
+ "properties": {
4652
+ "status": {
4653
+ "type": "string",
4654
+ "enum": ["completed"]
4655
+ }
4656
+ },
4657
+ "required": ["status"]
4658
+ },
4659
+ {
4660
+ "type": "object",
4661
+ "properties": {
4662
+ "setupJobId": {
4663
+ "type": "string"
4664
+ },
4665
+ "status": {
4666
+ "type": "string",
4667
+ "enum": ["queued"]
4668
+ }
4669
+ },
4670
+ "required": ["setupJobId", "status"]
4671
+ }
4672
+ ]
4677
4673
  }
4678
4674
  }
4679
4675
  }
4680
4676
  },
4681
- "401": {
4677
+ "400": {
4682
4678
  "description": "Request error",
4683
4679
  "content": {
4684
4680
  "application/json": {
@@ -4693,7 +4689,7 @@
4693
4689
  }
4694
4690
  }
4695
4691
  },
4696
- "402": {
4692
+ "401": {
4697
4693
  "description": "Request error",
4698
4694
  "content": {
4699
4695
  "application/json": {
@@ -4784,17 +4780,20 @@
4784
4780
  }
4785
4781
  }
4786
4782
  },
4787
- "tags": ["Translation"]
4783
+ "tags": ["Context"]
4788
4784
  }
4789
4785
  },
4790
- "/v2/project/files/info": {
4786
+ "/v2/project/files/publish": {
4791
4787
  "post": {
4792
- "operationId": "getFileInfo",
4793
- "summary": "Get file metadata",
4794
- "description": "Get detailed metadata for specific source and translated files.",
4788
+ "operationId": "publishFiles",
4789
+ "summary": "Publish or unpublish files",
4790
+ "description": "Publish or unpublish translated files to the CDN. Requires CDN to be enabled.",
4795
4791
  "security": [
4796
4792
  {
4797
4793
  "BearerAuth": []
4794
+ },
4795
+ {
4796
+ "UserBearerAuth": []
4798
4797
  }
4799
4798
  ],
4800
4799
  "parameters": [
@@ -4817,10 +4816,10 @@
4817
4816
  {
4818
4817
  "schema": {
4819
4818
  "type": "string",
4820
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
4819
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
4821
4820
  },
4822
4821
  "required": false,
4823
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
4822
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
4824
4823
  "name": "gt-project-id",
4825
4824
  "in": "header"
4826
4825
  }
@@ -4832,28 +4831,7 @@
4832
4831
  "schema": {
4833
4832
  "type": "object",
4834
4833
  "properties": {
4835
- "sourceFiles": {
4836
- "type": "array",
4837
- "items": {
4838
- "type": "object",
4839
- "properties": {
4840
- "fileId": {
4841
- "type": "string",
4842
- "minLength": 1
4843
- },
4844
- "versionId": {
4845
- "type": "string",
4846
- "minLength": 1
4847
- },
4848
- "branchId": {
4849
- "type": "string",
4850
- "minLength": 1
4851
- }
4852
- },
4853
- "required": ["fileId", "versionId", "branchId"]
4854
- }
4855
- },
4856
- "translatedFiles": {
4834
+ "files": {
4857
4835
  "type": "array",
4858
4836
  "items": {
4859
4837
  "type": "object",
@@ -4870,148 +4848,62 @@
4870
4848
  "type": "string",
4871
4849
  "minLength": 1
4872
4850
  },
4873
- "locale": {
4874
- "type": "string",
4875
- "minLength": 1
4851
+ "publish": {
4852
+ "type": "boolean"
4876
4853
  }
4877
4854
  },
4878
- "required": ["fileId", "versionId", "branchId", "locale"]
4879
- }
4855
+ "required": ["fileId", "versionId", "publish"]
4856
+ },
4857
+ "minItems": 1
4880
4858
  }
4881
- }
4859
+ },
4860
+ "required": ["files"]
4882
4861
  }
4883
4862
  }
4884
4863
  }
4885
4864
  },
4886
4865
  "responses": {
4887
4866
  "200": {
4888
- "description": "File information",
4867
+ "description": "File publish results",
4889
4868
  "content": {
4890
4869
  "application/json": {
4891
4870
  "schema": {
4892
4871
  "type": "object",
4893
4872
  "properties": {
4894
- "sourceFiles": {
4873
+ "results": {
4895
4874
  "type": "array",
4896
4875
  "items": {
4897
4876
  "type": "object",
4898
4877
  "properties": {
4899
- "branchId": {
4900
- "type": "string"
4901
- },
4902
4878
  "fileId": {
4903
4879
  "type": "string"
4904
4880
  },
4905
4881
  "versionId": {
4906
4882
  "type": "string"
4907
4883
  },
4908
- "fileName": {
4884
+ "locale": {
4909
4885
  "type": "string"
4910
4886
  },
4911
- "fileFormat": {
4912
- "$ref": "#/components/schemas/FileFormat"
4913
- },
4914
- "dataFormat": {
4915
- "type": ["string", "null"]
4916
- },
4917
- "createdAt": {
4918
- "type": "string",
4919
- "format": "date-time"
4920
- },
4921
- "updatedAt": {
4922
- "type": "string",
4923
- "format": "date-time"
4924
- },
4925
- "publishedAt": {
4926
- "type": ["string", "null"],
4927
- "format": "date-time"
4928
- },
4929
- "locales": {
4930
- "type": "array",
4931
- "items": {
4932
- "type": "string"
4933
- }
4934
- },
4935
- "sourceLocale": {
4936
- "type": "string"
4937
- }
4938
- },
4939
- "required": [
4940
- "branchId",
4941
- "fileId",
4942
- "versionId",
4943
- "fileName",
4944
- "fileFormat",
4945
- "dataFormat",
4946
- "createdAt",
4947
- "updatedAt",
4948
- "publishedAt",
4949
- "locales",
4950
- "sourceLocale"
4951
- ]
4952
- }
4953
- },
4954
- "translatedFiles": {
4955
- "type": "array",
4956
- "items": {
4957
- "type": "object",
4958
- "properties": {
4959
4887
  "branchId": {
4960
4888
  "type": "string"
4961
4889
  },
4962
- "fileId": {
4963
- "type": "string"
4964
- },
4965
- "versionId": {
4966
- "type": "string"
4967
- },
4968
- "fileFormat": {
4969
- "$ref": "#/components/schemas/FileFormat"
4970
- },
4971
- "dataFormat": {
4972
- "type": ["string", "null"]
4973
- },
4974
- "createdAt": {
4975
- "type": "string",
4976
- "format": "date-time"
4977
- },
4978
- "updatedAt": {
4979
- "type": "string",
4980
- "format": "date-time"
4981
- },
4982
- "approvedAt": {
4983
- "type": ["string", "null"],
4984
- "format": "date-time"
4985
- },
4986
- "publishedAt": {
4987
- "type": ["string", "null"],
4988
- "format": "date-time"
4989
- },
4990
- "completedAt": {
4991
- "type": ["string", "null"],
4992
- "format": "date-time"
4890
+ "success": {
4891
+ "type": "boolean"
4993
4892
  },
4994
- "locale": {
4893
+ "error": {
4995
4894
  "type": "string"
4996
4895
  }
4997
4896
  },
4998
4897
  "required": [
4999
- "branchId",
5000
4898
  "fileId",
5001
4899
  "versionId",
5002
- "fileFormat",
5003
- "dataFormat",
5004
- "createdAt",
5005
- "updatedAt",
5006
- "approvedAt",
5007
- "publishedAt",
5008
- "completedAt",
5009
- "locale"
4900
+ "branchId",
4901
+ "success"
5010
4902
  ]
5011
4903
  }
5012
4904
  }
5013
4905
  },
5014
- "required": ["sourceFiles", "translatedFiles"]
4906
+ "required": ["results"]
5015
4907
  }
5016
4908
  }
5017
4909
  }
@@ -5061,6 +4953,21 @@
5061
4953
  }
5062
4954
  }
5063
4955
  },
4956
+ "404": {
4957
+ "description": "Request error",
4958
+ "content": {
4959
+ "application/json": {
4960
+ "schema": {
4961
+ "$ref": "#/components/schemas/ErrorResponse"
4962
+ }
4963
+ },
4964
+ "text/html": {
4965
+ "schema": {
4966
+ "type": "string"
4967
+ }
4968
+ }
4969
+ }
4970
+ },
5064
4971
  "413": {
5065
4972
  "description": "Request error",
5066
4973
  "content": {
@@ -5110,42 +5017,20 @@
5110
5017
  "tags": ["Files"]
5111
5018
  }
5112
5019
  },
5113
- "/v2/project/translations/files/status/{fileId}": {
5114
- "get": {
5115
- "operationId": "getTranslationStatus",
5116
- "summary": "Get translation status for a file",
5117
- "description": "Return translation progress and availability by locale for one source file, along with its source metadata.",
5020
+ "/v2/project/files/upload-files": {
5021
+ "post": {
5022
+ "operationId": "uploadSourceFiles",
5023
+ "summary": "Upload source files",
5024
+ "description": "Upload one or more source files to the project. Max 100 files per request.",
5118
5025
  "security": [
5119
5026
  {
5120
5027
  "BearerAuth": []
5028
+ },
5029
+ {
5030
+ "UserBearerAuth": []
5121
5031
  }
5122
5032
  ],
5123
5033
  "parameters": [
5124
- {
5125
- "schema": {
5126
- "type": "string",
5127
- "minLength": 1
5128
- },
5129
- "required": true,
5130
- "name": "fileId",
5131
- "in": "path"
5132
- },
5133
- {
5134
- "schema": {
5135
- "type": "string"
5136
- },
5137
- "required": false,
5138
- "name": "versionId",
5139
- "in": "query"
5140
- },
5141
- {
5142
- "schema": {
5143
- "type": "string"
5144
- },
5145
- "required": false,
5146
- "name": "branchId",
5147
- "in": "query"
5148
- },
5149
5034
  {
5150
5035
  "schema": {
5151
5036
  "type": "string",
@@ -5165,119 +5050,164 @@
5165
5050
  {
5166
5051
  "schema": {
5167
5052
  "type": "string",
5168
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
5053
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
5169
5054
  },
5170
5055
  "required": false,
5171
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
5056
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
5172
5057
  "name": "gt-project-id",
5173
5058
  "in": "header"
5174
5059
  }
5175
5060
  ],
5061
+ "requestBody": {
5062
+ "required": true,
5063
+ "content": {
5064
+ "application/json": {
5065
+ "schema": {
5066
+ "type": "object",
5067
+ "properties": {
5068
+ "data": {
5069
+ "type": "array",
5070
+ "items": {
5071
+ "type": "object",
5072
+ "properties": {
5073
+ "source": {
5074
+ "type": "object",
5075
+ "properties": {
5076
+ "content": {
5077
+ "type": "string"
5078
+ },
5079
+ "fileName": {
5080
+ "type": "string",
5081
+ "minLength": 1
5082
+ },
5083
+ "fileFormat": {
5084
+ "type": "string",
5085
+ "enum": [
5086
+ "GTJSON",
5087
+ "MDX",
5088
+ "JSON",
5089
+ "YAML",
5090
+ "MD",
5091
+ "TS",
5092
+ "JS",
5093
+ "HTML",
5094
+ "TXT",
5095
+ "PO",
5096
+ "POT",
5097
+ "TWILIO_CONTENT_JSON",
5098
+ "LOTTIE",
5099
+ "SVG",
5100
+ "XCSTRINGS",
5101
+ "DOT_STRINGS",
5102
+ "DOT_STRINGSDICT",
5103
+ "ANDROID_STRINGS"
5104
+ ]
5105
+ },
5106
+ "dataFormat": {
5107
+ "type": "string"
5108
+ },
5109
+ "locale": {
5110
+ "type": "string",
5111
+ "minLength": 1
5112
+ },
5113
+ "fileId": {
5114
+ "type": "string",
5115
+ "minLength": 1
5116
+ },
5117
+ "versionId": {
5118
+ "type": "string",
5119
+ "minLength": 1
5120
+ },
5121
+ "branchId": {
5122
+ "type": "string",
5123
+ "minLength": 1
5124
+ },
5125
+ "checkedOutBranchId": {
5126
+ "type": "string",
5127
+ "minLength": 1
5128
+ },
5129
+ "incomingBranchId": {
5130
+ "type": "string",
5131
+ "minLength": 1
5132
+ },
5133
+ "formatMetadata": {
5134
+ "type": "object",
5135
+ "additionalProperties": {}
5136
+ }
5137
+ },
5138
+ "required": [
5139
+ "content",
5140
+ "fileName",
5141
+ "fileFormat",
5142
+ "locale"
5143
+ ]
5144
+ }
5145
+ },
5146
+ "required": ["source"]
5147
+ },
5148
+ "minItems": 1,
5149
+ "maxItems": 100
5150
+ },
5151
+ "sourceLocale": {
5152
+ "type": "string"
5153
+ }
5154
+ },
5155
+ "required": ["data"]
5156
+ }
5157
+ }
5158
+ }
5159
+ },
5176
5160
  "responses": {
5177
- "200": {
5178
- "description": "Translation status",
5161
+ "201": {
5162
+ "description": "Uploaded source files",
5179
5163
  "content": {
5180
5164
  "application/json": {
5181
5165
  "schema": {
5182
5166
  "type": "object",
5183
5167
  "properties": {
5184
- "translations": {
5168
+ "uploadedFiles": {
5185
5169
  "type": "array",
5186
5170
  "items": {
5187
5171
  "type": "object",
5188
5172
  "properties": {
5189
- "locale": {
5173
+ "branchId": {
5190
5174
  "type": "string"
5191
5175
  },
5192
- "completedAt": {
5193
- "type": ["string", "null"],
5194
- "format": "date-time"
5176
+ "fileId": {
5177
+ "type": "string"
5195
5178
  },
5196
- "approvedAt": {
5197
- "type": ["string", "null"],
5198
- "format": "date-time"
5179
+ "versionId": {
5180
+ "type": "string"
5199
5181
  },
5200
- "publishedAt": {
5201
- "type": ["string", "null"],
5202
- "format": "date-time"
5182
+ "fileName": {
5183
+ "type": "string"
5203
5184
  },
5204
- "createdAt": {
5205
- "type": ["string", "null"],
5206
- "format": "date-time"
5185
+ "fileFormat": {
5186
+ "$ref": "#/components/schemas/FileFormat"
5207
5187
  },
5208
- "updatedAt": {
5209
- "type": ["string", "null"],
5210
- "format": "date-time"
5188
+ "dataFormat": {
5189
+ "type": "string"
5190
+ },
5191
+ "locale": {
5192
+ "type": "string"
5211
5193
  }
5212
5194
  },
5213
5195
  "required": [
5214
- "locale",
5215
- "completedAt",
5216
- "approvedAt",
5217
- "publishedAt",
5218
- "createdAt",
5219
- "updatedAt"
5196
+ "fileId",
5197
+ "versionId",
5198
+ "fileName",
5199
+ "fileFormat"
5220
5200
  ]
5221
5201
  }
5222
5202
  },
5223
- "sourceFile": {
5224
- "type": "object",
5225
- "properties": {
5226
- "id": {
5227
- "type": "string"
5228
- },
5229
- "branchId": {
5230
- "type": "string"
5231
- },
5232
- "fileId": {
5233
- "type": "string"
5234
- },
5235
- "versionId": {
5236
- "type": "string"
5237
- },
5238
- "fileName": {
5239
- "type": "string"
5240
- },
5241
- "sourceLocale": {
5242
- "type": "string"
5243
- },
5244
- "fileFormat": {
5245
- "$ref": "#/components/schemas/FileFormat"
5246
- },
5247
- "dataFormat": {
5248
- "type": ["string", "null"]
5249
- },
5250
- "createdAt": {
5251
- "type": "string",
5252
- "format": "date-time"
5253
- },
5254
- "updatedAt": {
5255
- "type": "string",
5256
- "format": "date-time"
5257
- },
5258
- "locales": {
5259
- "type": "array",
5260
- "items": {
5261
- "type": "string"
5262
- }
5263
- }
5264
- },
5265
- "required": [
5266
- "id",
5267
- "branchId",
5268
- "fileId",
5269
- "versionId",
5270
- "fileName",
5271
- "sourceLocale",
5272
- "fileFormat",
5273
- "dataFormat",
5274
- "createdAt",
5275
- "updatedAt",
5276
- "locales"
5277
- ]
5203
+ "count": {
5204
+ "type": "number"
5205
+ },
5206
+ "message": {
5207
+ "type": "string"
5278
5208
  }
5279
5209
  },
5280
- "required": ["translations", "sourceFile"]
5210
+ "required": ["uploadedFiles", "count", "message"]
5281
5211
  }
5282
5212
  }
5283
5213
  }
@@ -5342,6 +5272,21 @@
5342
5272
  }
5343
5273
  }
5344
5274
  },
5275
+ "413": {
5276
+ "description": "Request error",
5277
+ "content": {
5278
+ "application/json": {
5279
+ "schema": {
5280
+ "$ref": "#/components/schemas/ErrorResponse"
5281
+ }
5282
+ },
5283
+ "text/html": {
5284
+ "schema": {
5285
+ "type": "string"
5286
+ }
5287
+ }
5288
+ }
5289
+ },
5345
5290
  "429": {
5346
5291
  "description": "Request error",
5347
5292
  "content": {
@@ -5371,19 +5316,37 @@
5371
5316
  }
5372
5317
  }
5373
5318
  }
5374
- }
5375
- },
5319
+ },
5320
+ "503": {
5321
+ "description": "Request error",
5322
+ "content": {
5323
+ "application/json": {
5324
+ "schema": {
5325
+ "$ref": "#/components/schemas/ErrorResponse"
5326
+ }
5327
+ },
5328
+ "text/html": {
5329
+ "schema": {
5330
+ "type": "string"
5331
+ }
5332
+ }
5333
+ }
5334
+ }
5335
+ },
5376
5336
  "tags": ["Files"]
5377
5337
  }
5378
5338
  },
5379
- "/v2/project/files/moves": {
5339
+ "/v2/project/translations/enqueue": {
5380
5340
  "post": {
5381
- "operationId": "processFileMoves",
5382
- "summary": "Move or rename files",
5383
- "description": "Clone source files and their translations under new file IDs.",
5341
+ "operationId": "enqueueFileTranslations",
5342
+ "summary": "Queue files for translation",
5343
+ "description": "Enqueue uploaded source files for background translation. Max 100 files per request. The response shape depends on the requested `gt-api-version`.",
5384
5344
  "security": [
5385
5345
  {
5386
5346
  "BearerAuth": []
5347
+ },
5348
+ {
5349
+ "UserBearerAuth": []
5387
5350
  }
5388
5351
  ],
5389
5352
  "parameters": [
@@ -5406,10 +5369,10 @@
5406
5369
  {
5407
5370
  "schema": {
5408
5371
  "type": "string",
5409
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
5372
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project."
5410
5373
  },
5411
5374
  "required": false,
5412
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
5375
+ "description": "Target project ID when no project ID is present in the path. Project API keys default to their bound project. If supplied, the header must match both the path target and the key’s bound project.",
5413
5376
  "name": "gt-project-id",
5414
5377
  "in": "header"
5415
5378
  }
@@ -5421,101 +5384,291 @@
5421
5384
  "schema": {
5422
5385
  "type": "object",
5423
5386
  "properties": {
5424
- "branchId": {
5425
- "type": "string"
5426
- },
5427
- "moves": {
5387
+ "files": {
5428
5388
  "type": "array",
5429
5389
  "items": {
5430
5390
  "type": "object",
5431
5391
  "properties": {
5432
- "oldFileId": {
5392
+ "branchId": {
5433
5393
  "type": "string",
5434
5394
  "minLength": 1
5435
5395
  },
5436
- "newFileId": {
5396
+ "fileId": {
5437
5397
  "type": "string",
5438
5398
  "minLength": 1
5439
5399
  },
5440
- "newFileName": {
5400
+ "versionId": {
5441
5401
  "type": "string",
5442
5402
  "minLength": 1
5403
+ },
5404
+ "fileName": {
5405
+ "type": "string"
5406
+ },
5407
+ "transformFormat": {
5408
+ "type": "string",
5409
+ "enum": [
5410
+ "GTJSON",
5411
+ "MDX",
5412
+ "JSON",
5413
+ "YAML",
5414
+ "MD",
5415
+ "TS",
5416
+ "JS",
5417
+ "HTML",
5418
+ "TXT",
5419
+ "PO",
5420
+ "POT",
5421
+ "TWILIO_CONTENT_JSON",
5422
+ "LOTTIE",
5423
+ "SVG",
5424
+ "XCSTRINGS",
5425
+ "DOT_STRINGS",
5426
+ "DOT_STRINGSDICT",
5427
+ "ANDROID_STRINGS"
5428
+ ]
5443
5429
  }
5444
5430
  },
5445
- "required": ["oldFileId", "newFileId", "newFileName"]
5431
+ "required": ["fileId", "versionId"]
5432
+ },
5433
+ "minItems": 1,
5434
+ "maxItems": 100
5435
+ },
5436
+ "targetLocales": {
5437
+ "type": "array",
5438
+ "items": {
5439
+ "type": "string"
5446
5440
  }
5441
+ },
5442
+ "sourceLocale": {
5443
+ "type": "string"
5444
+ },
5445
+ "force": {
5446
+ "type": "boolean",
5447
+ "default": false
5448
+ },
5449
+ "modelProvider": {
5450
+ "$ref": "#/components/schemas/ModelProvider"
5451
+ },
5452
+ "publish": {
5453
+ "type": "boolean"
5447
5454
  }
5448
5455
  },
5449
- "required": ["moves"]
5456
+ "required": ["files"]
5450
5457
  }
5451
5458
  }
5452
5459
  }
5453
5460
  },
5454
5461
  "responses": {
5455
5462
  "200": {
5456
- "description": "File move results",
5463
+ "description": "Enqueued translations. Shape depends on gt-api-version (legacy before 2025-11-03.v1).",
5457
5464
  "content": {
5458
5465
  "application/json": {
5459
5466
  "schema": {
5460
- "type": "object",
5461
- "properties": {
5462
- "results": {
5463
- "type": "array",
5464
- "items": {
5465
- "type": "object",
5466
- "properties": {
5467
- "oldFileId": {
5468
- "type": "string"
5469
- },
5470
- "newFileId": {
5471
- "type": "string"
5472
- },
5473
- "success": {
5474
- "type": "boolean"
5475
- },
5476
- "newSourceFileId": {
5477
- "type": "string"
5478
- },
5479
- "clonedTranslationsCount": {
5480
- "type": "integer"
5481
- },
5482
- "error": {
5467
+ "anyOf": [
5468
+ {
5469
+ "type": "object",
5470
+ "properties": {
5471
+ "jobData": {
5472
+ "type": "object",
5473
+ "additionalProperties": {
5474
+ "type": "object",
5475
+ "properties": {
5476
+ "kind": {
5477
+ "type": "string",
5478
+ "enum": ["file_translation"]
5479
+ },
5480
+ "sourceFileId": {
5481
+ "type": "string"
5482
+ },
5483
+ "fileId": {
5484
+ "type": "string"
5485
+ },
5486
+ "versionId": {
5487
+ "type": "string"
5488
+ },
5489
+ "branchId": {
5490
+ "type": "string"
5491
+ },
5492
+ "targetLocale": {
5493
+ "type": "string"
5494
+ },
5495
+ "projectId": {
5496
+ "type": "string"
5497
+ },
5498
+ "orgId": {
5499
+ "type": "string"
5500
+ },
5501
+ "force": {
5502
+ "type": "boolean"
5503
+ },
5504
+ "outputFileFormat": {
5505
+ "$ref": "#/components/schemas/FileFormat"
5506
+ },
5507
+ "modelProvider": {
5508
+ "$ref": "#/components/schemas/ModelProvider"
5509
+ },
5510
+ "glossaryRetranslate": {
5511
+ "type": "boolean"
5512
+ },
5513
+ "changedGlossaryTerms": {
5514
+ "type": "array",
5515
+ "items": {
5516
+ "type": "string"
5517
+ }
5518
+ },
5519
+ "onComplete": {
5520
+ "type": "object",
5521
+ "properties": {
5522
+ "kind": {
5523
+ "type": "string",
5524
+ "enum": ["google_drive_apply"]
5525
+ },
5526
+ "userId": {
5527
+ "type": "string"
5528
+ }
5529
+ },
5530
+ "required": ["kind"]
5531
+ }
5532
+ },
5533
+ "required": [
5534
+ "sourceFileId",
5535
+ "fileId",
5536
+ "versionId",
5537
+ "branchId",
5538
+ "targetLocale",
5539
+ "projectId",
5540
+ "orgId",
5541
+ "force"
5542
+ ]
5543
+ }
5544
+ },
5545
+ "locales": {
5546
+ "type": "array",
5547
+ "items": {
5483
5548
  "type": "string"
5484
5549
  }
5485
5550
  },
5486
- "required": ["oldFileId", "newFileId", "success"]
5487
- }
5551
+ "message": {
5552
+ "type": "string"
5553
+ }
5554
+ },
5555
+ "required": ["jobData", "locales", "message"]
5488
5556
  },
5489
- "summary": {
5557
+ {
5490
5558
  "type": "object",
5491
5559
  "properties": {
5492
- "total": {
5493
- "type": "integer",
5494
- "minimum": 0
5560
+ "translations": {
5561
+ "type": "array",
5562
+ "items": {
5563
+ "type": "object",
5564
+ "properties": {
5565
+ "locale": {
5566
+ "type": "string"
5567
+ },
5568
+ "metadata": {},
5569
+ "fileId": {
5570
+ "type": "string"
5571
+ },
5572
+ "fileName": {
5573
+ "type": "string"
5574
+ },
5575
+ "versionId": {
5576
+ "type": "string"
5577
+ },
5578
+ "branchId": {
5579
+ "type": "string"
5580
+ },
5581
+ "id": {
5582
+ "type": "string"
5583
+ },
5584
+ "isReady": {
5585
+ "type": "boolean"
5586
+ },
5587
+ "downloadUrl": {
5588
+ "type": "string"
5589
+ }
5590
+ },
5591
+ "required": [
5592
+ "locale",
5593
+ "fileId",
5594
+ "fileName",
5595
+ "versionId",
5596
+ "branchId",
5597
+ "id",
5598
+ "isReady",
5599
+ "downloadUrl"
5600
+ ]
5601
+ }
5495
5602
  },
5496
- "succeeded": {
5497
- "type": "integer",
5498
- "minimum": 0
5603
+ "data": {
5604
+ "type": "object",
5605
+ "additionalProperties": {
5606
+ "type": "object",
5607
+ "properties": {
5608
+ "fileName": {
5609
+ "type": "string"
5610
+ },
5611
+ "versionId": {
5612
+ "type": "string"
5613
+ }
5614
+ },
5615
+ "required": ["fileName", "versionId"]
5616
+ }
5499
5617
  },
5500
- "failed": {
5501
- "type": "integer",
5502
- "minimum": 0
5618
+ "locales": {
5619
+ "type": "array",
5620
+ "items": {
5621
+ "type": "string"
5622
+ }
5623
+ },
5624
+ "message": {
5625
+ "type": "string"
5503
5626
  }
5504
5627
  },
5505
- "required": ["total", "succeeded", "failed"]
5628
+ "required": ["translations", "data", "locales", "message"]
5506
5629
  }
5507
- },
5508
- "required": ["results"]
5630
+ ]
5509
5631
  }
5510
5632
  }
5511
5633
  }
5512
5634
  },
5513
5635
  "400": {
5514
- "description": "Request error",
5636
+ "description": "Invalid request or missing source files",
5515
5637
  "content": {
5516
5638
  "application/json": {
5517
5639
  "schema": {
5518
- "$ref": "#/components/schemas/ErrorResponse"
5640
+ "anyOf": [
5641
+ {
5642
+ "$ref": "#/components/schemas/ErrorResponse"
5643
+ },
5644
+ {
5645
+ "type": "object",
5646
+ "properties": {
5647
+ "error": {
5648
+ "type": "string"
5649
+ },
5650
+ "missing": {
5651
+ "type": "array",
5652
+ "items": {
5653
+ "type": "object",
5654
+ "properties": {
5655
+ "fileId": {
5656
+ "type": "string"
5657
+ },
5658
+ "versionId": {
5659
+ "type": "string"
5660
+ }
5661
+ },
5662
+ "required": ["fileId", "versionId"]
5663
+ }
5664
+ },
5665
+ "count": {
5666
+ "type": "number"
5667
+ }
5668
+ },
5669
+ "required": ["error", "missing", "count"]
5670
+ }
5671
+ ]
5519
5672
  }
5520
5673
  },
5521
5674
  "text/html": {
@@ -5540,195 +5693,7 @@
5540
5693
  }
5541
5694
  }
5542
5695
  },
5543
- "403": {
5544
- "description": "Request error",
5545
- "content": {
5546
- "application/json": {
5547
- "schema": {
5548
- "$ref": "#/components/schemas/ErrorResponse"
5549
- }
5550
- },
5551
- "text/html": {
5552
- "schema": {
5553
- "type": "string"
5554
- }
5555
- }
5556
- }
5557
- },
5558
- "404": {
5559
- "description": "Request error",
5560
- "content": {
5561
- "application/json": {
5562
- "schema": {
5563
- "$ref": "#/components/schemas/ErrorResponse"
5564
- }
5565
- },
5566
- "text/html": {
5567
- "schema": {
5568
- "type": "string"
5569
- }
5570
- }
5571
- }
5572
- },
5573
- "413": {
5574
- "description": "Request error",
5575
- "content": {
5576
- "application/json": {
5577
- "schema": {
5578
- "$ref": "#/components/schemas/ErrorResponse"
5579
- }
5580
- },
5581
- "text/html": {
5582
- "schema": {
5583
- "type": "string"
5584
- }
5585
- }
5586
- }
5587
- },
5588
- "429": {
5589
- "description": "Request error",
5590
- "content": {
5591
- "application/json": {
5592
- "schema": {
5593
- "$ref": "#/components/schemas/ErrorResponse"
5594
- }
5595
- },
5596
- "text/html": {
5597
- "schema": {
5598
- "type": "string"
5599
- }
5600
- }
5601
- }
5602
- },
5603
- "500": {
5604
- "description": "Request error",
5605
- "content": {
5606
- "application/json": {
5607
- "schema": {
5608
- "$ref": "#/components/schemas/ErrorResponse"
5609
- }
5610
- },
5611
- "text/html": {
5612
- "schema": {
5613
- "type": "string"
5614
- }
5615
- }
5616
- }
5617
- }
5618
- },
5619
- "tags": ["Files"]
5620
- }
5621
- },
5622
- "/v2/project/files/orphaned": {
5623
- "post": {
5624
- "operationId": "getOrphanedFiles",
5625
- "summary": "Find orphaned files",
5626
- "description": "Return files on a branch that are not present in the provided file ID list.",
5627
- "security": [
5628
- {
5629
- "BearerAuth": []
5630
- }
5631
- ],
5632
- "parameters": [
5633
- {
5634
- "schema": {
5635
- "type": "string",
5636
- "enum": [
5637
- "2025-01-01.v0",
5638
- "2025-11-03.v1",
5639
- "2026-02-18.v1",
5640
- "2026-03-06.v1"
5641
- ],
5642
- "description": "API contract version. Defaults to the oldest supported version."
5643
- },
5644
- "required": false,
5645
- "description": "API contract version. Defaults to the oldest supported version.",
5646
- "name": "gt-api-version",
5647
- "in": "header"
5648
- },
5649
- {
5650
- "schema": {
5651
- "type": "string",
5652
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key)."
5653
- },
5654
- "required": false,
5655
- "description": "Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).",
5656
- "name": "gt-project-id",
5657
- "in": "header"
5658
- }
5659
- ],
5660
- "requestBody": {
5661
- "required": true,
5662
- "content": {
5663
- "application/json": {
5664
- "schema": {
5665
- "type": "object",
5666
- "properties": {
5667
- "branchId": {
5668
- "type": "string",
5669
- "minLength": 1
5670
- },
5671
- "fileIds": {
5672
- "type": "array",
5673
- "items": {
5674
- "type": "string"
5675
- },
5676
- "default": []
5677
- }
5678
- },
5679
- "required": ["branchId"]
5680
- }
5681
- }
5682
- }
5683
- },
5684
- "responses": {
5685
- "200": {
5686
- "description": "Files present on the branch but absent from the request",
5687
- "content": {
5688
- "application/json": {
5689
- "schema": {
5690
- "type": "object",
5691
- "properties": {
5692
- "orphanedFiles": {
5693
- "type": "array",
5694
- "items": {
5695
- "type": "object",
5696
- "properties": {
5697
- "fileId": {
5698
- "type": "string"
5699
- },
5700
- "versionId": {
5701
- "type": "string"
5702
- },
5703
- "fileName": {
5704
- "type": "string"
5705
- }
5706
- },
5707
- "required": ["fileId", "versionId", "fileName"]
5708
- }
5709
- }
5710
- },
5711
- "required": ["orphanedFiles"]
5712
- }
5713
- }
5714
- }
5715
- },
5716
- "400": {
5717
- "description": "Request error",
5718
- "content": {
5719
- "application/json": {
5720
- "schema": {
5721
- "$ref": "#/components/schemas/ErrorResponse"
5722
- }
5723
- },
5724
- "text/html": {
5725
- "schema": {
5726
- "type": "string"
5727
- }
5728
- }
5729
- }
5730
- },
5731
- "401": {
5696
+ "402": {
5732
5697
  "description": "Request error",
5733
5698
  "content": {
5734
5699
  "application/json": {
@@ -5819,7 +5784,7 @@
5819
5784
  }
5820
5785
  }
5821
5786
  },
5822
- "tags": ["Files"]
5787
+ "tags": ["Translation"]
5823
5788
  }
5824
5789
  },
5825
5790
  "/cli/wizard/session": {