@generaltranslation/api 0.1.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 +12 -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 +1725 -1754
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,19 +79,53 @@
72
79
  "TWILIO_CONTENT_JSON",
73
80
  "LOTTIE",
74
81
  "SVG",
82
+ "XCSTRINGS",
75
83
  "DOT_STRINGS",
76
84
  "DOT_STRINGSDICT",
77
85
  "ANDROID_STRINGS"
78
86
  ]
79
87
  },
80
- "ModelProvider": {
81
- "type": "string",
82
- "enum": ["ANTHROPIC", "OPENAI", "XAI", "GOOGLE"]
83
- },
84
- "JsonObject": {
88
+ "RuntimeTranslationResponse": {
85
89
  "type": "object",
86
90
  "additionalProperties": {
87
- "$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
+ ]
88
129
  }
89
130
  },
90
131
  "JsonValue": {
@@ -129,61 +170,6 @@
129
170
  }
130
171
  ]
131
172
  },
132
- "Branch": {
133
- "type": "object",
134
- "properties": {
135
- "id": {
136
- "type": "string"
137
- },
138
- "name": {
139
- "type": "string"
140
- }
141
- },
142
- "required": ["id", "name"]
143
- },
144
- "RuntimeTranslationResponse": {
145
- "type": "object",
146
- "additionalProperties": {
147
- "oneOf": [
148
- {
149
- "type": "object",
150
- "properties": {
151
- "success": {
152
- "type": "boolean",
153
- "enum": [true]
154
- },
155
- "translation": {
156
- "$ref": "#/components/schemas/JsonValue"
157
- },
158
- "dataFormat": {
159
- "type": "string",
160
- "enum": ["JSX", "ICU", "I18NEXT", "STRING"]
161
- },
162
- "locale": {
163
- "type": "string"
164
- }
165
- },
166
- "required": ["success", "dataFormat", "locale"]
167
- },
168
- {
169
- "type": "object",
170
- "properties": {
171
- "success": {
172
- "type": "boolean",
173
- "enum": [false]
174
- },
175
- "error": {
176
- "type": "string"
177
- },
178
- "code": {
179
- "type": "number"
180
- }
181
- },
182
- "required": ["success", "error", "code"]
183
- }
184
- ]
185
- }
186
- },
187
173
  "RuntimeTranslationRequest": {
188
174
  "type": "object",
189
175
  "properties": {
@@ -267,6 +253,28 @@
267
253
  },
268
254
  "required": ["requests", "targetLocale", "sourceLocale", "metadata"]
269
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
+ },
270
278
  "CreateCliWizardSessionResponse": {
271
279
  "type": "object",
272
280
  "properties": {
@@ -349,17 +357,29 @@
349
357
  "parameters": {}
350
358
  },
351
359
  "paths": {
352
- "/v2/projects": {
360
+ "/v2/orgs/{orgId}/projects": {
353
361
  "post": {
354
362
  "operationId": "createProject",
355
363
  "summary": "Create a Project",
356
- "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.",
357
365
  "security": [
358
366
  {
359
367
  "BearerAuth": []
368
+ },
369
+ {
370
+ "UserBearerAuth": []
360
371
  }
361
372
  ],
362
373
  "parameters": [
374
+ {
375
+ "schema": {
376
+ "type": "string",
377
+ "minLength": 1
378
+ },
379
+ "required": true,
380
+ "name": "orgId",
381
+ "in": "path"
382
+ },
363
383
  {
364
384
  "schema": {
365
385
  "type": "string",
@@ -541,17 +561,29 @@
541
561
  "tags": ["Project"]
542
562
  }
543
563
  },
544
- "/v2/project/files/upload-files": {
564
+ "/v2/projects/{projectId}/api-keys": {
545
565
  "post": {
546
- "operationId": "uploadSourceFiles",
547
- "summary": "Upload source files",
548
- "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.",
549
569
  "security": [
550
570
  {
551
571
  "BearerAuth": []
572
+ },
573
+ {
574
+ "UserBearerAuth": []
552
575
  }
553
576
  ],
554
577
  "parameters": [
578
+ {
579
+ "schema": {
580
+ "type": "string",
581
+ "minLength": 1
582
+ },
583
+ "required": true,
584
+ "name": "projectId",
585
+ "in": "path"
586
+ },
555
587
  {
556
588
  "schema": {
557
589
  "type": "string",
@@ -567,16 +599,6 @@
567
599
  "description": "API contract version. Defaults to the oldest supported version.",
568
600
  "name": "gt-api-version",
569
601
  "in": "header"
570
- },
571
- {
572
- "schema": {
573
- "type": "string",
574
- "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)."
575
- },
576
- "required": false,
577
- "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).",
578
- "name": "gt-project-id",
579
- "in": "header"
580
602
  }
581
603
  ],
582
604
  "requestBody": {
@@ -586,148 +608,55 @@
586
608
  "schema": {
587
609
  "type": "object",
588
610
  "properties": {
589
- "data": {
590
- "type": "array",
591
- "items": {
592
- "type": "object",
593
- "properties": {
594
- "source": {
595
- "type": "object",
596
- "properties": {
597
- "content": {
598
- "type": "string"
599
- },
600
- "fileName": {
601
- "type": "string",
602
- "minLength": 1
603
- },
604
- "fileFormat": {
605
- "type": "string",
606
- "enum": [
607
- "GTJSON",
608
- "MDX",
609
- "JSON",
610
- "YAML",
611
- "MD",
612
- "TS",
613
- "JS",
614
- "HTML",
615
- "TXT",
616
- "PO",
617
- "POT",
618
- "TWILIO_CONTENT_JSON",
619
- "LOTTIE",
620
- "SVG",
621
- "DOT_STRINGS",
622
- "DOT_STRINGSDICT",
623
- "ANDROID_STRINGS"
624
- ]
625
- },
626
- "dataFormat": {
627
- "type": "string"
628
- },
629
- "locale": {
630
- "type": "string",
631
- "minLength": 1
632
- },
633
- "fileId": {
634
- "type": "string",
635
- "minLength": 1
636
- },
637
- "versionId": {
638
- "type": "string",
639
- "minLength": 1
640
- },
641
- "branchId": {
642
- "type": "string",
643
- "minLength": 1
644
- },
645
- "checkedOutBranchId": {
646
- "type": "string",
647
- "minLength": 1
648
- },
649
- "incomingBranchId": {
650
- "type": "string",
651
- "minLength": 1
652
- },
653
- "formatMetadata": {
654
- "type": "object",
655
- "additionalProperties": {}
656
- }
657
- },
658
- "required": [
659
- "content",
660
- "fileName",
661
- "fileFormat",
662
- "locale"
663
- ]
664
- }
665
- },
666
- "required": ["source"]
667
- },
668
- "minItems": 1,
669
- "maxItems": 100
611
+ "name": {
612
+ "type": "string",
613
+ "minLength": 1,
614
+ "maxLength": 255
670
615
  },
671
- "sourceLocale": {
672
- "type": "string"
616
+ "type": {
617
+ "type": "string",
618
+ "enum": ["production", "development"],
619
+ "default": "production"
673
620
  }
674
621
  },
675
- "required": ["data"]
622
+ "required": ["name"],
623
+ "additionalProperties": false
676
624
  }
677
625
  }
678
626
  }
679
627
  },
680
628
  "responses": {
681
629
  "201": {
682
- "description": "Uploaded source files",
630
+ "description": "Project API key created",
683
631
  "content": {
684
632
  "application/json": {
685
633
  "schema": {
686
634
  "type": "object",
687
635
  "properties": {
688
- "uploadedFiles": {
689
- "type": "array",
690
- "items": {
691
- "type": "object",
692
- "properties": {
693
- "branchId": {
694
- "type": "string"
695
- },
696
- "fileId": {
697
- "type": "string"
698
- },
699
- "versionId": {
700
- "type": "string"
701
- },
702
- "fileName": {
703
- "type": "string"
704
- },
705
- "fileFormat": {
706
- "$ref": "#/components/schemas/FileFormat"
707
- },
708
- "dataFormat": {
709
- "type": "string"
710
- },
711
- "locale": {
712
- "type": "string"
713
- }
636
+ "apiKey": {
637
+ "type": "object",
638
+ "properties": {
639
+ "id": {
640
+ "type": "string"
714
641
  },
715
- "required": [
716
- "fileId",
717
- "versionId",
718
- "fileName",
719
- "fileFormat"
720
- ]
721
- }
722
- },
723
- "count": {
724
- "type": "number"
725
- },
726
- "message": {
727
- "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"]
728
657
  }
729
658
  },
730
- "required": ["uploadedFiles", "count", "message"]
659
+ "required": ["apiKey"]
731
660
  }
732
661
  }
733
662
  }
@@ -836,24 +765,9 @@
836
765
  }
837
766
  }
838
767
  }
839
- },
840
- "503": {
841
- "description": "Request error",
842
- "content": {
843
- "application/json": {
844
- "schema": {
845
- "$ref": "#/components/schemas/ErrorResponse"
846
- }
847
- },
848
- "text/html": {
849
- "schema": {
850
- "type": "string"
851
- }
852
- }
853
- }
854
768
  }
855
769
  },
856
- "tags": ["Files"]
770
+ "tags": ["Project"]
857
771
  }
858
772
  },
859
773
  "/v2/project/files/upload-translations": {
@@ -864,6 +778,9 @@
864
778
  "security": [
865
779
  {
866
780
  "BearerAuth": []
781
+ },
782
+ {
783
+ "UserBearerAuth": []
867
784
  }
868
785
  ],
869
786
  "parameters": [
@@ -886,10 +803,10 @@
886
803
  {
887
804
  "schema": {
888
805
  "type": "string",
889
- "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."
890
807
  },
891
808
  "required": false,
892
- "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.",
893
810
  "name": "gt-project-id",
894
811
  "in": "header"
895
812
  }
@@ -933,6 +850,7 @@
933
850
  "TWILIO_CONTENT_JSON",
934
851
  "LOTTIE",
935
852
  "SVG",
853
+ "XCSTRINGS",
936
854
  "DOT_STRINGS",
937
855
  "DOT_STRINGSDICT",
938
856
  "ANDROID_STRINGS"
@@ -1006,6 +924,7 @@
1006
924
  "TWILIO_CONTENT_JSON",
1007
925
  "LOTTIE",
1008
926
  "SVG",
927
+ "XCSTRINGS",
1009
928
  "DOT_STRINGS",
1010
929
  "DOT_STRINGSDICT",
1011
930
  "ANDROID_STRINGS"
@@ -1035,6 +954,7 @@
1035
954
  "TWILIO_CONTENT_JSON",
1036
955
  "LOTTIE",
1037
956
  "SVG",
957
+ "XCSTRINGS",
1038
958
  "DOT_STRINGS",
1039
959
  "DOT_STRINGSDICT",
1040
960
  "ANDROID_STRINGS"
@@ -1244,17 +1164,29 @@
1244
1164
  "tags": ["Files"]
1245
1165
  }
1246
1166
  },
1247
- "/v2/project/assets": {
1167
+ "/v2/project/info/{projectId}": {
1248
1168
  "post": {
1249
- "operationId": "uploadAssets",
1250
- "summary": "Upload Project assets",
1251
- "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.",
1252
1172
  "security": [
1253
1173
  {
1254
1174
  "BearerAuth": []
1175
+ },
1176
+ {
1177
+ "UserBearerAuth": []
1255
1178
  }
1256
1179
  ],
1257
1180
  "parameters": [
1181
+ {
1182
+ "schema": {
1183
+ "type": "string",
1184
+ "minLength": 1
1185
+ },
1186
+ "required": true,
1187
+ "name": "projectId",
1188
+ "in": "path"
1189
+ },
1258
1190
  {
1259
1191
  "schema": {
1260
1192
  "type": "string",
@@ -1274,10 +1206,10 @@
1274
1206
  {
1275
1207
  "schema": {
1276
1208
  "type": "string",
1277
- "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."
1278
1210
  },
1279
1211
  "required": false,
1280
- "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.",
1281
1213
  "name": "gt-project-id",
1282
1214
  "in": "header"
1283
1215
  }
@@ -1289,79 +1221,31 @@
1289
1221
  "schema": {
1290
1222
  "type": "object",
1291
1223
  "properties": {
1292
- "assets": {
1293
- "type": "array",
1294
- "items": {
1295
- "type": "object",
1296
- "properties": {
1297
- "assetType": {
1298
- "type": "string",
1299
- "enum": ["FONT"]
1300
- },
1301
- "content": {
1302
- "type": "string",
1303
- "minLength": 1
1304
- },
1305
- "fileName": {
1306
- "type": "string",
1307
- "minLength": 1,
1308
- "maxLength": 255,
1309
- "pattern": "\\.([tT][tT][fF]|[oO][tT][fF])$"
1310
- },
1311
- "family": {
1312
- "type": "string",
1313
- "minLength": 1,
1314
- "maxLength": 255
1315
- },
1316
- "style": {
1317
- "type": "string",
1318
- "minLength": 1,
1319
- "maxLength": 100
1320
- }
1321
- },
1322
- "required": ["assetType", "content", "fileName"]
1323
- },
1324
- "minItems": 1,
1325
- "maxItems": 50
1224
+ "defaultLocale": {
1225
+ "type": "string"
1226
+ },
1227
+ "cdnEnabled": {
1228
+ "type": "boolean"
1326
1229
  }
1327
- },
1328
- "required": ["assets"]
1230
+ }
1329
1231
  }
1330
1232
  }
1331
1233
  }
1332
1234
  },
1333
1235
  "responses": {
1334
- "201": {
1335
- "description": "Uploaded assets",
1236
+ "200": {
1237
+ "description": "Project settings updated",
1336
1238
  "content": {
1337
1239
  "application/json": {
1338
1240
  "schema": {
1339
1241
  "type": "object",
1340
1242
  "properties": {
1341
- "assets": {
1342
- "type": "array",
1343
- "items": {
1344
- "type": "object",
1345
- "properties": {
1346
- "id": {
1347
- "type": "string"
1348
- },
1349
- "assetKey": {
1350
- "type": "string"
1351
- },
1352
- "fileName": {
1353
- "type": "string"
1354
- }
1355
- },
1356
- "required": ["id", "assetKey", "fileName"]
1357
- }
1358
- },
1359
- "count": {
1360
- "type": "integer",
1361
- "minimum": 0
1243
+ "success": {
1244
+ "type": "boolean",
1245
+ "enum": [true]
1362
1246
  }
1363
1247
  },
1364
- "required": ["assets", "count"]
1248
+ "required": ["success"]
1365
1249
  }
1366
1250
  }
1367
1251
  }
@@ -1473,19 +1357,29 @@
1473
1357
  }
1474
1358
  },
1475
1359
  "tags": ["Project"]
1476
- }
1477
- },
1478
- "/v2/project/files/diffs": {
1479
- "post": {
1480
- "operationId": "submitUserEditDiffs",
1481
- "summary": "Submit translation diffs",
1482
- "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.",
1483
1365
  "security": [
1484
1366
  {
1485
1367
  "BearerAuth": []
1368
+ },
1369
+ {
1370
+ "UserBearerAuth": []
1486
1371
  }
1487
1372
  ],
1488
1373
  "parameters": [
1374
+ {
1375
+ "schema": {
1376
+ "type": "string",
1377
+ "minLength": 1
1378
+ },
1379
+ "required": true,
1380
+ "name": "projectId",
1381
+ "in": "path"
1382
+ },
1489
1383
  {
1490
1384
  "schema": {
1491
1385
  "type": "string",
@@ -1505,95 +1399,58 @@
1505
1399
  {
1506
1400
  "schema": {
1507
1401
  "type": "string",
1508
- "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."
1509
1403
  },
1510
1404
  "required": false,
1511
- "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.",
1512
1406
  "name": "gt-project-id",
1513
1407
  "in": "header"
1514
1408
  }
1515
1409
  ],
1516
- "requestBody": {
1517
- "required": true,
1518
- "content": {
1519
- "application/json": {
1520
- "schema": {
1521
- "type": "object",
1522
- "properties": {
1523
- "projectId": {
1524
- "type": "string"
1525
- },
1526
- "diffs": {
1527
- "type": "array",
1528
- "items": {
1529
- "type": "object",
1530
- "properties": {
1531
- "locale": {
1532
- "type": "string",
1533
- "minLength": 1
1534
- },
1535
- "diff": {
1536
- "type": "string"
1537
- },
1538
- "branchId": {
1539
- "type": "string",
1540
- "minLength": 1
1541
- },
1542
- "versionId": {
1543
- "type": "string",
1544
- "minLength": 1
1545
- },
1546
- "fileId": {
1547
- "type": "string",
1548
- "minLength": 1
1549
- },
1550
- "localContent": {
1551
- "type": "string"
1552
- }
1553
- },
1554
- "required": [
1555
- "locale",
1556
- "diff",
1557
- "versionId",
1558
- "fileId",
1559
- "localContent"
1560
- ]
1561
- },
1562
- "minItems": 1
1563
- }
1564
- },
1565
- "required": ["diffs"]
1566
- }
1567
- }
1568
- }
1569
- },
1570
1410
  "responses": {
1571
1411
  "200": {
1572
- "description": "Processed user translation edits",
1412
+ "description": "Project information",
1573
1413
  "content": {
1574
1414
  "application/json": {
1575
1415
  "schema": {
1576
1416
  "type": "object",
1577
1417
  "properties": {
1578
- "filesProcessed": {
1579
- "type": "integer",
1580
- "minimum": 0
1418
+ "id": {
1419
+ "type": "string"
1581
1420
  },
1582
- "entriesReceived": {
1583
- "type": "integer",
1584
- "minimum": 0
1421
+ "name": {
1422
+ "type": "string"
1585
1423
  },
1586
- "message": {
1424
+ "orgId": {
1587
1425
  "type": "string"
1588
- }
1589
- },
1590
- "required": ["filesProcessed", "entriesReceived", "message"]
1591
- }
1592
- }
1593
- }
1594
- },
1595
- "400": {
1596
- "description": "Request error",
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",
1597
1454
  "content": {
1598
1455
  "application/json": {
1599
1456
  "schema": {
@@ -1637,7 +1494,7 @@
1637
1494
  }
1638
1495
  }
1639
1496
  },
1640
- "413": {
1497
+ "404": {
1641
1498
  "description": "Request error",
1642
1499
  "content": {
1643
1500
  "application/json": {
@@ -1683,18 +1540,20 @@
1683
1540
  }
1684
1541
  }
1685
1542
  },
1686
- "tags": ["Files"]
1543
+ "tags": ["Project"]
1687
1544
  }
1688
1545
  },
1689
- "/v2/project/setup/should-generate": {
1690
- "get": {
1691
- "operationId": "shouldGenerateProjectContext",
1692
- "summary": "Check if context generation is needed",
1693
- "deprecated": true,
1694
- "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.",
1695
1551
  "security": [
1696
1552
  {
1697
1553
  "BearerAuth": []
1554
+ },
1555
+ {
1556
+ "UserBearerAuth": []
1698
1557
  }
1699
1558
  ],
1700
1559
  "parameters": [
@@ -1717,27 +1576,41 @@
1717
1576
  {
1718
1577
  "schema": {
1719
1578
  "type": "string",
1720
- "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."
1721
1580
  },
1722
1581
  "required": false,
1723
- "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.",
1724
1583
  "name": "gt-project-id",
1725
1584
  "in": "header"
1726
1585
  }
1727
1586
  ],
1587
+ "requestBody": {
1588
+ "required": true,
1589
+ "content": {
1590
+ "application/json": {
1591
+ "schema": {
1592
+ "$ref": "#/components/schemas/RuntimeTranslationRequest"
1593
+ }
1594
+ }
1595
+ }
1596
+ },
1728
1597
  "responses": {
1729
1598
  "200": {
1730
- "description": "Whether project context should be generated",
1599
+ "description": "All translations were served from cache",
1731
1600
  "content": {
1732
1601
  "application/json": {
1733
1602
  "schema": {
1734
- "type": "object",
1735
- "properties": {
1736
- "shouldSetupProject": {
1737
- "type": "boolean"
1738
- }
1739
- },
1740
- "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"
1741
1614
  }
1742
1615
  }
1743
1616
  }
@@ -1772,6 +1645,21 @@
1772
1645
  }
1773
1646
  }
1774
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
+ },
1775
1663
  "403": {
1776
1664
  "description": "Request error",
1777
1665
  "content": {
@@ -1802,6 +1690,21 @@
1802
1690
  }
1803
1691
  }
1804
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
+ },
1805
1708
  "429": {
1806
1709
  "description": "Request error",
1807
1710
  "content": {
@@ -1833,20 +1736,48 @@
1833
1736
  }
1834
1737
  }
1835
1738
  },
1836
- "tags": ["Context"]
1739
+ "tags": ["Translation"]
1837
1740
  }
1838
1741
  },
1839
- "/v2/project/setup/generate": {
1840
- "post": {
1841
- "operationId": "generateProjectContext",
1842
- "summary": "Generate translation context",
1843
- "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.",
1844
1747
  "security": [
1845
1748
  {
1846
1749
  "BearerAuth": []
1750
+ },
1751
+ {
1752
+ "UserBearerAuth": []
1847
1753
  }
1848
1754
  ],
1849
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
+ },
1850
1781
  {
1851
1782
  "schema": {
1852
1783
  "type": "string",
@@ -1866,90 +1797,119 @@
1866
1797
  {
1867
1798
  "schema": {
1868
1799
  "type": "string",
1869
- "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."
1870
1801
  },
1871
1802
  "required": false,
1872
- "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.",
1873
1804
  "name": "gt-project-id",
1874
1805
  "in": "header"
1875
1806
  }
1876
1807
  ],
1877
- "requestBody": {
1878
- "required": true,
1879
- "content": {
1880
- "application/json": {
1881
- "schema": {
1882
- "type": "object",
1883
- "properties": {
1884
- "files": {
1885
- "type": "array",
1886
- "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": {
1887
1856
  "type": "object",
1888
1857
  "properties": {
1858
+ "id": {
1859
+ "type": "string"
1860
+ },
1889
1861
  "branchId": {
1890
- "type": "string",
1891
- "minLength": 1
1862
+ "type": "string"
1892
1863
  },
1893
1864
  "fileId": {
1894
- "type": "string",
1895
- "minLength": 1
1865
+ "type": "string"
1896
1866
  },
1897
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": {
1898
1883
  "type": "string",
1899
- "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
+ }
1900
1895
  }
1901
1896
  },
1902
- "required": ["fileId", "versionId"]
1903
- },
1904
- "minItems": 1
1905
- },
1906
- "locales": {
1907
- "type": "array",
1908
- "items": {
1909
- "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
+ ]
1910
1910
  }
1911
1911
  },
1912
- "force": {
1913
- "type": "boolean",
1914
- "default": false
1915
- }
1916
- },
1917
- "required": ["files"]
1918
- }
1919
- }
1920
- }
1921
- },
1922
- "responses": {
1923
- "200": {
1924
- "description": "Context generation status",
1925
- "content": {
1926
- "application/json": {
1927
- "schema": {
1928
- "anyOf": [
1929
- {
1930
- "type": "object",
1931
- "properties": {
1932
- "status": {
1933
- "type": "string",
1934
- "enum": ["completed"]
1935
- }
1936
- },
1937
- "required": ["status"]
1938
- },
1939
- {
1940
- "type": "object",
1941
- "properties": {
1942
- "setupJobId": {
1943
- "type": "string"
1944
- },
1945
- "status": {
1946
- "type": "string",
1947
- "enum": ["queued"]
1948
- }
1949
- },
1950
- "required": ["setupJobId", "status"]
1951
- }
1952
- ]
1912
+ "required": ["translations", "sourceFile"]
1953
1913
  }
1954
1914
  }
1955
1915
  }
@@ -2014,21 +1974,6 @@
2014
1974
  }
2015
1975
  }
2016
1976
  },
2017
- "413": {
2018
- "description": "Request error",
2019
- "content": {
2020
- "application/json": {
2021
- "schema": {
2022
- "$ref": "#/components/schemas/ErrorResponse"
2023
- }
2024
- },
2025
- "text/html": {
2026
- "schema": {
2027
- "type": "string"
2028
- }
2029
- }
2030
- }
2031
- },
2032
1977
  "429": {
2033
1978
  "description": "Request error",
2034
1979
  "content": {
@@ -2060,30 +2005,23 @@
2060
2005
  }
2061
2006
  }
2062
2007
  },
2063
- "tags": ["Context"]
2008
+ "tags": ["Files"]
2064
2009
  }
2065
2010
  },
2066
- "/v2/project/setup/status/{jobId}": {
2067
- "get": {
2068
- "operationId": "getProjectContextGenerationStatus",
2069
- "summary": "Get context generation job status",
2070
- "deprecated": true,
2071
- "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.",
2072
2016
  "security": [
2073
2017
  {
2074
2018
  "BearerAuth": []
2019
+ },
2020
+ {
2021
+ "UserBearerAuth": []
2075
2022
  }
2076
2023
  ],
2077
2024
  "parameters": [
2078
- {
2079
- "schema": {
2080
- "type": "string",
2081
- "minLength": 1
2082
- },
2083
- "required": true,
2084
- "name": "jobId",
2085
- "in": "path"
2086
- },
2087
2025
  {
2088
2026
  "schema": {
2089
2027
  "type": "string",
@@ -2103,45 +2041,59 @@
2103
2041
  {
2104
2042
  "schema": {
2105
2043
  "type": "string",
2106
- "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."
2107
2045
  },
2108
2046
  "required": false,
2109
- "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.",
2110
2048
  "name": "gt-project-id",
2111
2049
  "in": "header"
2112
2050
  }
2113
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
+ },
2114
2071
  "responses": {
2115
2072
  "200": {
2116
- "description": "Context generation job status",
2073
+ "description": "Branch information",
2117
2074
  "content": {
2118
2075
  "application/json": {
2119
2076
  "schema": {
2120
- "anyOf": [
2121
- {
2122
- "type": "object",
2123
- "properties": {
2124
- "status": {
2125
- "type": "string",
2126
- "enum": ["completed"]
2127
- }
2128
- },
2129
- "required": ["status"]
2077
+ "type": "object",
2078
+ "properties": {
2079
+ "branches": {
2080
+ "type": "array",
2081
+ "items": {
2082
+ "$ref": "#/components/schemas/Branch"
2083
+ }
2130
2084
  },
2131
- {
2132
- "type": "object",
2133
- "properties": {
2134
- "jobId": {
2135
- "type": "string"
2085
+ "defaultBranch": {
2086
+ "allOf": [
2087
+ {
2088
+ "$ref": "#/components/schemas/Branch"
2136
2089
  },
2137
- "status": {
2138
- "type": "string",
2139
- "enum": ["queued", "processing", "failed", "unknown"]
2090
+ {
2091
+ "type": ["object", "null"]
2140
2092
  }
2141
- },
2142
- "required": ["jobId", "status"]
2093
+ ]
2143
2094
  }
2144
- ]
2095
+ },
2096
+ "required": ["branches", "defaultBranch"]
2145
2097
  }
2146
2098
  }
2147
2099
  }
@@ -2191,7 +2143,7 @@
2191
2143
  }
2192
2144
  }
2193
2145
  },
2194
- "404": {
2146
+ "413": {
2195
2147
  "description": "Request error",
2196
2148
  "content": {
2197
2149
  "application/json": {
@@ -2237,17 +2189,20 @@
2237
2189
  }
2238
2190
  }
2239
2191
  },
2240
- "tags": ["Context"]
2192
+ "tags": ["Project"]
2241
2193
  }
2242
2194
  },
2243
- "/v2/project/translations/enqueue": {
2195
+ "/v2/project/branches/create": {
2244
2196
  "post": {
2245
- "operationId": "enqueueFileTranslations",
2246
- "summary": "Queue files for translation",
2247
- "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.",
2248
2200
  "security": [
2249
2201
  {
2250
2202
  "BearerAuth": []
2203
+ },
2204
+ {
2205
+ "UserBearerAuth": []
2251
2206
  }
2252
2207
  ],
2253
2208
  "parameters": [
@@ -2270,10 +2225,10 @@
2270
2225
  {
2271
2226
  "schema": {
2272
2227
  "type": "string",
2273
- "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."
2274
2229
  },
2275
2230
  "required": false,
2276
- "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.",
2277
2232
  "name": "gt-project-id",
2278
2233
  "in": "header"
2279
2234
  }
@@ -2285,296 +2240,38 @@
2285
2240
  "schema": {
2286
2241
  "type": "object",
2287
2242
  "properties": {
2288
- "files": {
2289
- "type": "array",
2290
- "items": {
2291
- "type": "object",
2292
- "properties": {
2293
- "branchId": {
2294
- "type": "string",
2295
- "minLength": 1
2296
- },
2297
- "fileId": {
2298
- "type": "string",
2299
- "minLength": 1
2300
- },
2301
- "versionId": {
2302
- "type": "string",
2303
- "minLength": 1
2304
- },
2305
- "fileName": {
2306
- "type": "string"
2307
- },
2308
- "transformFormat": {
2309
- "type": "string",
2310
- "enum": [
2311
- "GTJSON",
2312
- "MDX",
2313
- "JSON",
2314
- "YAML",
2315
- "MD",
2316
- "TS",
2317
- "JS",
2318
- "HTML",
2319
- "TXT",
2320
- "PO",
2321
- "POT",
2322
- "TWILIO_CONTENT_JSON",
2323
- "LOTTIE",
2324
- "SVG",
2325
- "DOT_STRINGS",
2326
- "DOT_STRINGSDICT",
2327
- "ANDROID_STRINGS"
2328
- ]
2329
- }
2330
- },
2331
- "required": ["fileId", "versionId"]
2332
- },
2333
- "minItems": 1,
2334
- "maxItems": 100
2335
- },
2336
- "targetLocales": {
2337
- "type": "array",
2338
- "items": {
2339
- "type": "string"
2340
- }
2341
- },
2342
- "sourceLocale": {
2343
- "type": "string"
2243
+ "branchName": {
2244
+ "type": "string",
2245
+ "minLength": 1
2344
2246
  },
2345
- "force": {
2247
+ "defaultBranch": {
2346
2248
  "type": "boolean",
2347
2249
  "default": false
2348
- },
2349
- "modelProvider": {
2350
- "$ref": "#/components/schemas/ModelProvider"
2351
- },
2352
- "publish": {
2353
- "type": "boolean"
2354
2250
  }
2355
2251
  },
2356
- "required": ["files"]
2252
+ "required": ["branchName"]
2357
2253
  }
2358
2254
  }
2359
2255
  }
2360
2256
  },
2361
2257
  "responses": {
2362
2258
  "200": {
2363
- "description": "Enqueued translations. Shape depends on gt-api-version (legacy before 2025-11-03.v1).",
2259
+ "description": "Created or existing branch",
2364
2260
  "content": {
2365
2261
  "application/json": {
2366
2262
  "schema": {
2367
- "anyOf": [
2368
- {
2369
- "type": "object",
2370
- "properties": {
2371
- "jobData": {
2372
- "type": "object",
2373
- "additionalProperties": {
2374
- "type": "object",
2375
- "properties": {
2376
- "kind": {
2377
- "type": "string",
2378
- "enum": ["file_translation"]
2379
- },
2380
- "sourceFileId": {
2381
- "type": "string"
2382
- },
2383
- "fileId": {
2384
- "type": "string"
2385
- },
2386
- "versionId": {
2387
- "type": "string"
2388
- },
2389
- "branchId": {
2390
- "type": "string"
2391
- },
2392
- "targetLocale": {
2393
- "type": "string"
2394
- },
2395
- "projectId": {
2396
- "type": "string"
2397
- },
2398
- "force": {
2399
- "type": "boolean"
2400
- },
2401
- "outputFileFormat": {
2402
- "$ref": "#/components/schemas/FileFormat"
2403
- },
2404
- "modelProvider": {
2405
- "$ref": "#/components/schemas/ModelProvider"
2406
- },
2407
- "glossaryRetranslate": {
2408
- "type": "boolean"
2409
- },
2410
- "changedGlossaryTerms": {
2411
- "type": "array",
2412
- "items": {
2413
- "type": "string"
2414
- }
2415
- },
2416
- "onComplete": {
2417
- "type": "object",
2418
- "properties": {
2419
- "kind": {
2420
- "type": "string",
2421
- "enum": ["google_drive_apply"]
2422
- },
2423
- "userId": {
2424
- "type": "string"
2425
- }
2426
- },
2427
- "required": ["kind"]
2428
- }
2429
- },
2430
- "required": [
2431
- "sourceFileId",
2432
- "fileId",
2433
- "versionId",
2434
- "branchId",
2435
- "targetLocale",
2436
- "projectId",
2437
- "force"
2438
- ]
2439
- }
2440
- },
2441
- "locales": {
2442
- "type": "array",
2443
- "items": {
2444
- "type": "string"
2445
- }
2446
- },
2447
- "message": {
2448
- "type": "string"
2449
- }
2450
- },
2451
- "required": ["jobData", "locales", "message"]
2452
- },
2453
- {
2454
- "type": "object",
2455
- "properties": {
2456
- "translations": {
2457
- "type": "array",
2458
- "items": {
2459
- "type": "object",
2460
- "properties": {
2461
- "locale": {
2462
- "type": "string"
2463
- },
2464
- "metadata": {},
2465
- "fileId": {
2466
- "type": "string"
2467
- },
2468
- "fileName": {
2469
- "type": "string"
2470
- },
2471
- "versionId": {
2472
- "type": "string"
2473
- },
2474
- "branchId": {
2475
- "type": "string"
2476
- },
2477
- "id": {
2478
- "type": "string"
2479
- },
2480
- "isReady": {
2481
- "type": "boolean"
2482
- },
2483
- "downloadUrl": {
2484
- "type": "string"
2485
- }
2486
- },
2487
- "required": [
2488
- "locale",
2489
- "fileId",
2490
- "fileName",
2491
- "versionId",
2492
- "branchId",
2493
- "id",
2494
- "isReady",
2495
- "downloadUrl"
2496
- ]
2497
- }
2498
- },
2499
- "data": {
2500
- "type": "object",
2501
- "additionalProperties": {
2502
- "type": "object",
2503
- "properties": {
2504
- "fileName": {
2505
- "type": "string"
2506
- },
2507
- "versionId": {
2508
- "type": "string"
2509
- }
2510
- },
2511
- "required": ["fileName", "versionId"]
2512
- }
2513
- },
2514
- "locales": {
2515
- "type": "array",
2516
- "items": {
2517
- "type": "string"
2518
- }
2519
- },
2520
- "message": {
2521
- "type": "string"
2522
- }
2523
- },
2524
- "required": ["translations", "data", "locales", "message"]
2263
+ "type": "object",
2264
+ "properties": {
2265
+ "branch": {
2266
+ "$ref": "#/components/schemas/Branch"
2525
2267
  }
2526
- ]
2268
+ },
2269
+ "required": ["branch"]
2527
2270
  }
2528
2271
  }
2529
2272
  }
2530
2273
  },
2531
2274
  "400": {
2532
- "description": "Invalid request or missing source files",
2533
- "content": {
2534
- "application/json": {
2535
- "schema": {
2536
- "anyOf": [
2537
- {
2538
- "$ref": "#/components/schemas/ErrorResponse"
2539
- },
2540
- {
2541
- "type": "object",
2542
- "properties": {
2543
- "error": {
2544
- "type": "string"
2545
- },
2546
- "missing": {
2547
- "type": "array",
2548
- "items": {
2549
- "type": "object",
2550
- "properties": {
2551
- "fileId": {
2552
- "type": "string"
2553
- },
2554
- "versionId": {
2555
- "type": "string"
2556
- }
2557
- },
2558
- "required": ["fileId", "versionId"]
2559
- }
2560
- },
2561
- "count": {
2562
- "type": "number"
2563
- }
2564
- },
2565
- "required": ["error", "missing", "count"]
2566
- }
2567
- ]
2568
- }
2569
- },
2570
- "text/html": {
2571
- "schema": {
2572
- "type": "string"
2573
- }
2574
- }
2575
- }
2576
- },
2577
- "401": {
2578
2275
  "description": "Request error",
2579
2276
  "content": {
2580
2277
  "application/json": {
@@ -2589,7 +2286,7 @@
2589
2286
  }
2590
2287
  }
2591
2288
  },
2592
- "402": {
2289
+ "401": {
2593
2290
  "description": "Request error",
2594
2291
  "content": {
2595
2292
  "application/json": {
@@ -2619,7 +2316,7 @@
2619
2316
  }
2620
2317
  }
2621
2318
  },
2622
- "404": {
2319
+ "409": {
2623
2320
  "description": "Request error",
2624
2321
  "content": {
2625
2322
  "application/json": {
@@ -2680,17 +2377,20 @@
2680
2377
  }
2681
2378
  }
2682
2379
  },
2683
- "tags": ["Translation"]
2380
+ "tags": ["Project"]
2684
2381
  }
2685
2382
  },
2686
- "/v2/project/files/publish": {
2383
+ "/v2/project/tags/create": {
2687
2384
  "post": {
2688
- "operationId": "publishFiles",
2689
- "summary": "Publish or unpublish files",
2690
- "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.",
2691
2388
  "security": [
2692
2389
  {
2693
2390
  "BearerAuth": []
2391
+ },
2392
+ {
2393
+ "UserBearerAuth": []
2694
2394
  }
2695
2395
  ],
2696
2396
  "parameters": [
@@ -2713,10 +2413,10 @@
2713
2413
  {
2714
2414
  "schema": {
2715
2415
  "type": "string",
2716
- "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."
2717
2417
  },
2718
2418
  "required": false,
2719
- "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.",
2720
2420
  "name": "gt-project-id",
2721
2421
  "in": "header"
2722
2422
  }
@@ -2728,6 +2428,11 @@
2728
2428
  "schema": {
2729
2429
  "type": "object",
2730
2430
  "properties": {
2431
+ "tagId": {
2432
+ "type": "string",
2433
+ "minLength": 1,
2434
+ "maxLength": 255
2435
+ },
2731
2436
  "files": {
2732
2437
  "type": "array",
2733
2438
  "items": {
@@ -2744,83 +2449,66 @@
2744
2449
  "branchId": {
2745
2450
  "type": "string",
2746
2451
  "minLength": 1
2747
- },
2748
- "publish": {
2749
- "type": "boolean"
2750
2452
  }
2751
2453
  },
2752
- "required": ["fileId", "versionId", "publish"]
2454
+ "required": ["fileId", "versionId", "branchId"]
2753
2455
  },
2754
2456
  "minItems": 1
2457
+ },
2458
+ "message": {
2459
+ "type": "string",
2460
+ "maxLength": 255
2755
2461
  }
2756
2462
  },
2757
- "required": ["files"]
2463
+ "required": ["tagId", "files"]
2758
2464
  }
2759
2465
  }
2760
2466
  }
2761
2467
  },
2762
2468
  "responses": {
2763
2469
  "200": {
2764
- "description": "File publish results",
2470
+ "description": "Created or updated file tag",
2765
2471
  "content": {
2766
2472
  "application/json": {
2767
2473
  "schema": {
2768
2474
  "type": "object",
2769
2475
  "properties": {
2770
- "results": {
2771
- "type": "array",
2772
- "items": {
2773
- "type": "object",
2774
- "properties": {
2775
- "fileId": {
2776
- "type": "string"
2777
- },
2778
- "versionId": {
2779
- "type": "string"
2780
- },
2781
- "locale": {
2782
- "type": "string"
2783
- },
2784
- "branchId": {
2785
- "type": "string"
2786
- },
2787
- "success": {
2788
- "type": "boolean"
2789
- },
2790
- "error": {
2791
- "type": "string"
2792
- }
2476
+ "tag": {
2477
+ "type": "object",
2478
+ "properties": {
2479
+ "id": {
2480
+ "type": "string"
2793
2481
  },
2794
- "required": [
2795
- "fileId",
2796
- "versionId",
2797
- "branchId",
2798
- "success"
2799
- ]
2800
- }
2801
- }
2802
- },
2803
- "required": ["results"]
2804
- }
2805
- }
2806
- }
2807
- },
2808
- "400": {
2809
- "description": "Request error",
2810
- "content": {
2811
- "application/json": {
2812
- "schema": {
2813
- "$ref": "#/components/schemas/ErrorResponse"
2814
- }
2815
- },
2816
- "text/html": {
2817
- "schema": {
2818
- "type": "string"
2819
- }
2820
- }
2821
- }
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
+ }
2822
2510
  },
2823
- "401": {
2511
+ "400": {
2824
2512
  "description": "Request error",
2825
2513
  "content": {
2826
2514
  "application/json": {
@@ -2835,7 +2523,7 @@
2835
2523
  }
2836
2524
  }
2837
2525
  },
2838
- "403": {
2526
+ "401": {
2839
2527
  "description": "Request error",
2840
2528
  "content": {
2841
2529
  "application/json": {
@@ -2850,7 +2538,7 @@
2850
2538
  }
2851
2539
  }
2852
2540
  },
2853
- "404": {
2541
+ "403": {
2854
2542
  "description": "Request error",
2855
2543
  "content": {
2856
2544
  "application/json": {
@@ -2911,54 +2599,23 @@
2911
2599
  }
2912
2600
  }
2913
2601
  },
2914
- "tags": ["Files"]
2602
+ "tags": ["Project"]
2915
2603
  }
2916
2604
  },
2917
- "/v2/project/files/download/{fileId}": {
2918
- "get": {
2919
- "operationId": "downloadFile",
2920
- "summary": "Download a single file",
2921
- "deprecated": true,
2922
- "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.",
2923
2610
  "security": [
2924
2611
  {
2925
2612
  "BearerAuth": []
2613
+ },
2614
+ {
2615
+ "UserBearerAuth": []
2926
2616
  }
2927
2617
  ],
2928
2618
  "parameters": [
2929
- {
2930
- "schema": {
2931
- "type": "string",
2932
- "minLength": 1
2933
- },
2934
- "required": true,
2935
- "name": "fileId",
2936
- "in": "path"
2937
- },
2938
- {
2939
- "schema": {
2940
- "type": "string"
2941
- },
2942
- "required": false,
2943
- "name": "branchId",
2944
- "in": "query"
2945
- },
2946
- {
2947
- "schema": {
2948
- "type": "string"
2949
- },
2950
- "required": false,
2951
- "name": "versionId",
2952
- "in": "query"
2953
- },
2954
- {
2955
- "schema": {
2956
- "type": "string"
2957
- },
2958
- "required": false,
2959
- "name": "locale",
2960
- "in": "query"
2961
- },
2962
2619
  {
2963
2620
  "schema": {
2964
2621
  "type": "string",
@@ -2978,27 +2635,94 @@
2978
2635
  {
2979
2636
  "schema": {
2980
2637
  "type": "string",
2981
- "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."
2982
2639
  },
2983
2640
  "required": false,
2984
- "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.",
2985
2642
  "name": "gt-project-id",
2986
2643
  "in": "header"
2987
2644
  }
2988
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
+ },
2989
2694
  "responses": {
2990
- "200": {
2991
- "description": "Downloaded file",
2695
+ "201": {
2696
+ "description": "Uploaded assets",
2992
2697
  "content": {
2993
2698
  "application/json": {
2994
2699
  "schema": {
2995
2700
  "type": "object",
2996
2701
  "properties": {
2997
- "data": {
2998
- "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
2999
2723
  }
3000
2724
  },
3001
- "required": ["data"]
2725
+ "required": ["assets", "count"]
3002
2726
  }
3003
2727
  }
3004
2728
  }
@@ -3063,22 +2787,17 @@
3063
2787
  }
3064
2788
  }
3065
2789
  },
3066
- "425": {
3067
- "description": "Translation is still processing",
2790
+ "413": {
2791
+ "description": "Request error",
3068
2792
  "content": {
3069
2793
  "application/json": {
3070
2794
  "schema": {
3071
- "type": "object",
3072
- "properties": {
3073
- "status": {
3074
- "type": "string",
3075
- "enum": ["processing"]
3076
- },
3077
- "message": {
3078
- "type": "string"
3079
- }
3080
- },
3081
- "required": ["status", "message"]
2795
+ "$ref": "#/components/schemas/ErrorResponse"
2796
+ }
2797
+ },
2798
+ "text/html": {
2799
+ "schema": {
2800
+ "type": "string"
3082
2801
  }
3083
2802
  }
3084
2803
  }
@@ -3114,17 +2833,20 @@
3114
2833
  }
3115
2834
  }
3116
2835
  },
3117
- "tags": ["Files"]
2836
+ "tags": ["Project"]
3118
2837
  }
3119
2838
  },
3120
- "/v2/project/files/download": {
2839
+ "/v2/project/files/diffs": {
3121
2840
  "post": {
3122
- "operationId": "downloadFiles",
3123
- "summary": "Download multiple files",
3124
- "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.",
3125
2844
  "security": [
3126
2845
  {
3127
2846
  "BearerAuth": []
2847
+ },
2848
+ {
2849
+ "UserBearerAuth": []
3128
2850
  }
3129
2851
  ],
3130
2852
  "parameters": [
@@ -3147,10 +2869,10 @@
3147
2869
  {
3148
2870
  "schema": {
3149
2871
  "type": "string",
3150
- "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."
3151
2873
  },
3152
2874
  "required": false,
3153
- "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.",
3154
2876
  "name": "gt-project-id",
3155
2877
  "in": "header"
3156
2878
  }
@@ -3160,121 +2882,76 @@
3160
2882
  "content": {
3161
2883
  "application/json": {
3162
2884
  "schema": {
3163
- "type": "array",
3164
- "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": {
3165
2940
  "type": "object",
3166
2941
  "properties": {
3167
- "fileId": {
3168
- "type": "string",
3169
- "minLength": 1
2942
+ "filesProcessed": {
2943
+ "type": "integer",
2944
+ "minimum": 0
3170
2945
  },
3171
- "branchId": {
3172
- "type": "string",
3173
- "minLength": 1
3174
- },
3175
- "versionId": {
3176
- "type": "string",
3177
- "minLength": 1
3178
- },
3179
- "locale": {
3180
- "type": "string",
3181
- "minLength": 1
3182
- },
3183
- "useLatestAvailableVersion": {
3184
- "type": "boolean"
3185
- }
3186
- },
3187
- "required": ["fileId"]
3188
- },
3189
- "minItems": 1,
3190
- "maxItems": 100
3191
- }
3192
- }
3193
- }
3194
- },
3195
- "responses": {
3196
- "200": {
3197
- "description": "Downloaded files",
3198
- "content": {
3199
- "application/json": {
3200
- "schema": {
3201
- "type": "object",
3202
- "properties": {
3203
- "files": {
3204
- "type": "array",
3205
- "items": {
3206
- "type": "object",
3207
- "properties": {
3208
- "id": {
3209
- "type": "string"
3210
- },
3211
- "branchId": {
3212
- "type": "string"
3213
- },
3214
- "fileId": {
3215
- "type": "string"
3216
- },
3217
- "versionId": {
3218
- "type": "string"
3219
- },
3220
- "locale": {
3221
- "type": "string"
3222
- },
3223
- "fileName": {
3224
- "type": "string"
3225
- },
3226
- "data": {
3227
- "type": "string"
3228
- },
3229
- "metadata": {
3230
- "$ref": "#/components/schemas/JsonObject"
3231
- },
3232
- "fileFormat": {
3233
- "$ref": "#/components/schemas/FileFormat"
3234
- }
3235
- },
3236
- "required": [
3237
- "id",
3238
- "branchId",
3239
- "fileId",
3240
- "versionId",
3241
- "data",
3242
- "metadata",
3243
- "fileFormat"
3244
- ]
3245
- }
3246
- },
3247
- "count": {
3248
- "type": "number"
2946
+ "entriesReceived": {
2947
+ "type": "integer",
2948
+ "minimum": 0
3249
2949
  },
3250
- "pending": {
3251
- "type": "array",
3252
- "items": {
3253
- "type": "object",
3254
- "properties": {
3255
- "branchId": {
3256
- "type": "string"
3257
- },
3258
- "fileId": {
3259
- "type": "string"
3260
- },
3261
- "locale": {
3262
- "type": "string"
3263
- },
3264
- "versionId": {
3265
- "type": "string"
3266
- }
3267
- },
3268
- "required": [
3269
- "branchId",
3270
- "fileId",
3271
- "locale",
3272
- "versionId"
3273
- ]
3274
- }
2950
+ "message": {
2951
+ "type": "string"
3275
2952
  }
3276
2953
  },
3277
- "required": ["files", "count"]
2954
+ "required": ["filesProcessed", "entriesReceived", "message"]
3278
2955
  }
3279
2956
  }
3280
2957
  }
@@ -3373,14 +3050,17 @@
3373
3050
  "tags": ["Files"]
3374
3051
  }
3375
3052
  },
3376
- "/v2/project/branches/info": {
3053
+ "/v2/project/files/moves": {
3377
3054
  "post": {
3378
- "operationId": "getBranchInfo",
3379
- "summary": "Get branch information",
3380
- "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.",
3381
3058
  "security": [
3382
3059
  {
3383
3060
  "BearerAuth": []
3061
+ },
3062
+ {
3063
+ "UserBearerAuth": []
3384
3064
  }
3385
3065
  ],
3386
3066
  "parameters": [
@@ -3403,10 +3083,10 @@
3403
3083
  {
3404
3084
  "schema": {
3405
3085
  "type": "string",
3406
- "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."
3407
3087
  },
3408
3088
  "required": false,
3409
- "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.",
3410
3090
  "name": "gt-project-id",
3411
3091
  "in": "header"
3412
3092
  }
@@ -3418,44 +3098,91 @@
3418
3098
  "schema": {
3419
3099
  "type": "object",
3420
3100
  "properties": {
3421
- "branchNames": {
3101
+ "branchId": {
3102
+ "type": "string"
3103
+ },
3104
+ "moves": {
3422
3105
  "type": "array",
3423
3106
  "items": {
3424
- "type": "string"
3425
- },
3426
- "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
+ }
3427
3124
  }
3428
- }
3125
+ },
3126
+ "required": ["moves"]
3429
3127
  }
3430
3128
  }
3431
3129
  }
3432
3130
  },
3433
3131
  "responses": {
3434
3132
  "200": {
3435
- "description": "Branch information",
3133
+ "description": "File move results",
3436
3134
  "content": {
3437
3135
  "application/json": {
3438
3136
  "schema": {
3439
3137
  "type": "object",
3440
3138
  "properties": {
3441
- "branches": {
3139
+ "results": {
3442
3140
  "type": "array",
3443
3141
  "items": {
3444
- "$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"]
3445
3164
  }
3446
3165
  },
3447
- "defaultBranch": {
3448
- "allOf": [
3449
- {
3450
- "$ref": "#/components/schemas/Branch"
3166
+ "summary": {
3167
+ "type": "object",
3168
+ "properties": {
3169
+ "total": {
3170
+ "type": "integer",
3171
+ "minimum": 0
3451
3172
  },
3452
- {
3453
- "type": ["object", "null"]
3173
+ "succeeded": {
3174
+ "type": "integer",
3175
+ "minimum": 0
3176
+ },
3177
+ "failed": {
3178
+ "type": "integer",
3179
+ "minimum": 0
3454
3180
  }
3455
- ]
3181
+ },
3182
+ "required": ["total", "succeeded", "failed"]
3456
3183
  }
3457
3184
  },
3458
- "required": ["branches", "defaultBranch"]
3185
+ "required": ["results"]
3459
3186
  }
3460
3187
  }
3461
3188
  }
@@ -3505,6 +3232,21 @@
3505
3232
  }
3506
3233
  }
3507
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
+ },
3508
3250
  "413": {
3509
3251
  "description": "Request error",
3510
3252
  "content": {
@@ -3551,17 +3293,20 @@
3551
3293
  }
3552
3294
  }
3553
3295
  },
3554
- "tags": ["Project"]
3296
+ "tags": ["Files"]
3555
3297
  }
3556
3298
  },
3557
- "/v2/project/branches/create": {
3299
+ "/v2/project/files/orphaned": {
3558
3300
  "post": {
3559
- "operationId": "createBranch",
3560
- "summary": "Create a branch",
3561
- "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.",
3562
3304
  "security": [
3563
3305
  {
3564
3306
  "BearerAuth": []
3307
+ },
3308
+ {
3309
+ "UserBearerAuth": []
3565
3310
  }
3566
3311
  ],
3567
3312
  "parameters": [
@@ -3584,10 +3329,10 @@
3584
3329
  {
3585
3330
  "schema": {
3586
3331
  "type": "string",
3587
- "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."
3588
3333
  },
3589
3334
  "required": false,
3590
- "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.",
3591
3336
  "name": "gt-project-id",
3592
3337
  "in": "header"
3593
3338
  }
@@ -3599,44 +3344,62 @@
3599
3344
  "schema": {
3600
3345
  "type": "object",
3601
3346
  "properties": {
3602
- "branchName": {
3347
+ "branchId": {
3603
3348
  "type": "string",
3604
3349
  "minLength": 1
3605
3350
  },
3606
- "defaultBranch": {
3607
- "type": "boolean",
3608
- "default": false
3351
+ "fileIds": {
3352
+ "type": "array",
3353
+ "items": {
3354
+ "type": "string"
3355
+ },
3356
+ "default": []
3609
3357
  }
3610
3358
  },
3611
- "required": ["branchName"]
3359
+ "required": ["branchId"]
3612
3360
  }
3613
3361
  }
3614
3362
  }
3615
3363
  },
3616
3364
  "responses": {
3617
3365
  "200": {
3618
- "description": "Created or existing branch",
3366
+ "description": "Files present on the branch but absent from the request",
3619
3367
  "content": {
3620
3368
  "application/json": {
3621
3369
  "schema": {
3622
3370
  "type": "object",
3623
3371
  "properties": {
3624
- "branch": {
3625
- "$ref": "#/components/schemas/Branch"
3626
- }
3627
- },
3628
- "required": ["branch"]
3629
- }
3630
- }
3631
- }
3632
- },
3633
- "400": {
3634
- "description": "Request error",
3635
- "content": {
3636
- "application/json": {
3637
- "schema": {
3638
- "$ref": "#/components/schemas/ErrorResponse"
3639
- }
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
+ }
3640
3403
  },
3641
3404
  "text/html": {
3642
3405
  "schema": {
@@ -3675,7 +3438,7 @@
3675
3438
  }
3676
3439
  }
3677
3440
  },
3678
- "409": {
3441
+ "404": {
3679
3442
  "description": "Request error",
3680
3443
  "content": {
3681
3444
  "application/json": {
@@ -3736,17 +3499,20 @@
3736
3499
  }
3737
3500
  }
3738
3501
  },
3739
- "tags": ["Project"]
3502
+ "tags": ["Files"]
3740
3503
  }
3741
3504
  },
3742
- "/v2/project/tags/create": {
3505
+ "/v2/project/files/info": {
3743
3506
  "post": {
3744
- "operationId": "createTag",
3745
- "summary": "Create or update a tag",
3746
- "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.",
3747
3510
  "security": [
3748
3511
  {
3749
3512
  "BearerAuth": []
3513
+ },
3514
+ {
3515
+ "UserBearerAuth": []
3750
3516
  }
3751
3517
  ],
3752
3518
  "parameters": [
@@ -3769,10 +3535,10 @@
3769
3535
  {
3770
3536
  "schema": {
3771
3537
  "type": "string",
3772
- "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."
3773
3539
  },
3774
3540
  "required": false,
3775
- "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.",
3776
3542
  "name": "gt-project-id",
3777
3543
  "in": "header"
3778
3544
  }
@@ -3784,12 +3550,7 @@
3784
3550
  "schema": {
3785
3551
  "type": "object",
3786
3552
  "properties": {
3787
- "tagId": {
3788
- "type": "string",
3789
- "minLength": 1,
3790
- "maxLength": 255
3791
- },
3792
- "files": {
3553
+ "sourceFiles": {
3793
3554
  "type": "array",
3794
3555
  "items": {
3795
3556
  "type": "object",
@@ -3808,58 +3569,167 @@
3808
3569
  }
3809
3570
  },
3810
3571
  "required": ["fileId", "versionId", "branchId"]
3811
- },
3812
- "minItems": 1
3572
+ }
3813
3573
  },
3814
- "message": {
3815
- "type": "string",
3816
- "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
+ }
3817
3598
  }
3818
- },
3819
- "required": ["tagId", "files"]
3599
+ }
3820
3600
  }
3821
3601
  }
3822
3602
  }
3823
3603
  },
3824
3604
  "responses": {
3825
3605
  "200": {
3826
- "description": "Created or updated file tag",
3606
+ "description": "File information",
3827
3607
  "content": {
3828
3608
  "application/json": {
3829
3609
  "schema": {
3830
3610
  "type": "object",
3831
3611
  "properties": {
3832
- "tag": {
3833
- "type": "object",
3834
- "properties": {
3835
- "id": {
3836
- "type": "string"
3837
- },
3838
- "tagId": {
3839
- "type": "string"
3840
- },
3841
- "message": {
3842
- "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
+ }
3843
3656
  },
3844
- "createdAt": {
3845
- "type": "string",
3846
- "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
+ }
3847
3715
  },
3848
- "updatedAt": {
3849
- "type": "string",
3850
- "format": "date-time"
3851
- }
3852
- },
3853
- "required": [
3854
- "id",
3855
- "tagId",
3856
- "message",
3857
- "createdAt",
3858
- "updatedAt"
3859
- ]
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
+ }
3860
3730
  }
3861
3731
  },
3862
- "required": ["tag"]
3732
+ "required": ["sourceFiles", "translatedFiles"]
3863
3733
  }
3864
3734
  }
3865
3735
  }
@@ -3955,29 +3825,23 @@
3955
3825
  }
3956
3826
  }
3957
3827
  },
3958
- "tags": ["Project"]
3828
+ "tags": ["Files"]
3959
3829
  }
3960
3830
  },
3961
- "/v2/project/info/{projectId}": {
3962
- "get": {
3963
- "operationId": "getProjectInfo",
3964
- "summary": "Get Project information",
3965
- "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.",
3966
3836
  "security": [
3967
3837
  {
3968
3838
  "BearerAuth": []
3839
+ },
3840
+ {
3841
+ "UserBearerAuth": []
3969
3842
  }
3970
3843
  ],
3971
3844
  "parameters": [
3972
- {
3973
- "schema": {
3974
- "type": "string",
3975
- "minLength": 1
3976
- },
3977
- "required": true,
3978
- "name": "projectId",
3979
- "in": "path"
3980
- },
3981
3845
  {
3982
3846
  "schema": {
3983
3847
  "type": "string",
@@ -3997,52 +3861,134 @@
3997
3861
  {
3998
3862
  "schema": {
3999
3863
  "type": "string",
4000
- "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."
4001
3865
  },
4002
3866
  "required": false,
4003
- "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.",
4004
3868
  "name": "gt-project-id",
4005
3869
  "in": "header"
4006
3870
  }
4007
3871
  ],
4008
- "responses": {
4009
- "200": {
4010
- "description": "Project information",
4011
- "content": {
4012
- "application/json": {
4013
- "schema": {
3872
+ "requestBody": {
3873
+ "required": true,
3874
+ "content": {
3875
+ "application/json": {
3876
+ "schema": {
3877
+ "type": "array",
3878
+ "items": {
4014
3879
  "type": "object",
4015
3880
  "properties": {
4016
- "id": {
4017
- "type": "string"
3881
+ "fileId": {
3882
+ "type": "string",
3883
+ "minLength": 1
4018
3884
  },
4019
- "name": {
4020
- "type": "string"
3885
+ "branchId": {
3886
+ "type": "string",
3887
+ "minLength": 1
4021
3888
  },
4022
- "orgId": {
4023
- "type": "string"
3889
+ "versionId": {
3890
+ "type": "string",
3891
+ "minLength": 1
4024
3892
  },
4025
- "defaultLocale": {
4026
- "type": ["string", "null"]
3893
+ "locale": {
3894
+ "type": "string",
3895
+ "minLength": 1
4027
3896
  },
4028
- "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": {
4029
3918
  "type": "array",
4030
3919
  "items": {
4031
- "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
+ ]
4032
3959
  }
4033
3960
  },
4034
- "autoApprove": {
4035
- "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
+ }
4036
3989
  }
4037
3990
  },
4038
- "required": [
4039
- "id",
4040
- "name",
4041
- "orgId",
4042
- "defaultLocale",
4043
- "currentLocales",
4044
- "autoApprove"
4045
- ]
3991
+ "required": ["files", "count"]
4046
3992
  }
4047
3993
  }
4048
3994
  }
@@ -4092,7 +4038,7 @@
4092
4038
  }
4093
4039
  }
4094
4040
  },
4095
- "404": {
4041
+ "413": {
4096
4042
  "description": "Request error",
4097
4043
  "content": {
4098
4044
  "application/json": {
@@ -4138,15 +4084,21 @@
4138
4084
  }
4139
4085
  }
4140
4086
  },
4141
- "tags": ["Project"]
4142
- },
4143
- "post": {
4144
- "operationId": "updateProjectInfo",
4145
- "summary": "Update Project information",
4146
- "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`.",
4147
4096
  "security": [
4148
4097
  {
4149
4098
  "BearerAuth": []
4099
+ },
4100
+ {
4101
+ "UserBearerAuth": []
4150
4102
  }
4151
4103
  ],
4152
4104
  "parameters": [
@@ -4156,9 +4108,33 @@
4156
4108
  "minLength": 1
4157
4109
  },
4158
4110
  "required": true,
4159
- "name": "projectId",
4111
+ "name": "fileId",
4160
4112
  "in": "path"
4161
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
+ },
4162
4138
  {
4163
4139
  "schema": {
4164
4140
  "type": "string",
@@ -4178,46 +4154,27 @@
4178
4154
  {
4179
4155
  "schema": {
4180
4156
  "type": "string",
4181
- "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."
4182
4158
  },
4183
4159
  "required": false,
4184
- "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.",
4185
4161
  "name": "gt-project-id",
4186
4162
  "in": "header"
4187
4163
  }
4188
4164
  ],
4189
- "requestBody": {
4190
- "required": true,
4191
- "content": {
4192
- "application/json": {
4193
- "schema": {
4194
- "type": "object",
4195
- "properties": {
4196
- "defaultLocale": {
4197
- "type": "string"
4198
- },
4199
- "cdnEnabled": {
4200
- "type": "boolean"
4201
- }
4202
- }
4203
- }
4204
- }
4205
- }
4206
- },
4207
4165
  "responses": {
4208
4166
  "200": {
4209
- "description": "Project settings updated",
4167
+ "description": "Downloaded file",
4210
4168
  "content": {
4211
4169
  "application/json": {
4212
4170
  "schema": {
4213
4171
  "type": "object",
4214
4172
  "properties": {
4215
- "success": {
4216
- "type": "boolean",
4217
- "enum": [true]
4173
+ "data": {
4174
+ "type": "string"
4218
4175
  }
4219
4176
  },
4220
- "required": ["success"]
4177
+ "required": ["data"]
4221
4178
  }
4222
4179
  }
4223
4180
  }
@@ -4282,17 +4239,22 @@
4282
4239
  }
4283
4240
  }
4284
4241
  },
4285
- "413": {
4286
- "description": "Request error",
4242
+ "425": {
4243
+ "description": "Translation is still processing",
4287
4244
  "content": {
4288
4245
  "application/json": {
4289
4246
  "schema": {
4290
- "$ref": "#/components/schemas/ErrorResponse"
4291
- }
4292
- },
4293
- "text/html": {
4294
- "schema": {
4295
- "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"]
4296
4258
  }
4297
4259
  }
4298
4260
  }
@@ -4328,7 +4290,7 @@
4328
4290
  }
4329
4291
  }
4330
4292
  },
4331
- "tags": ["Project"]
4293
+ "tags": ["Files"]
4332
4294
  }
4333
4295
  },
4334
4296
  "/v2/project/jobs/info": {
@@ -4339,6 +4301,9 @@
4339
4301
  "security": [
4340
4302
  {
4341
4303
  "BearerAuth": []
4304
+ },
4305
+ {
4306
+ "UserBearerAuth": []
4342
4307
  }
4343
4308
  ],
4344
4309
  "parameters": [
@@ -4361,10 +4326,10 @@
4361
4326
  {
4362
4327
  "schema": {
4363
4328
  "type": "string",
4364
- "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."
4365
4330
  },
4366
4331
  "required": false,
4367
- "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.",
4368
4333
  "name": "gt-project-id",
4369
4334
  "in": "header"
4370
4335
  }
@@ -4588,14 +4553,17 @@
4588
4553
  "tags": ["Translation"]
4589
4554
  }
4590
4555
  },
4591
- "/v2/translate": {
4556
+ "/v2/project/setup/generate": {
4592
4557
  "post": {
4593
- "operationId": "translate",
4594
- "summary": "Translate content at runtime",
4595
- "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.",
4596
4561
  "security": [
4597
4562
  {
4598
4563
  "BearerAuth": []
4564
+ },
4565
+ {
4566
+ "UserBearerAuth": []
4599
4567
  }
4600
4568
  ],
4601
4569
  "parameters": [
@@ -4618,10 +4586,10 @@
4618
4586
  {
4619
4587
  "schema": {
4620
4588
  "type": "string",
4621
- "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."
4622
4590
  },
4623
4591
  "required": false,
4624
- "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.",
4625
4593
  "name": "gt-project-id",
4626
4594
  "in": "header"
4627
4595
  }
@@ -4631,48 +4599,82 @@
4631
4599
  "content": {
4632
4600
  "application/json": {
4633
4601
  "schema": {
4634
- "$ref": "#/components/schemas/RuntimeTranslationRequest"
4635
- }
4636
- }
4637
- }
4638
- },
4639
- "responses": {
4640
- "200": {
4641
- "description": "All translations were served from cache",
4642
- "content": {
4643
- "application/json": {
4644
- "schema": {
4645
- "$ref": "#/components/schemas/RuntimeTranslationResponse"
4646
- }
4647
- }
4648
- }
4649
- },
4650
- "201": {
4651
- "description": "Translations completed",
4652
- "content": {
4653
- "application/json": {
4654
- "schema": {
4655
- "$ref": "#/components/schemas/RuntimeTranslationResponse"
4656
- }
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"]
4657
4638
  }
4658
4639
  }
4659
- },
4660
- "400": {
4661
- "description": "Request error",
4640
+ }
4641
+ },
4642
+ "responses": {
4643
+ "200": {
4644
+ "description": "Context generation status",
4662
4645
  "content": {
4663
4646
  "application/json": {
4664
4647
  "schema": {
4665
- "$ref": "#/components/schemas/ErrorResponse"
4666
- }
4667
- },
4668
- "text/html": {
4669
- "schema": {
4670
- "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
+ ]
4671
4673
  }
4672
4674
  }
4673
4675
  }
4674
4676
  },
4675
- "401": {
4677
+ "400": {
4676
4678
  "description": "Request error",
4677
4679
  "content": {
4678
4680
  "application/json": {
@@ -4687,7 +4689,7 @@
4687
4689
  }
4688
4690
  }
4689
4691
  },
4690
- "402": {
4692
+ "401": {
4691
4693
  "description": "Request error",
4692
4694
  "content": {
4693
4695
  "application/json": {
@@ -4778,17 +4780,20 @@
4778
4780
  }
4779
4781
  }
4780
4782
  },
4781
- "tags": ["Translation"]
4783
+ "tags": ["Context"]
4782
4784
  }
4783
4785
  },
4784
- "/v2/project/files/info": {
4786
+ "/v2/project/files/publish": {
4785
4787
  "post": {
4786
- "operationId": "getFileInfo",
4787
- "summary": "Get file metadata",
4788
- "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.",
4789
4791
  "security": [
4790
4792
  {
4791
4793
  "BearerAuth": []
4794
+ },
4795
+ {
4796
+ "UserBearerAuth": []
4792
4797
  }
4793
4798
  ],
4794
4799
  "parameters": [
@@ -4811,10 +4816,10 @@
4811
4816
  {
4812
4817
  "schema": {
4813
4818
  "type": "string",
4814
- "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."
4815
4820
  },
4816
4821
  "required": false,
4817
- "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.",
4818
4823
  "name": "gt-project-id",
4819
4824
  "in": "header"
4820
4825
  }
@@ -4826,28 +4831,7 @@
4826
4831
  "schema": {
4827
4832
  "type": "object",
4828
4833
  "properties": {
4829
- "sourceFiles": {
4830
- "type": "array",
4831
- "items": {
4832
- "type": "object",
4833
- "properties": {
4834
- "fileId": {
4835
- "type": "string",
4836
- "minLength": 1
4837
- },
4838
- "versionId": {
4839
- "type": "string",
4840
- "minLength": 1
4841
- },
4842
- "branchId": {
4843
- "type": "string",
4844
- "minLength": 1
4845
- }
4846
- },
4847
- "required": ["fileId", "versionId", "branchId"]
4848
- }
4849
- },
4850
- "translatedFiles": {
4834
+ "files": {
4851
4835
  "type": "array",
4852
4836
  "items": {
4853
4837
  "type": "object",
@@ -4864,148 +4848,62 @@
4864
4848
  "type": "string",
4865
4849
  "minLength": 1
4866
4850
  },
4867
- "locale": {
4868
- "type": "string",
4869
- "minLength": 1
4851
+ "publish": {
4852
+ "type": "boolean"
4870
4853
  }
4871
4854
  },
4872
- "required": ["fileId", "versionId", "branchId", "locale"]
4873
- }
4855
+ "required": ["fileId", "versionId", "publish"]
4856
+ },
4857
+ "minItems": 1
4874
4858
  }
4875
- }
4859
+ },
4860
+ "required": ["files"]
4876
4861
  }
4877
4862
  }
4878
4863
  }
4879
4864
  },
4880
4865
  "responses": {
4881
4866
  "200": {
4882
- "description": "File information",
4867
+ "description": "File publish results",
4883
4868
  "content": {
4884
4869
  "application/json": {
4885
4870
  "schema": {
4886
4871
  "type": "object",
4887
4872
  "properties": {
4888
- "sourceFiles": {
4873
+ "results": {
4889
4874
  "type": "array",
4890
4875
  "items": {
4891
4876
  "type": "object",
4892
4877
  "properties": {
4893
- "branchId": {
4894
- "type": "string"
4895
- },
4896
4878
  "fileId": {
4897
4879
  "type": "string"
4898
4880
  },
4899
4881
  "versionId": {
4900
4882
  "type": "string"
4901
4883
  },
4902
- "fileName": {
4884
+ "locale": {
4903
4885
  "type": "string"
4904
4886
  },
4905
- "fileFormat": {
4906
- "$ref": "#/components/schemas/FileFormat"
4907
- },
4908
- "dataFormat": {
4909
- "type": ["string", "null"]
4910
- },
4911
- "createdAt": {
4912
- "type": "string",
4913
- "format": "date-time"
4914
- },
4915
- "updatedAt": {
4916
- "type": "string",
4917
- "format": "date-time"
4918
- },
4919
- "publishedAt": {
4920
- "type": ["string", "null"],
4921
- "format": "date-time"
4922
- },
4923
- "locales": {
4924
- "type": "array",
4925
- "items": {
4926
- "type": "string"
4927
- }
4928
- },
4929
- "sourceLocale": {
4930
- "type": "string"
4931
- }
4932
- },
4933
- "required": [
4934
- "branchId",
4935
- "fileId",
4936
- "versionId",
4937
- "fileName",
4938
- "fileFormat",
4939
- "dataFormat",
4940
- "createdAt",
4941
- "updatedAt",
4942
- "publishedAt",
4943
- "locales",
4944
- "sourceLocale"
4945
- ]
4946
- }
4947
- },
4948
- "translatedFiles": {
4949
- "type": "array",
4950
- "items": {
4951
- "type": "object",
4952
- "properties": {
4953
4887
  "branchId": {
4954
4888
  "type": "string"
4955
4889
  },
4956
- "fileId": {
4957
- "type": "string"
4958
- },
4959
- "versionId": {
4960
- "type": "string"
4961
- },
4962
- "fileFormat": {
4963
- "$ref": "#/components/schemas/FileFormat"
4964
- },
4965
- "dataFormat": {
4966
- "type": ["string", "null"]
4967
- },
4968
- "createdAt": {
4969
- "type": "string",
4970
- "format": "date-time"
4971
- },
4972
- "updatedAt": {
4973
- "type": "string",
4974
- "format": "date-time"
4975
- },
4976
- "approvedAt": {
4977
- "type": ["string", "null"],
4978
- "format": "date-time"
4979
- },
4980
- "publishedAt": {
4981
- "type": ["string", "null"],
4982
- "format": "date-time"
4983
- },
4984
- "completedAt": {
4985
- "type": ["string", "null"],
4986
- "format": "date-time"
4890
+ "success": {
4891
+ "type": "boolean"
4987
4892
  },
4988
- "locale": {
4893
+ "error": {
4989
4894
  "type": "string"
4990
4895
  }
4991
4896
  },
4992
4897
  "required": [
4993
- "branchId",
4994
4898
  "fileId",
4995
4899
  "versionId",
4996
- "fileFormat",
4997
- "dataFormat",
4998
- "createdAt",
4999
- "updatedAt",
5000
- "approvedAt",
5001
- "publishedAt",
5002
- "completedAt",
5003
- "locale"
4900
+ "branchId",
4901
+ "success"
5004
4902
  ]
5005
4903
  }
5006
4904
  }
5007
4905
  },
5008
- "required": ["sourceFiles", "translatedFiles"]
4906
+ "required": ["results"]
5009
4907
  }
5010
4908
  }
5011
4909
  }
@@ -5055,6 +4953,21 @@
5055
4953
  }
5056
4954
  }
5057
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
+ },
5058
4971
  "413": {
5059
4972
  "description": "Request error",
5060
4973
  "content": {
@@ -5104,42 +5017,20 @@
5104
5017
  "tags": ["Files"]
5105
5018
  }
5106
5019
  },
5107
- "/v2/project/translations/files/status/{fileId}": {
5108
- "get": {
5109
- "operationId": "getTranslationStatus",
5110
- "summary": "Get translation status for a file",
5111
- "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.",
5112
5025
  "security": [
5113
5026
  {
5114
5027
  "BearerAuth": []
5028
+ },
5029
+ {
5030
+ "UserBearerAuth": []
5115
5031
  }
5116
5032
  ],
5117
5033
  "parameters": [
5118
- {
5119
- "schema": {
5120
- "type": "string",
5121
- "minLength": 1
5122
- },
5123
- "required": true,
5124
- "name": "fileId",
5125
- "in": "path"
5126
- },
5127
- {
5128
- "schema": {
5129
- "type": "string"
5130
- },
5131
- "required": false,
5132
- "name": "versionId",
5133
- "in": "query"
5134
- },
5135
- {
5136
- "schema": {
5137
- "type": "string"
5138
- },
5139
- "required": false,
5140
- "name": "branchId",
5141
- "in": "query"
5142
- },
5143
5034
  {
5144
5035
  "schema": {
5145
5036
  "type": "string",
@@ -5159,119 +5050,164 @@
5159
5050
  {
5160
5051
  "schema": {
5161
5052
  "type": "string",
5162
- "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."
5163
5054
  },
5164
5055
  "required": false,
5165
- "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.",
5166
5057
  "name": "gt-project-id",
5167
5058
  "in": "header"
5168
5059
  }
5169
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
+ },
5170
5160
  "responses": {
5171
- "200": {
5172
- "description": "Translation status",
5161
+ "201": {
5162
+ "description": "Uploaded source files",
5173
5163
  "content": {
5174
5164
  "application/json": {
5175
5165
  "schema": {
5176
5166
  "type": "object",
5177
5167
  "properties": {
5178
- "translations": {
5168
+ "uploadedFiles": {
5179
5169
  "type": "array",
5180
5170
  "items": {
5181
5171
  "type": "object",
5182
5172
  "properties": {
5183
- "locale": {
5173
+ "branchId": {
5184
5174
  "type": "string"
5185
5175
  },
5186
- "completedAt": {
5187
- "type": ["string", "null"],
5188
- "format": "date-time"
5176
+ "fileId": {
5177
+ "type": "string"
5189
5178
  },
5190
- "approvedAt": {
5191
- "type": ["string", "null"],
5192
- "format": "date-time"
5179
+ "versionId": {
5180
+ "type": "string"
5193
5181
  },
5194
- "publishedAt": {
5195
- "type": ["string", "null"],
5196
- "format": "date-time"
5182
+ "fileName": {
5183
+ "type": "string"
5197
5184
  },
5198
- "createdAt": {
5199
- "type": ["string", "null"],
5200
- "format": "date-time"
5185
+ "fileFormat": {
5186
+ "$ref": "#/components/schemas/FileFormat"
5201
5187
  },
5202
- "updatedAt": {
5203
- "type": ["string", "null"],
5204
- "format": "date-time"
5188
+ "dataFormat": {
5189
+ "type": "string"
5190
+ },
5191
+ "locale": {
5192
+ "type": "string"
5205
5193
  }
5206
5194
  },
5207
5195
  "required": [
5208
- "locale",
5209
- "completedAt",
5210
- "approvedAt",
5211
- "publishedAt",
5212
- "createdAt",
5213
- "updatedAt"
5196
+ "fileId",
5197
+ "versionId",
5198
+ "fileName",
5199
+ "fileFormat"
5214
5200
  ]
5215
5201
  }
5216
5202
  },
5217
- "sourceFile": {
5218
- "type": "object",
5219
- "properties": {
5220
- "id": {
5221
- "type": "string"
5222
- },
5223
- "branchId": {
5224
- "type": "string"
5225
- },
5226
- "fileId": {
5227
- "type": "string"
5228
- },
5229
- "versionId": {
5230
- "type": "string"
5231
- },
5232
- "fileName": {
5233
- "type": "string"
5234
- },
5235
- "sourceLocale": {
5236
- "type": "string"
5237
- },
5238
- "fileFormat": {
5239
- "$ref": "#/components/schemas/FileFormat"
5240
- },
5241
- "dataFormat": {
5242
- "type": ["string", "null"]
5243
- },
5244
- "createdAt": {
5245
- "type": "string",
5246
- "format": "date-time"
5247
- },
5248
- "updatedAt": {
5249
- "type": "string",
5250
- "format": "date-time"
5251
- },
5252
- "locales": {
5253
- "type": "array",
5254
- "items": {
5255
- "type": "string"
5256
- }
5257
- }
5258
- },
5259
- "required": [
5260
- "id",
5261
- "branchId",
5262
- "fileId",
5263
- "versionId",
5264
- "fileName",
5265
- "sourceLocale",
5266
- "fileFormat",
5267
- "dataFormat",
5268
- "createdAt",
5269
- "updatedAt",
5270
- "locales"
5271
- ]
5203
+ "count": {
5204
+ "type": "number"
5205
+ },
5206
+ "message": {
5207
+ "type": "string"
5272
5208
  }
5273
5209
  },
5274
- "required": ["translations", "sourceFile"]
5210
+ "required": ["uploadedFiles", "count", "message"]
5275
5211
  }
5276
5212
  }
5277
5213
  }
@@ -5336,6 +5272,21 @@
5336
5272
  }
5337
5273
  }
5338
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
+ },
5339
5290
  "429": {
5340
5291
  "description": "Request error",
5341
5292
  "content": {
@@ -5365,19 +5316,37 @@
5365
5316
  }
5366
5317
  }
5367
5318
  }
5368
- }
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
+ }
5369
5335
  },
5370
5336
  "tags": ["Files"]
5371
5337
  }
5372
5338
  },
5373
- "/v2/project/files/moves": {
5339
+ "/v2/project/translations/enqueue": {
5374
5340
  "post": {
5375
- "operationId": "processFileMoves",
5376
- "summary": "Move or rename files",
5377
- "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`.",
5378
5344
  "security": [
5379
5345
  {
5380
5346
  "BearerAuth": []
5347
+ },
5348
+ {
5349
+ "UserBearerAuth": []
5381
5350
  }
5382
5351
  ],
5383
5352
  "parameters": [
@@ -5400,10 +5369,10 @@
5400
5369
  {
5401
5370
  "schema": {
5402
5371
  "type": "string",
5403
- "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."
5404
5373
  },
5405
5374
  "required": false,
5406
- "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.",
5407
5376
  "name": "gt-project-id",
5408
5377
  "in": "header"
5409
5378
  }
@@ -5415,101 +5384,291 @@
5415
5384
  "schema": {
5416
5385
  "type": "object",
5417
5386
  "properties": {
5418
- "branchId": {
5419
- "type": "string"
5420
- },
5421
- "moves": {
5387
+ "files": {
5422
5388
  "type": "array",
5423
5389
  "items": {
5424
5390
  "type": "object",
5425
5391
  "properties": {
5426
- "oldFileId": {
5392
+ "branchId": {
5427
5393
  "type": "string",
5428
5394
  "minLength": 1
5429
5395
  },
5430
- "newFileId": {
5396
+ "fileId": {
5431
5397
  "type": "string",
5432
5398
  "minLength": 1
5433
5399
  },
5434
- "newFileName": {
5400
+ "versionId": {
5435
5401
  "type": "string",
5436
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
+ ]
5437
5429
  }
5438
5430
  },
5439
- "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"
5440
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"
5441
5454
  }
5442
5455
  },
5443
- "required": ["moves"]
5456
+ "required": ["files"]
5444
5457
  }
5445
5458
  }
5446
5459
  }
5447
5460
  },
5448
5461
  "responses": {
5449
5462
  "200": {
5450
- "description": "File move results",
5463
+ "description": "Enqueued translations. Shape depends on gt-api-version (legacy before 2025-11-03.v1).",
5451
5464
  "content": {
5452
5465
  "application/json": {
5453
5466
  "schema": {
5454
- "type": "object",
5455
- "properties": {
5456
- "results": {
5457
- "type": "array",
5458
- "items": {
5459
- "type": "object",
5460
- "properties": {
5461
- "oldFileId": {
5462
- "type": "string"
5463
- },
5464
- "newFileId": {
5465
- "type": "string"
5466
- },
5467
- "success": {
5468
- "type": "boolean"
5469
- },
5470
- "newSourceFileId": {
5471
- "type": "string"
5472
- },
5473
- "clonedTranslationsCount": {
5474
- "type": "integer"
5475
- },
5476
- "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": {
5477
5548
  "type": "string"
5478
5549
  }
5479
5550
  },
5480
- "required": ["oldFileId", "newFileId", "success"]
5481
- }
5551
+ "message": {
5552
+ "type": "string"
5553
+ }
5554
+ },
5555
+ "required": ["jobData", "locales", "message"]
5482
5556
  },
5483
- "summary": {
5557
+ {
5484
5558
  "type": "object",
5485
5559
  "properties": {
5486
- "total": {
5487
- "type": "integer",
5488
- "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
+ }
5489
5602
  },
5490
- "succeeded": {
5491
- "type": "integer",
5492
- "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
+ }
5493
5617
  },
5494
- "failed": {
5495
- "type": "integer",
5496
- "minimum": 0
5618
+ "locales": {
5619
+ "type": "array",
5620
+ "items": {
5621
+ "type": "string"
5622
+ }
5623
+ },
5624
+ "message": {
5625
+ "type": "string"
5497
5626
  }
5498
5627
  },
5499
- "required": ["total", "succeeded", "failed"]
5628
+ "required": ["translations", "data", "locales", "message"]
5500
5629
  }
5501
- },
5502
- "required": ["results"]
5630
+ ]
5503
5631
  }
5504
5632
  }
5505
5633
  }
5506
5634
  },
5507
5635
  "400": {
5508
- "description": "Request error",
5636
+ "description": "Invalid request or missing source files",
5509
5637
  "content": {
5510
5638
  "application/json": {
5511
5639
  "schema": {
5512
- "$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
+ ]
5513
5672
  }
5514
5673
  },
5515
5674
  "text/html": {
@@ -5534,195 +5693,7 @@
5534
5693
  }
5535
5694
  }
5536
5695
  },
5537
- "403": {
5538
- "description": "Request error",
5539
- "content": {
5540
- "application/json": {
5541
- "schema": {
5542
- "$ref": "#/components/schemas/ErrorResponse"
5543
- }
5544
- },
5545
- "text/html": {
5546
- "schema": {
5547
- "type": "string"
5548
- }
5549
- }
5550
- }
5551
- },
5552
- "404": {
5553
- "description": "Request error",
5554
- "content": {
5555
- "application/json": {
5556
- "schema": {
5557
- "$ref": "#/components/schemas/ErrorResponse"
5558
- }
5559
- },
5560
- "text/html": {
5561
- "schema": {
5562
- "type": "string"
5563
- }
5564
- }
5565
- }
5566
- },
5567
- "413": {
5568
- "description": "Request error",
5569
- "content": {
5570
- "application/json": {
5571
- "schema": {
5572
- "$ref": "#/components/schemas/ErrorResponse"
5573
- }
5574
- },
5575
- "text/html": {
5576
- "schema": {
5577
- "type": "string"
5578
- }
5579
- }
5580
- }
5581
- },
5582
- "429": {
5583
- "description": "Request error",
5584
- "content": {
5585
- "application/json": {
5586
- "schema": {
5587
- "$ref": "#/components/schemas/ErrorResponse"
5588
- }
5589
- },
5590
- "text/html": {
5591
- "schema": {
5592
- "type": "string"
5593
- }
5594
- }
5595
- }
5596
- },
5597
- "500": {
5598
- "description": "Request error",
5599
- "content": {
5600
- "application/json": {
5601
- "schema": {
5602
- "$ref": "#/components/schemas/ErrorResponse"
5603
- }
5604
- },
5605
- "text/html": {
5606
- "schema": {
5607
- "type": "string"
5608
- }
5609
- }
5610
- }
5611
- }
5612
- },
5613
- "tags": ["Files"]
5614
- }
5615
- },
5616
- "/v2/project/files/orphaned": {
5617
- "post": {
5618
- "operationId": "getOrphanedFiles",
5619
- "summary": "Find orphaned files",
5620
- "description": "Return files on a branch that are not present in the provided file ID list.",
5621
- "security": [
5622
- {
5623
- "BearerAuth": []
5624
- }
5625
- ],
5626
- "parameters": [
5627
- {
5628
- "schema": {
5629
- "type": "string",
5630
- "enum": [
5631
- "2025-01-01.v0",
5632
- "2025-11-03.v1",
5633
- "2026-02-18.v1",
5634
- "2026-03-06.v1"
5635
- ],
5636
- "description": "API contract version. Defaults to the oldest supported version."
5637
- },
5638
- "required": false,
5639
- "description": "API contract version. Defaults to the oldest supported version.",
5640
- "name": "gt-api-version",
5641
- "in": "header"
5642
- },
5643
- {
5644
- "schema": {
5645
- "type": "string",
5646
- "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)."
5647
- },
5648
- "required": false,
5649
- "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).",
5650
- "name": "gt-project-id",
5651
- "in": "header"
5652
- }
5653
- ],
5654
- "requestBody": {
5655
- "required": true,
5656
- "content": {
5657
- "application/json": {
5658
- "schema": {
5659
- "type": "object",
5660
- "properties": {
5661
- "branchId": {
5662
- "type": "string",
5663
- "minLength": 1
5664
- },
5665
- "fileIds": {
5666
- "type": "array",
5667
- "items": {
5668
- "type": "string"
5669
- },
5670
- "default": []
5671
- }
5672
- },
5673
- "required": ["branchId"]
5674
- }
5675
- }
5676
- }
5677
- },
5678
- "responses": {
5679
- "200": {
5680
- "description": "Files present on the branch but absent from the request",
5681
- "content": {
5682
- "application/json": {
5683
- "schema": {
5684
- "type": "object",
5685
- "properties": {
5686
- "orphanedFiles": {
5687
- "type": "array",
5688
- "items": {
5689
- "type": "object",
5690
- "properties": {
5691
- "fileId": {
5692
- "type": "string"
5693
- },
5694
- "versionId": {
5695
- "type": "string"
5696
- },
5697
- "fileName": {
5698
- "type": "string"
5699
- }
5700
- },
5701
- "required": ["fileId", "versionId", "fileName"]
5702
- }
5703
- }
5704
- },
5705
- "required": ["orphanedFiles"]
5706
- }
5707
- }
5708
- }
5709
- },
5710
- "400": {
5711
- "description": "Request error",
5712
- "content": {
5713
- "application/json": {
5714
- "schema": {
5715
- "$ref": "#/components/schemas/ErrorResponse"
5716
- }
5717
- },
5718
- "text/html": {
5719
- "schema": {
5720
- "type": "string"
5721
- }
5722
- }
5723
- }
5724
- },
5725
- "401": {
5696
+ "402": {
5726
5697
  "description": "Request error",
5727
5698
  "content": {
5728
5699
  "application/json": {
@@ -5813,7 +5784,7 @@
5813
5784
  }
5814
5785
  }
5815
5786
  },
5816
- "tags": ["Files"]
5787
+ "tags": ["Translation"]
5817
5788
  }
5818
5789
  },
5819
5790
  "/cli/wizard/session": {