@firedrill-tools/unstructured 0.1.4

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 (72) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +275 -0
  3. package/firedrill/agent.target.json +16 -0
  4. package/firedrill/baseline.scenario.json +5 -0
  5. package/firedrill/conformance.suite.json +21 -0
  6. package/firedrill/overloaded.scenario.json +11 -0
  7. package/firedrill/rate-limited.scenario.json +11 -0
  8. package/firedrill/run-response-lost.scenario.json +11 -0
  9. package/firedrill/small-responses.scenario.json +21 -0
  10. package/firedrill/tight-limits.scenario.json +21 -0
  11. package/firedrill/tools/unstructured/behavior.mjs +69 -0
  12. package/firedrill/tools/unstructured/lib/connectors.mjs +68 -0
  13. package/firedrill/tools/unstructured/lib/errors.mjs +58 -0
  14. package/firedrill/tools/unstructured/lib/gzip.mjs +38 -0
  15. package/firedrill/tools/unstructured/lib/identity.mjs +19 -0
  16. package/firedrill/tools/unstructured/lib/ids.mjs +36 -0
  17. package/firedrill/tools/unstructured/lib/jobs-derive.mjs +92 -0
  18. package/firedrill/tools/unstructured/lib/multipart.mjs +171 -0
  19. package/firedrill/tools/unstructured/lib/pages.mjs +40 -0
  20. package/firedrill/tools/unstructured/lib/partition/chunk.mjs +243 -0
  21. package/firedrill/tools/unstructured/lib/partition/csv.mjs +85 -0
  22. package/firedrill/tools/unstructured/lib/partition/csvout.mjs +25 -0
  23. package/firedrill/tools/unstructured/lib/partition/elements.mjs +171 -0
  24. package/firedrill/tools/unstructured/lib/partition/email.mjs +269 -0
  25. package/firedrill/tools/unstructured/lib/partition/html-tokens.mjs +134 -0
  26. package/firedrill/tools/unstructured/lib/partition/html-util.mjs +99 -0
  27. package/firedrill/tools/unstructured/lib/partition/html.mjs +211 -0
  28. package/firedrill/tools/unstructured/lib/partition/index.mjs +122 -0
  29. package/firedrill/tools/unstructured/lib/partition/markdown.mjs +220 -0
  30. package/firedrill/tools/unstructured/lib/partition/other.mjs +118 -0
  31. package/firedrill/tools/unstructured/lib/partition/text.mjs +53 -0
  32. package/firedrill/tools/unstructured/lib/sha256.mjs +161 -0
  33. package/firedrill/tools/unstructured/lib/store.mjs +33 -0
  34. package/firedrill/tools/unstructured/lib/util.mjs +149 -0
  35. package/firedrill/tools/unstructured/lib/validate.mjs +115 -0
  36. package/firedrill/tools/unstructured/lib/wire-multipart.mjs +78 -0
  37. package/firedrill/tools/unstructured/lib/wire.mjs +154 -0
  38. package/firedrill/tools/unstructured/ops/connectors.mjs +129 -0
  39. package/firedrill/tools/unstructured/ops/jobs.mjs +83 -0
  40. package/firedrill/tools/unstructured/ops/nodes.mjs +107 -0
  41. package/firedrill/tools/unstructured/ops/partition.mjs +112 -0
  42. package/firedrill/tools/unstructured/ops/workflows.mjs +180 -0
  43. package/firedrill/tools/unstructured/unstructured.tool.json +4892 -0
  44. package/firedrill/unstructured-archivist.drill.json +68 -0
  45. package/firedrill/unstructured-chunking.drill.json +67 -0
  46. package/firedrill/unstructured-connectors.drill.json +121 -0
  47. package/firedrill/unstructured-denied.drill.json +58 -0
  48. package/firedrill/unstructured-fresh-actor.drill.json +68 -0
  49. package/firedrill/unstructured-overloaded.drill.json +51 -0
  50. package/firedrill/unstructured-partition-errors.drill.json +66 -0
  51. package/firedrill/unstructured-partition.drill.json +95 -0
  52. package/firedrill/unstructured-rate-limited.drill.json +66 -0
  53. package/firedrill/unstructured-revoked-key.drill.json +773 -0
  54. package/firedrill/unstructured-run-lost.drill.json +51 -0
  55. package/firedrill/unstructured-small-responses.drill.json +173 -0
  56. package/firedrill/unstructured-tight-limits.drill.json +203 -0
  57. package/firedrill/unstructured-workflows-jobs.drill.json +167 -0
  58. package/firedrill/world.json +1556 -0
  59. package/firedrill.json +5 -0
  60. package/package.json +52 -0
  61. package/starter.json +1114 -0
  62. package/test/conformance.mjs +37 -0
  63. package/test/flows/access.mjs +54 -0
  64. package/test/flows/chunking.mjs +95 -0
  65. package/test/flows/connectors.mjs +76 -0
  66. package/test/flows/errors.mjs +115 -0
  67. package/test/flows/faults.mjs +73 -0
  68. package/test/flows/partition.mjs +225 -0
  69. package/test/flows/workflows.mjs +123 -0
  70. package/test/hostile-gen.mjs +0 -0
  71. package/test/hostile.mjs +155 -0
  72. package/test/lib.mjs +113 -0
package/firedrill/tools/unstructured/unstructured.tool.json ADDED
@@ -0,0 +1,4892 @@
1
+ {
2
+ "schemaVersion": 1,
3
+ "module": "./behavior.mjs",
4
+ "manifest": {
5
+ "schemaVersion": 1,
6
+ "id": "unstructured",
7
+ "version": "0.1.4",
8
+ "engine": ">=0.1.0 <0.2.0",
9
+ "capabilities": [
10
+ "clock.read",
11
+ "event.emit",
12
+ "random.draw",
13
+ "state.read",
14
+ "state.write"
15
+ ],
16
+ "state": [
17
+ {
18
+ "namespace": "connection-checks",
19
+ "schema": {
20
+ "type": "object",
21
+ "required": [
22
+ "source_id",
23
+ "status",
24
+ "reason",
25
+ "created_at"
26
+ ],
27
+ "properties": {
28
+ "source_id": {
29
+ "type": "string",
30
+ "minLength": 1,
31
+ "maxLength": 512
32
+ },
33
+ "status": {
34
+ "type": "string",
35
+ "enum": [
36
+ "SCHEDULED",
37
+ "SUCCESS",
38
+ "FAILURE"
39
+ ]
40
+ },
41
+ "reason": {
42
+ "anyOf": [
43
+ {
44
+ "type": "string",
45
+ "maxLength": 500
46
+ },
47
+ {
48
+ "type": "null"
49
+ }
50
+ ]
51
+ },
52
+ "created_at": {
53
+ "type": "string",
54
+ "maxLength": 40
55
+ }
56
+ },
57
+ "additionalProperties": false
58
+ }
59
+ },
60
+ {
61
+ "namespace": "destinations",
62
+ "schema": {
63
+ "type": "object",
64
+ "required": [
65
+ "id",
66
+ "workspace_id",
67
+ "seq",
68
+ "name",
69
+ "type",
70
+ "config",
71
+ "key",
72
+ "created_at",
73
+ "updated_at"
74
+ ],
75
+ "properties": {
76
+ "id": {
77
+ "type": "string",
78
+ "minLength": 1,
79
+ "maxLength": 512
80
+ },
81
+ "workspace_id": {
82
+ "type": "string",
83
+ "maxLength": 64
84
+ },
85
+ "seq": {
86
+ "type": "integer",
87
+ "minimum": 0
88
+ },
89
+ "name": {
90
+ "type": "string",
91
+ "maxLength": 200
92
+ },
93
+ "type": {
94
+ "type": "string",
95
+ "maxLength": 64
96
+ },
97
+ "config": {
98
+ "type": "object",
99
+ "maxProperties": 40,
100
+ "additionalProperties": {
101
+ "anyOf": [
102
+ {
103
+ "type": "string",
104
+ "maxLength": 2000
105
+ },
106
+ {
107
+ "type": "number"
108
+ },
109
+ {
110
+ "type": "boolean"
111
+ },
112
+ {
113
+ "type": "null"
114
+ }
115
+ ]
116
+ }
117
+ },
118
+ "key": {
119
+ "anyOf": [
120
+ {
121
+ "type": "string",
122
+ "maxLength": 63
123
+ },
124
+ {
125
+ "type": "null"
126
+ }
127
+ ]
128
+ },
129
+ "created_at": {
130
+ "type": "string",
131
+ "maxLength": 40
132
+ },
133
+ "updated_at": {
134
+ "anyOf": [
135
+ {
136
+ "type": "string",
137
+ "maxLength": 40
138
+ },
139
+ {
140
+ "type": "null"
141
+ }
142
+ ]
143
+ }
144
+ },
145
+ "additionalProperties": false
146
+ }
147
+ },
148
+ {
149
+ "namespace": "job-files",
150
+ "schema": {
151
+ "type": "object",
152
+ "required": [
153
+ "job_id",
154
+ "file_id",
155
+ "filename",
156
+ "content_type",
157
+ "size_bytes",
158
+ "content"
159
+ ],
160
+ "properties": {
161
+ "job_id": {
162
+ "type": "string",
163
+ "minLength": 1,
164
+ "maxLength": 512
165
+ },
166
+ "file_id": {
167
+ "type": "string",
168
+ "maxLength": 120
169
+ },
170
+ "filename": {
171
+ "type": "string",
172
+ "maxLength": 200
173
+ },
174
+ "content_type": {
175
+ "type": "string",
176
+ "maxLength": 100
177
+ },
178
+ "size_bytes": {
179
+ "type": "integer",
180
+ "minimum": 0
181
+ },
182
+ "content": {
183
+ "type": "string",
184
+ "maxLength": 1100000
185
+ }
186
+ },
187
+ "additionalProperties": false
188
+ }
189
+ },
190
+ {
191
+ "namespace": "jobs",
192
+ "schema": {
193
+ "type": "object",
194
+ "required": [
195
+ "id",
196
+ "workspace_id",
197
+ "seq",
198
+ "workflow_id",
199
+ "workflow_name",
200
+ "job_type",
201
+ "created_at",
202
+ "cancelled_at",
203
+ "stop_requested",
204
+ "files",
205
+ "nodes",
206
+ "destination_node_id",
207
+ "created_by"
208
+ ],
209
+ "properties": {
210
+ "id": {
211
+ "type": "string",
212
+ "minLength": 1,
213
+ "maxLength": 512
214
+ },
215
+ "workspace_id": {
216
+ "type": "string",
217
+ "maxLength": 64
218
+ },
219
+ "seq": {
220
+ "type": "integer",
221
+ "minimum": 0
222
+ },
223
+ "workflow_id": {
224
+ "type": "string",
225
+ "minLength": 1,
226
+ "maxLength": 512
227
+ },
228
+ "workflow_name": {
229
+ "type": "string",
230
+ "maxLength": 200
231
+ },
232
+ "job_type": {
233
+ "type": "string",
234
+ "maxLength": 20
235
+ },
236
+ "created_at": {
237
+ "type": "string",
238
+ "maxLength": 40
239
+ },
240
+ "cancelled_at": {
241
+ "anyOf": [
242
+ {
243
+ "type": "string",
244
+ "maxLength": 40
245
+ },
246
+ {
247
+ "type": "null"
248
+ }
249
+ ]
250
+ },
251
+ "stop_requested": {
252
+ "type": "boolean"
253
+ },
254
+ "files": {
255
+ "type": "array",
256
+ "items": {
257
+ "type": "object",
258
+ "required": [
259
+ "file_id",
260
+ "source_row",
261
+ "filename",
262
+ "path",
263
+ "content_type",
264
+ "size_bytes",
265
+ "error"
266
+ ],
267
+ "properties": {
268
+ "file_id": {
269
+ "type": "string",
270
+ "maxLength": 300
271
+ },
272
+ "source_row": {
273
+ "anyOf": [
274
+ {
275
+ "type": "string",
276
+ "maxLength": 512
277
+ },
278
+ {
279
+ "type": "null"
280
+ }
281
+ ]
282
+ },
283
+ "filename": {
284
+ "type": "string",
285
+ "maxLength": 200
286
+ },
287
+ "path": {
288
+ "type": "string",
289
+ "maxLength": 500
290
+ },
291
+ "content_type": {
292
+ "type": "string",
293
+ "maxLength": 100
294
+ },
295
+ "size_bytes": {
296
+ "type": "integer",
297
+ "minimum": 0
298
+ },
299
+ "error": {
300
+ "anyOf": [
301
+ {
302
+ "type": "string",
303
+ "maxLength": 500
304
+ },
305
+ {
306
+ "type": "null"
307
+ }
308
+ ]
309
+ }
310
+ },
311
+ "additionalProperties": false
312
+ },
313
+ "maxItems": 232
314
+ },
315
+ "nodes": {
316
+ "type": "array",
317
+ "items": {
318
+ "type": "object",
319
+ "required": [
320
+ "id",
321
+ "name",
322
+ "type",
323
+ "subtype",
324
+ "settings"
325
+ ],
326
+ "properties": {
327
+ "id": {
328
+ "type": "string",
329
+ "maxLength": 64
330
+ },
331
+ "name": {
332
+ "type": "string",
333
+ "maxLength": 200
334
+ },
335
+ "type": {
336
+ "type": "string",
337
+ "enum": [
338
+ "partition",
339
+ "chunk",
340
+ "embed",
341
+ "prompter"
342
+ ]
343
+ },
344
+ "subtype": {
345
+ "type": "string",
346
+ "maxLength": 100
347
+ },
348
+ "settings": {
349
+ "type": "object",
350
+ "maxProperties": 40,
351
+ "additionalProperties": {
352
+ "anyOf": [
353
+ {
354
+ "type": "string",
355
+ "maxLength": 2000
356
+ },
357
+ {
358
+ "type": "number"
359
+ },
360
+ {
361
+ "type": "boolean"
362
+ },
363
+ {
364
+ "type": "null"
365
+ }
366
+ ]
367
+ }
368
+ }
369
+ },
370
+ "additionalProperties": false
371
+ },
372
+ "maxItems": 16
373
+ },
374
+ "destination_node_id": {
375
+ "anyOf": [
376
+ {
377
+ "type": "string",
378
+ "maxLength": 64
379
+ },
380
+ {
381
+ "type": "null"
382
+ }
383
+ ]
384
+ },
385
+ "created_by": {
386
+ "type": "string",
387
+ "maxLength": 200
388
+ }
389
+ },
390
+ "additionalProperties": false
391
+ }
392
+ },
393
+ {
394
+ "namespace": "meta",
395
+ "schema": {
396
+ "type": "object",
397
+ "properties": {
398
+ "next_seq": {
399
+ "type": "integer",
400
+ "minimum": 0
401
+ },
402
+ "connectors": {
403
+ "type": "integer",
404
+ "minimum": 0
405
+ },
406
+ "workflows": {
407
+ "type": "integer",
408
+ "minimum": 0
409
+ },
410
+ "jobs": {
411
+ "type": "integer",
412
+ "minimum": 0
413
+ },
414
+ "files_per_source": {
415
+ "type": "integer",
416
+ "minimum": 0
417
+ },
418
+ "source_file_bytes": {
419
+ "type": "integer",
420
+ "minimum": 0
421
+ },
422
+ "response_bytes": {
423
+ "type": "integer",
424
+ "minimum": 0
425
+ }
426
+ },
427
+ "additionalProperties": false
428
+ }
429
+ },
430
+ {
431
+ "namespace": "partition-log",
432
+ "schema": {
433
+ "type": "object",
434
+ "required": [
435
+ "seq",
436
+ "actor_id",
437
+ "filenames",
438
+ "filetypes",
439
+ "strategy",
440
+ "chunking_strategy",
441
+ "output_format",
442
+ "element_count",
443
+ "page_count",
444
+ "input_bytes",
445
+ "created_at"
446
+ ],
447
+ "properties": {
448
+ "seq": {
449
+ "type": "integer",
450
+ "minimum": 0
451
+ },
452
+ "actor_id": {
453
+ "type": "string",
454
+ "maxLength": 200
455
+ },
456
+ "filenames": {
457
+ "type": "array",
458
+ "items": {
459
+ "type": "string",
460
+ "maxLength": 200
461
+ },
462
+ "maxItems": 32
463
+ },
464
+ "filetypes": {
465
+ "type": "array",
466
+ "items": {
467
+ "type": "string",
468
+ "maxLength": 100
469
+ },
470
+ "maxItems": 32
471
+ },
472
+ "strategy": {
473
+ "type": "string",
474
+ "maxLength": 20
475
+ },
476
+ "chunking_strategy": {
477
+ "anyOf": [
478
+ {
479
+ "type": "string",
480
+ "maxLength": 20
481
+ },
482
+ {
483
+ "type": "null"
484
+ }
485
+ ]
486
+ },
487
+ "output_format": {
488
+ "type": "string",
489
+ "maxLength": 40
490
+ },
491
+ "element_count": {
492
+ "type": "integer",
493
+ "minimum": 0
494
+ },
495
+ "page_count": {
496
+ "type": "integer",
497
+ "minimum": 0
498
+ },
499
+ "input_bytes": {
500
+ "type": "integer",
501
+ "minimum": 0
502
+ },
503
+ "created_at": {
504
+ "type": "string",
505
+ "maxLength": 40
506
+ }
507
+ },
508
+ "additionalProperties": false
509
+ }
510
+ },
511
+ {
512
+ "namespace": "source-files",
513
+ "schema": {
514
+ "type": "object",
515
+ "required": [
516
+ "source_id",
517
+ "file_id",
518
+ "path",
519
+ "filename",
520
+ "content_type",
521
+ "size_bytes",
522
+ "last_modified",
523
+ "content",
524
+ "error"
525
+ ],
526
+ "properties": {
527
+ "source_id": {
528
+ "type": "string",
529
+ "minLength": 1,
530
+ "maxLength": 512
531
+ },
532
+ "file_id": {
533
+ "type": "string",
534
+ "maxLength": 120
535
+ },
536
+ "path": {
537
+ "type": "string",
538
+ "maxLength": 500
539
+ },
540
+ "filename": {
541
+ "type": "string",
542
+ "maxLength": 200
543
+ },
544
+ "content_type": {
545
+ "type": "string",
546
+ "maxLength": 100
547
+ },
548
+ "size_bytes": {
549
+ "type": "integer",
550
+ "minimum": 0
551
+ },
552
+ "last_modified": {
553
+ "type": "string",
554
+ "maxLength": 40
555
+ },
556
+ "content": {
557
+ "type": "string",
558
+ "maxLength": 262144
559
+ },
560
+ "error": {
561
+ "anyOf": [
562
+ {
563
+ "type": "string",
564
+ "maxLength": 500
565
+ },
566
+ {
567
+ "type": "null"
568
+ }
569
+ ]
570
+ }
571
+ },
572
+ "additionalProperties": false
573
+ }
574
+ },
575
+ {
576
+ "namespace": "sources",
577
+ "schema": {
578
+ "type": "object",
579
+ "required": [
580
+ "id",
581
+ "workspace_id",
582
+ "seq",
583
+ "name",
584
+ "type",
585
+ "config",
586
+ "key",
587
+ "created_at",
588
+ "updated_at"
589
+ ],
590
+ "properties": {
591
+ "id": {
592
+ "type": "string",
593
+ "minLength": 1,
594
+ "maxLength": 512
595
+ },
596
+ "workspace_id": {
597
+ "type": "string",
598
+ "maxLength": 64
599
+ },
600
+ "seq": {
601
+ "type": "integer",
602
+ "minimum": 0
603
+ },
604
+ "name": {
605
+ "type": "string",
606
+ "maxLength": 200
607
+ },
608
+ "type": {
609
+ "type": "string",
610
+ "maxLength": 64
611
+ },
612
+ "config": {
613
+ "type": "object",
614
+ "maxProperties": 40,
615
+ "additionalProperties": {
616
+ "anyOf": [
617
+ {
618
+ "type": "string",
619
+ "maxLength": 2000
620
+ },
621
+ {
622
+ "type": "number"
623
+ },
624
+ {
625
+ "type": "boolean"
626
+ },
627
+ {
628
+ "type": "null"
629
+ }
630
+ ]
631
+ }
632
+ },
633
+ "key": {
634
+ "anyOf": [
635
+ {
636
+ "type": "string",
637
+ "maxLength": 63
638
+ },
639
+ {
640
+ "type": "null"
641
+ }
642
+ ]
643
+ },
644
+ "created_at": {
645
+ "type": "string",
646
+ "maxLength": 40
647
+ },
648
+ "updated_at": {
649
+ "anyOf": [
650
+ {
651
+ "type": "string",
652
+ "maxLength": 40
653
+ },
654
+ {
655
+ "type": "null"
656
+ }
657
+ ]
658
+ }
659
+ },
660
+ "additionalProperties": false
661
+ }
662
+ },
663
+ {
664
+ "namespace": "workflows",
665
+ "schema": {
666
+ "type": "object",
667
+ "required": [
668
+ "id",
669
+ "workspace_id",
670
+ "seq",
671
+ "name",
672
+ "workflow_type",
673
+ "source_id",
674
+ "destination_id",
675
+ "status",
676
+ "schedule",
677
+ "workflow_nodes",
678
+ "reprocess_all",
679
+ "key",
680
+ "created_at",
681
+ "updated_at"
682
+ ],
683
+ "properties": {
684
+ "id": {
685
+ "type": "string",
686
+ "minLength": 1,
687
+ "maxLength": 512
688
+ },
689
+ "workspace_id": {
690
+ "type": "string",
691
+ "maxLength": 64
692
+ },
693
+ "seq": {
694
+ "type": "integer",
695
+ "minimum": 0
696
+ },
697
+ "name": {
698
+ "type": "string",
699
+ "maxLength": 200
700
+ },
701
+ "workflow_type": {
702
+ "type": "string",
703
+ "enum": [
704
+ "auto",
705
+ "custom"
706
+ ]
707
+ },
708
+ "source_id": {
709
+ "anyOf": [
710
+ {
711
+ "type": "string",
712
+ "minLength": 1,
713
+ "maxLength": 512
714
+ },
715
+ {
716
+ "type": "null"
717
+ }
718
+ ]
719
+ },
720
+ "destination_id": {
721
+ "anyOf": [
722
+ {
723
+ "type": "string",
724
+ "minLength": 1,
725
+ "maxLength": 512
726
+ },
727
+ {
728
+ "type": "null"
729
+ }
730
+ ]
731
+ },
732
+ "status": {
733
+ "type": "string",
734
+ "enum": [
735
+ "active",
736
+ "inactive",
737
+ "paused"
738
+ ]
739
+ },
740
+ "schedule": {
741
+ "anyOf": [
742
+ {
743
+ "type": "string",
744
+ "maxLength": 40
745
+ },
746
+ {
747
+ "type": "null"
748
+ }
749
+ ]
750
+ },
751
+ "workflow_nodes": {
752
+ "type": "array",
753
+ "items": {
754
+ "type": "object",
755
+ "required": [
756
+ "id",
757
+ "name",
758
+ "type",
759
+ "subtype",
760
+ "settings"
761
+ ],
762
+ "properties": {
763
+ "id": {
764
+ "type": "string",
765
+ "maxLength": 64
766
+ },
767
+ "name": {
768
+ "type": "string",
769
+ "maxLength": 200
770
+ },
771
+ "type": {
772
+ "type": "string",
773
+ "enum": [
774
+ "partition",
775
+ "chunk",
776
+ "embed",
777
+ "prompter"
778
+ ]
779
+ },
780
+ "subtype": {
781
+ "type": "string",
782
+ "maxLength": 100
783
+ },
784
+ "settings": {
785
+ "type": "object",
786
+ "maxProperties": 40,
787
+ "additionalProperties": {
788
+ "anyOf": [
789
+ {
790
+ "type": "string",
791
+ "maxLength": 2000
792
+ },
793
+ {
794
+ "type": "number"
795
+ },
796
+ {
797
+ "type": "boolean"
798
+ },
799
+ {
800
+ "type": "null"
801
+ }
802
+ ]
803
+ }
804
+ }
805
+ },
806
+ "additionalProperties": false
807
+ },
808
+ "maxItems": 16
809
+ },
810
+ "reprocess_all": {
811
+ "type": "boolean"
812
+ },
813
+ "key": {
814
+ "anyOf": [
815
+ {
816
+ "type": "string",
817
+ "maxLength": 63
818
+ },
819
+ {
820
+ "type": "null"
821
+ }
822
+ ]
823
+ },
824
+ "created_at": {
825
+ "type": "string",
826
+ "maxLength": 40
827
+ },
828
+ "updated_at": {
829
+ "anyOf": [
830
+ {
831
+ "type": "string",
832
+ "maxLength": 40
833
+ },
834
+ {
835
+ "type": "null"
836
+ }
837
+ ]
838
+ }
839
+ },
840
+ "additionalProperties": false
841
+ }
842
+ },
843
+ {
844
+ "namespace": "workspaces",
845
+ "schema": {
846
+ "type": "object",
847
+ "required": [
848
+ "id",
849
+ "name",
850
+ "created_at"
851
+ ],
852
+ "properties": {
853
+ "id": {
854
+ "type": "string",
855
+ "maxLength": 64
856
+ },
857
+ "name": {
858
+ "type": "string",
859
+ "maxLength": 200
860
+ },
861
+ "created_at": {
862
+ "type": "string",
863
+ "maxLength": 40
864
+ }
865
+ },
866
+ "additionalProperties": false
867
+ }
868
+ }
869
+ ],
870
+ "operations": [
871
+ {
872
+ "id": "destinations.create",
873
+ "description": "Create a destination connector; the required configuration keys of its type must be present and secrets are masked in responses.",
874
+ "inputSchema": {
875
+ "type": "object",
876
+ "properties": {
877
+ "name": {},
878
+ "type": {},
879
+ "config": {},
880
+ "key": {},
881
+ "__request_error": {
882
+ "type": "string",
883
+ "maxLength": 300
884
+ }
885
+ },
886
+ "additionalProperties": false
887
+ },
888
+ "outputSchema": {
889
+ "type": "object",
890
+ "required": [
891
+ "id",
892
+ "name",
893
+ "type",
894
+ "config",
895
+ "created_at",
896
+ "updated_at",
897
+ "key"
898
+ ],
899
+ "properties": {
900
+ "id": {
901
+ "type": "string",
902
+ "minLength": 1,
903
+ "maxLength": 512
904
+ },
905
+ "name": {
906
+ "type": "string",
907
+ "maxLength": 200
908
+ },
909
+ "type": {
910
+ "type": "string",
911
+ "maxLength": 64
912
+ },
913
+ "config": {
914
+ "type": "object",
915
+ "maxProperties": 40,
916
+ "additionalProperties": {
917
+ "anyOf": [
918
+ {
919
+ "type": "string",
920
+ "maxLength": 2000
921
+ },
922
+ {
923
+ "type": "number"
924
+ },
925
+ {
926
+ "type": "boolean"
927
+ },
928
+ {
929
+ "type": "null"
930
+ }
931
+ ]
932
+ }
933
+ },
934
+ "created_at": {
935
+ "type": "string",
936
+ "maxLength": 40
937
+ },
938
+ "updated_at": {
939
+ "anyOf": [
940
+ {
941
+ "type": "string",
942
+ "maxLength": 40
943
+ },
944
+ {
945
+ "type": "null"
946
+ }
947
+ ]
948
+ },
949
+ "key": {
950
+ "anyOf": [
951
+ {
952
+ "type": "string",
953
+ "maxLength": 63
954
+ },
955
+ {
956
+ "type": "null"
957
+ }
958
+ ]
959
+ }
960
+ },
961
+ "additionalProperties": false
962
+ },
963
+ "declaredErrors": [
964
+ "INTERNAL_ERROR",
965
+ "UNAUTHORIZED",
966
+ "VALIDATION_ERROR"
967
+ ],
968
+ "idempotency": "optional",
969
+ "fidelity": "behavioral"
970
+ },
971
+ {
972
+ "id": "destinations.delete",
973
+ "description": "Delete a destination connector that no running job uses.",
974
+ "inputSchema": {
975
+ "type": "object",
976
+ "required": [
977
+ "destination_id"
978
+ ],
979
+ "properties": {
980
+ "destination_id": {
981
+ "type": "string",
982
+ "minLength": 1,
983
+ "maxLength": 512
984
+ }
985
+ },
986
+ "additionalProperties": false
987
+ },
988
+ "outputSchema": {
989
+ "type": "object",
990
+ "additionalProperties": false
991
+ },
992
+ "declaredErrors": [
993
+ "INTERNAL_ERROR",
994
+ "NOT_FOUND",
995
+ "UNAUTHORIZED",
996
+ "VALIDATION_ERROR"
997
+ ],
998
+ "idempotency": "optional",
999
+ "fidelity": "behavioral"
1000
+ },
1001
+ {
1002
+ "id": "destinations.get",
1003
+ "description": "Read one destination connector by id.",
1004
+ "inputSchema": {
1005
+ "type": "object",
1006
+ "required": [
1007
+ "destination_id"
1008
+ ],
1009
+ "properties": {
1010
+ "destination_id": {
1011
+ "type": "string",
1012
+ "minLength": 1,
1013
+ "maxLength": 512
1014
+ }
1015
+ },
1016
+ "additionalProperties": false
1017
+ },
1018
+ "outputSchema": {
1019
+ "type": "object",
1020
+ "required": [
1021
+ "id",
1022
+ "name",
1023
+ "type",
1024
+ "config",
1025
+ "created_at",
1026
+ "updated_at",
1027
+ "key"
1028
+ ],
1029
+ "properties": {
1030
+ "id": {
1031
+ "type": "string",
1032
+ "minLength": 1,
1033
+ "maxLength": 512
1034
+ },
1035
+ "name": {
1036
+ "type": "string",
1037
+ "maxLength": 200
1038
+ },
1039
+ "type": {
1040
+ "type": "string",
1041
+ "maxLength": 64
1042
+ },
1043
+ "config": {
1044
+ "type": "object",
1045
+ "maxProperties": 40,
1046
+ "additionalProperties": {
1047
+ "anyOf": [
1048
+ {
1049
+ "type": "string",
1050
+ "maxLength": 2000
1051
+ },
1052
+ {
1053
+ "type": "number"
1054
+ },
1055
+ {
1056
+ "type": "boolean"
1057
+ },
1058
+ {
1059
+ "type": "null"
1060
+ }
1061
+ ]
1062
+ }
1063
+ },
1064
+ "created_at": {
1065
+ "type": "string",
1066
+ "maxLength": 40
1067
+ },
1068
+ "updated_at": {
1069
+ "anyOf": [
1070
+ {
1071
+ "type": "string",
1072
+ "maxLength": 40
1073
+ },
1074
+ {
1075
+ "type": "null"
1076
+ }
1077
+ ]
1078
+ },
1079
+ "key": {
1080
+ "anyOf": [
1081
+ {
1082
+ "type": "string",
1083
+ "maxLength": 63
1084
+ },
1085
+ {
1086
+ "type": "null"
1087
+ }
1088
+ ]
1089
+ }
1090
+ },
1091
+ "additionalProperties": false
1092
+ },
1093
+ "declaredErrors": [
1094
+ "NOT_FOUND",
1095
+ "UNAUTHORIZED"
1096
+ ],
1097
+ "idempotency": "none",
1098
+ "fidelity": "stateful"
1099
+ },
1100
+ {
1101
+ "id": "destinations.list",
1102
+ "description": "List every destination connector of the workspace, optionally filtered by destination_type; fails RESPONSE_TOO_LARGE instead of truncating when the array would pass the response budget.",
1103
+ "inputSchema": {
1104
+ "type": "object",
1105
+ "properties": {
1106
+ "destination_type": {},
1107
+ "__request_error": {
1108
+ "type": "string",
1109
+ "maxLength": 300
1110
+ }
1111
+ },
1112
+ "additionalProperties": false
1113
+ },
1114
+ "outputSchema": {
1115
+ "type": "array",
1116
+ "items": {
1117
+ "type": "object",
1118
+ "required": [
1119
+ "id",
1120
+ "name",
1121
+ "type",
1122
+ "config",
1123
+ "created_at",
1124
+ "updated_at",
1125
+ "key"
1126
+ ],
1127
+ "properties": {
1128
+ "id": {
1129
+ "type": "string",
1130
+ "minLength": 1,
1131
+ "maxLength": 512
1132
+ },
1133
+ "name": {
1134
+ "type": "string",
1135
+ "maxLength": 200
1136
+ },
1137
+ "type": {
1138
+ "type": "string",
1139
+ "maxLength": 64
1140
+ },
1141
+ "config": {
1142
+ "type": "object",
1143
+ "maxProperties": 40,
1144
+ "additionalProperties": {
1145
+ "anyOf": [
1146
+ {
1147
+ "type": "string",
1148
+ "maxLength": 2000
1149
+ },
1150
+ {
1151
+ "type": "number"
1152
+ },
1153
+ {
1154
+ "type": "boolean"
1155
+ },
1156
+ {
1157
+ "type": "null"
1158
+ }
1159
+ ]
1160
+ }
1161
+ },
1162
+ "created_at": {
1163
+ "type": "string",
1164
+ "maxLength": 40
1165
+ },
1166
+ "updated_at": {
1167
+ "anyOf": [
1168
+ {
1169
+ "type": "string",
1170
+ "maxLength": 40
1171
+ },
1172
+ {
1173
+ "type": "null"
1174
+ }
1175
+ ]
1176
+ },
1177
+ "key": {
1178
+ "anyOf": [
1179
+ {
1180
+ "type": "string",
1181
+ "maxLength": 63
1182
+ },
1183
+ {
1184
+ "type": "null"
1185
+ }
1186
+ ]
1187
+ }
1188
+ },
1189
+ "additionalProperties": false
1190
+ },
1191
+ "maxItems": 2000
1192
+ },
1193
+ "declaredErrors": [
1194
+ "INTERNAL_ERROR",
1195
+ "RESPONSE_TOO_LARGE",
1196
+ "UNAUTHORIZED",
1197
+ "VALIDATION_ERROR"
1198
+ ],
1199
+ "idempotency": "none",
1200
+ "fidelity": "stateful"
1201
+ },
1202
+ {
1203
+ "id": "destinations.update",
1204
+ "description": "Update the name or configuration of a destination connector; the type cannot change and a masked secret keeps its stored value.",
1205
+ "inputSchema": {
1206
+ "type": "object",
1207
+ "required": [
1208
+ "destination_id"
1209
+ ],
1210
+ "properties": {
1211
+ "destination_id": {
1212
+ "type": "string",
1213
+ "minLength": 1,
1214
+ "maxLength": 512
1215
+ },
1216
+ "name": {},
1217
+ "type": {},
1218
+ "config": {},
1219
+ "key": {},
1220
+ "__request_error": {
1221
+ "type": "string",
1222
+ "maxLength": 300
1223
+ }
1224
+ },
1225
+ "additionalProperties": false
1226
+ },
1227
+ "outputSchema": {
1228
+ "type": "object",
1229
+ "required": [
1230
+ "id",
1231
+ "name",
1232
+ "type",
1233
+ "config",
1234
+ "created_at",
1235
+ "updated_at",
1236
+ "key"
1237
+ ],
1238
+ "properties": {
1239
+ "id": {
1240
+ "type": "string",
1241
+ "minLength": 1,
1242
+ "maxLength": 512
1243
+ },
1244
+ "name": {
1245
+ "type": "string",
1246
+ "maxLength": 200
1247
+ },
1248
+ "type": {
1249
+ "type": "string",
1250
+ "maxLength": 64
1251
+ },
1252
+ "config": {
1253
+ "type": "object",
1254
+ "maxProperties": 40,
1255
+ "additionalProperties": {
1256
+ "anyOf": [
1257
+ {
1258
+ "type": "string",
1259
+ "maxLength": 2000
1260
+ },
1261
+ {
1262
+ "type": "number"
1263
+ },
1264
+ {
1265
+ "type": "boolean"
1266
+ },
1267
+ {
1268
+ "type": "null"
1269
+ }
1270
+ ]
1271
+ }
1272
+ },
1273
+ "created_at": {
1274
+ "type": "string",
1275
+ "maxLength": 40
1276
+ },
1277
+ "updated_at": {
1278
+ "anyOf": [
1279
+ {
1280
+ "type": "string",
1281
+ "maxLength": 40
1282
+ },
1283
+ {
1284
+ "type": "null"
1285
+ }
1286
+ ]
1287
+ },
1288
+ "key": {
1289
+ "anyOf": [
1290
+ {
1291
+ "type": "string",
1292
+ "maxLength": 63
1293
+ },
1294
+ {
1295
+ "type": "null"
1296
+ }
1297
+ ]
1298
+ }
1299
+ },
1300
+ "additionalProperties": false
1301
+ },
1302
+ "declaredErrors": [
1303
+ "NOT_FOUND",
1304
+ "UNAUTHORIZED",
1305
+ "VALIDATION_ERROR"
1306
+ ],
1307
+ "idempotency": "optional",
1308
+ "fidelity": "behavioral"
1309
+ },
1310
+ {
1311
+ "id": "general.partition",
1312
+ "description": "Partition one or more UTF-8 text documents (plain text, Markdown, HTML, CSV/TSV, RFC 822, XML, pre-partitioned JSON) into Unstructured elements, optionally chunked (basic, by_title, by_page). Mirrors POST /general/v0/general.",
1313
+ "inputSchema": {
1314
+ "type": "object",
1315
+ "properties": {
1316
+ "files": {
1317
+ "type": "array",
1318
+ "items": {
1319
+ "type": "object",
1320
+ "required": [
1321
+ "filename",
1322
+ "content"
1323
+ ],
1324
+ "properties": {
1325
+ "filename": {
1326
+ "type": "string",
1327
+ "maxLength": 500
1328
+ },
1329
+ "content_type": {
1330
+ "anyOf": [
1331
+ {
1332
+ "type": "string",
1333
+ "maxLength": 200
1334
+ },
1335
+ {
1336
+ "type": "null"
1337
+ }
1338
+ ]
1339
+ },
1340
+ "content": {
1341
+ "type": "string",
1342
+ "maxLength": 1100000
1343
+ },
1344
+ "last_modified": {
1345
+ "type": "string",
1346
+ "maxLength": 100
1347
+ },
1348
+ "bad_transfer": {
1349
+ "type": "boolean"
1350
+ }
1351
+ },
1352
+ "additionalProperties": false
1353
+ },
1354
+ "maxItems": 32
1355
+ },
1356
+ "content_type": {},
1357
+ "strategy": {},
1358
+ "output_format": {},
1359
+ "encoding": {},
1360
+ "include_page_breaks": {},
1361
+ "starting_page_number": {},
1362
+ "unique_element_ids": {},
1363
+ "xml_keep_tags": {},
1364
+ "coordinates": {},
1365
+ "chunking_strategy": {},
1366
+ "max_characters": {},
1367
+ "new_after_n_chars": {},
1368
+ "overlap": {},
1369
+ "overlap_all": {},
1370
+ "combine_under_n_chars": {},
1371
+ "multipage_sections": {},
1372
+ "include_orig_elements": {},
1373
+ "vlm_model": {},
1374
+ "vlm_model_provider": {},
1375
+ "hi_res_model_name": {},
1376
+ "split_pdf_page": {},
1377
+ "split_pdf_allow_failed": {},
1378
+ "split_pdf_concurrency_level": {},
1379
+ "split_pdf_page_range": {},
1380
+ "include_slide_notes": {},
1381
+ "pdf_infer_table_structure": {},
1382
+ "languages": {},
1383
+ "ocr_languages": {},
1384
+ "skip_infer_table_types": {},
1385
+ "extract_image_block_types": {},
1386
+ "__request_error": {
1387
+ "type": "string",
1388
+ "maxLength": 300
1389
+ }
1390
+ },
1391
+ "additionalProperties": false
1392
+ },
1393
+ "outputSchema": {
1394
+ "anyOf": [
1395
+ {
1396
+ "type": "array",
1397
+ "items": {
1398
+ "type": "object",
1399
+ "required": [
1400
+ "type",
1401
+ "element_id",
1402
+ "text",
1403
+ "metadata"
1404
+ ],
1405
+ "properties": {
1406
+ "type": {
1407
+ "type": "string",
1408
+ "maxLength": 40
1409
+ },
1410
+ "element_id": {
1411
+ "type": "string",
1412
+ "maxLength": 128
1413
+ },
1414
+ "text": {
1415
+ "type": "string",
1416
+ "maxLength": 100000
1417
+ },
1418
+ "metadata": {
1419
+ "type": "object",
1420
+ "maxProperties": 200,
1421
+ "properties": {
1422
+ "filename": {
1423
+ "type": "string",
1424
+ "maxLength": 10000
1425
+ },
1426
+ "filetype": {
1427
+ "type": "string",
1428
+ "maxLength": 10000
1429
+ },
1430
+ "languages": {
1431
+ "type": "array",
1432
+ "items": {
1433
+ "type": "string",
1434
+ "maxLength": 100
1435
+ },
1436
+ "maxItems": 50
1437
+ },
1438
+ "page_number": {
1439
+ "type": "integer",
1440
+ "minimum": 0
1441
+ },
1442
+ "last_modified": {
1443
+ "type": "string",
1444
+ "maxLength": 10000
1445
+ },
1446
+ "parent_id": {
1447
+ "type": "string",
1448
+ "maxLength": 10000
1449
+ },
1450
+ "category_depth": {
1451
+ "type": "integer",
1452
+ "minimum": 0
1453
+ },
1454
+ "is_continuation": {
1455
+ "type": "boolean"
1456
+ },
1457
+ "text_as_html": {
1458
+ "type": "string",
1459
+ "maxLength": 10000000
1460
+ },
1461
+ "link_urls": {
1462
+ "type": "array",
1463
+ "items": {
1464
+ "type": "string",
1465
+ "maxLength": 1000000
1466
+ },
1467
+ "maxItems": 1000000
1468
+ },
1469
+ "link_texts": {
1470
+ "type": "array",
1471
+ "items": {
1472
+ "type": "string",
1473
+ "maxLength": 1000000
1474
+ },
1475
+ "maxItems": 1000000
1476
+ },
1477
+ "emphasized_text_contents": {
1478
+ "type": "array",
1479
+ "items": {
1480
+ "type": "string",
1481
+ "maxLength": 1000000
1482
+ },
1483
+ "maxItems": 1000000
1484
+ },
1485
+ "emphasized_text_tags": {
1486
+ "type": "array",
1487
+ "items": {
1488
+ "type": "string",
1489
+ "maxLength": 1000000
1490
+ },
1491
+ "maxItems": 1000000
1492
+ },
1493
+ "orig_elements": {
1494
+ "type": "string",
1495
+ "maxLength": 4000000
1496
+ },
1497
+ "image_url": {
1498
+ "type": "string",
1499
+ "maxLength": 1000000
1500
+ },
1501
+ "sent_from": {
1502
+ "type": "array",
1503
+ "items": {
1504
+ "type": "string",
1505
+ "maxLength": 1000000
1506
+ },
1507
+ "maxItems": 1000000
1508
+ },
1509
+ "sent_to": {
1510
+ "type": "array",
1511
+ "items": {
1512
+ "type": "string",
1513
+ "maxLength": 1000000
1514
+ },
1515
+ "maxItems": 1000000
1516
+ },
1517
+ "cc_recipient": {
1518
+ "type": "array",
1519
+ "items": {
1520
+ "type": "string",
1521
+ "maxLength": 1000000
1522
+ },
1523
+ "maxItems": 1000000
1524
+ },
1525
+ "bcc_recipient": {
1526
+ "type": "array",
1527
+ "items": {
1528
+ "type": "string",
1529
+ "maxLength": 1000000
1530
+ },
1531
+ "maxItems": 1000000
1532
+ },
1533
+ "subject": {
1534
+ "type": "string",
1535
+ "maxLength": 1000000
1536
+ },
1537
+ "email_message_id": {
1538
+ "type": "string",
1539
+ "maxLength": 1000000
1540
+ }
1541
+ },
1542
+ "additionalProperties": {
1543
+ "anyOf": [
1544
+ {
1545
+ "type": "string",
1546
+ "maxLength": 10000
1547
+ },
1548
+ {
1549
+ "type": "number"
1550
+ },
1551
+ {
1552
+ "type": "boolean"
1553
+ },
1554
+ {
1555
+ "type": "null"
1556
+ },
1557
+ {
1558
+ "type": "array",
1559
+ "items": {
1560
+ "anyOf": [
1561
+ {
1562
+ "type": "string",
1563
+ "maxLength": 10000
1564
+ },
1565
+ {
1566
+ "type": "number"
1567
+ },
1568
+ {
1569
+ "type": "boolean"
1570
+ },
1571
+ {
1572
+ "type": "null"
1573
+ }
1574
+ ]
1575
+ },
1576
+ "maxItems": 500
1577
+ }
1578
+ ]
1579
+ }
1580
+ }
1581
+ },
1582
+ "additionalProperties": false
1583
+ },
1584
+ "maxItems": 100000
1585
+ },
1586
+ {
1587
+ "type": "object",
1588
+ "required": [
1589
+ "csv"
1590
+ ],
1591
+ "properties": {
1592
+ "csv": {
1593
+ "type": "string",
1594
+ "maxLength": 1000000
1595
+ }
1596
+ },
1597
+ "additionalProperties": false
1598
+ }
1599
+ ]
1600
+ },
1601
+ "declaredErrors": [
1602
+ "INVALID_FILE",
1603
+ "INVALID_REQUEST",
1604
+ "RATE_LIMITED",
1605
+ "RESPONSE_TOO_LARGE",
1606
+ "SERVICE_OVERLOADED",
1607
+ "UNAUTHORIZED",
1608
+ "UNSUPPORTED_FILE_TYPE",
1609
+ "VALIDATION_ERROR"
1610
+ ],
1611
+ "idempotency": "none",
1612
+ "fidelity": "behavioral"
1613
+ },
1614
+ {
1615
+ "id": "jobs.cancel",
1616
+ "description": "Cancel a SCHEDULED or IN_PROGRESS job; it becomes STOPPED.",
1617
+ "inputSchema": {
1618
+ "type": "object",
1619
+ "required": [
1620
+ "job_id"
1621
+ ],
1622
+ "properties": {
1623
+ "job_id": {
1624
+ "type": "string",
1625
+ "minLength": 1,
1626
+ "maxLength": 512
1627
+ }
1628
+ },
1629
+ "additionalProperties": false
1630
+ },
1631
+ "outputSchema": {
1632
+ "type": "object",
1633
+ "required": [
1634
+ "id",
1635
+ "status",
1636
+ "message"
1637
+ ],
1638
+ "properties": {
1639
+ "id": {
1640
+ "type": "string",
1641
+ "minLength": 1,
1642
+ "maxLength": 512
1643
+ },
1644
+ "status": {
1645
+ "type": "string",
1646
+ "maxLength": 20
1647
+ },
1648
+ "message": {
1649
+ "type": "string",
1650
+ "maxLength": 200
1651
+ }
1652
+ },
1653
+ "additionalProperties": false
1654
+ },
1655
+ "declaredErrors": [
1656
+ "NOT_FOUND",
1657
+ "UNAUTHORIZED",
1658
+ "VALIDATION_ERROR"
1659
+ ],
1660
+ "idempotency": "optional",
1661
+ "fidelity": "behavioral"
1662
+ },
1663
+ {
1664
+ "id": "jobs.download_output",
1665
+ "description": "Download the partitioned (and chunked, when the workflow has a chunk node) elements of one successful file of a finished job, computed with the node settings snapshotted at run time.",
1666
+ "inputSchema": {
1667
+ "type": "object",
1668
+ "required": [
1669
+ "job_id"
1670
+ ],
1671
+ "properties": {
1672
+ "job_id": {
1673
+ "type": "string",
1674
+ "minLength": 1,
1675
+ "maxLength": 512
1676
+ },
1677
+ "file_id": {},
1678
+ "node_id": {},
1679
+ "__request_error": {
1680
+ "type": "string",
1681
+ "maxLength": 300
1682
+ }
1683
+ },
1684
+ "additionalProperties": false
1685
+ },
1686
+ "outputSchema": {
1687
+ "type": "array",
1688
+ "items": {
1689
+ "type": "object",
1690
+ "required": [
1691
+ "type",
1692
+ "element_id",
1693
+ "text",
1694
+ "metadata"
1695
+ ],
1696
+ "properties": {
1697
+ "type": {
1698
+ "type": "string",
1699
+ "maxLength": 40
1700
+ },
1701
+ "element_id": {
1702
+ "type": "string",
1703
+ "maxLength": 128
1704
+ },
1705
+ "text": {
1706
+ "type": "string",
1707
+ "maxLength": 100000
1708
+ },
1709
+ "metadata": {
1710
+ "type": "object",
1711
+ "maxProperties": 200,
1712
+ "properties": {
1713
+ "filename": {
1714
+ "type": "string",
1715
+ "maxLength": 10000
1716
+ },
1717
+ "filetype": {
1718
+ "type": "string",
1719
+ "maxLength": 10000
1720
+ },
1721
+ "languages": {
1722
+ "type": "array",
1723
+ "items": {
1724
+ "type": "string",
1725
+ "maxLength": 100
1726
+ },
1727
+ "maxItems": 50
1728
+ },
1729
+ "page_number": {
1730
+ "type": "integer",
1731
+ "minimum": 0
1732
+ },
1733
+ "last_modified": {
1734
+ "type": "string",
1735
+ "maxLength": 10000
1736
+ },
1737
+ "parent_id": {
1738
+ "type": "string",
1739
+ "maxLength": 10000
1740
+ },
1741
+ "category_depth": {
1742
+ "type": "integer",
1743
+ "minimum": 0
1744
+ },
1745
+ "is_continuation": {
1746
+ "type": "boolean"
1747
+ },
1748
+ "text_as_html": {
1749
+ "type": "string",
1750
+ "maxLength": 10000000
1751
+ },
1752
+ "link_urls": {
1753
+ "type": "array",
1754
+ "items": {
1755
+ "type": "string",
1756
+ "maxLength": 1000000
1757
+ },
1758
+ "maxItems": 1000000
1759
+ },
1760
+ "link_texts": {
1761
+ "type": "array",
1762
+ "items": {
1763
+ "type": "string",
1764
+ "maxLength": 1000000
1765
+ },
1766
+ "maxItems": 1000000
1767
+ },
1768
+ "emphasized_text_contents": {
1769
+ "type": "array",
1770
+ "items": {
1771
+ "type": "string",
1772
+ "maxLength": 1000000
1773
+ },
1774
+ "maxItems": 1000000
1775
+ },
1776
+ "emphasized_text_tags": {
1777
+ "type": "array",
1778
+ "items": {
1779
+ "type": "string",
1780
+ "maxLength": 1000000
1781
+ },
1782
+ "maxItems": 1000000
1783
+ },
1784
+ "orig_elements": {
1785
+ "type": "string",
1786
+ "maxLength": 4000000
1787
+ },
1788
+ "image_url": {
1789
+ "type": "string",
1790
+ "maxLength": 1000000
1791
+ },
1792
+ "sent_from": {
1793
+ "type": "array",
1794
+ "items": {
1795
+ "type": "string",
1796
+ "maxLength": 1000000
1797
+ },
1798
+ "maxItems": 1000000
1799
+ },
1800
+ "sent_to": {
1801
+ "type": "array",
1802
+ "items": {
1803
+ "type": "string",
1804
+ "maxLength": 1000000
1805
+ },
1806
+ "maxItems": 1000000
1807
+ },
1808
+ "cc_recipient": {
1809
+ "type": "array",
1810
+ "items": {
1811
+ "type": "string",
1812
+ "maxLength": 1000000
1813
+ },
1814
+ "maxItems": 1000000
1815
+ },
1816
+ "bcc_recipient": {
1817
+ "type": "array",
1818
+ "items": {
1819
+ "type": "string",
1820
+ "maxLength": 1000000
1821
+ },
1822
+ "maxItems": 1000000
1823
+ },
1824
+ "subject": {
1825
+ "type": "string",
1826
+ "maxLength": 1000000
1827
+ },
1828
+ "email_message_id": {
1829
+ "type": "string",
1830
+ "maxLength": 1000000
1831
+ }
1832
+ },
1833
+ "additionalProperties": {
1834
+ "anyOf": [
1835
+ {
1836
+ "type": "string",
1837
+ "maxLength": 10000
1838
+ },
1839
+ {
1840
+ "type": "number"
1841
+ },
1842
+ {
1843
+ "type": "boolean"
1844
+ },
1845
+ {
1846
+ "type": "null"
1847
+ },
1848
+ {
1849
+ "type": "array",
1850
+ "items": {
1851
+ "anyOf": [
1852
+ {
1853
+ "type": "string",
1854
+ "maxLength": 10000
1855
+ },
1856
+ {
1857
+ "type": "number"
1858
+ },
1859
+ {
1860
+ "type": "boolean"
1861
+ },
1862
+ {
1863
+ "type": "null"
1864
+ }
1865
+ ]
1866
+ },
1867
+ "maxItems": 500
1868
+ }
1869
+ ]
1870
+ }
1871
+ }
1872
+ },
1873
+ "additionalProperties": false
1874
+ },
1875
+ "maxItems": 100000
1876
+ },
1877
+ "declaredErrors": [
1878
+ "NOT_FOUND",
1879
+ "RESPONSE_TOO_LARGE",
1880
+ "UNAUTHORIZED",
1881
+ "VALIDATION_ERROR"
1882
+ ],
1883
+ "idempotency": "none",
1884
+ "fidelity": "behavioral"
1885
+ },
1886
+ {
1887
+ "id": "jobs.get",
1888
+ "description": "Read one job with its status, runtime, input file ids and output node files derived from virtual time.",
1889
+ "inputSchema": {
1890
+ "type": "object",
1891
+ "required": [
1892
+ "job_id"
1893
+ ],
1894
+ "properties": {
1895
+ "job_id": {
1896
+ "type": "string",
1897
+ "minLength": 1,
1898
+ "maxLength": 512
1899
+ }
1900
+ },
1901
+ "additionalProperties": false
1902
+ },
1903
+ "outputSchema": {
1904
+ "type": "object",
1905
+ "required": [
1906
+ "id",
1907
+ "workflow_id",
1908
+ "workflow_name",
1909
+ "status",
1910
+ "stop_requested",
1911
+ "created_at",
1912
+ "runtime",
1913
+ "input_file_ids",
1914
+ "output_node_files",
1915
+ "job_type",
1916
+ "created_by_id",
1917
+ "reason"
1918
+ ],
1919
+ "properties": {
1920
+ "id": {
1921
+ "type": "string",
1922
+ "minLength": 1,
1923
+ "maxLength": 512
1924
+ },
1925
+ "workflow_id": {
1926
+ "type": "string",
1927
+ "minLength": 1,
1928
+ "maxLength": 512
1929
+ },
1930
+ "workflow_name": {
1931
+ "type": "string",
1932
+ "maxLength": 200
1933
+ },
1934
+ "status": {
1935
+ "type": "string",
1936
+ "enum": [
1937
+ "SCHEDULED",
1938
+ "IN_PROGRESS",
1939
+ "COMPLETED",
1940
+ "STOPPED",
1941
+ "FAILED"
1942
+ ]
1943
+ },
1944
+ "stop_requested": {
1945
+ "type": "boolean"
1946
+ },
1947
+ "created_at": {
1948
+ "type": "string",
1949
+ "maxLength": 40
1950
+ },
1951
+ "runtime": {
1952
+ "anyOf": [
1953
+ {
1954
+ "type": "string",
1955
+ "maxLength": 40
1956
+ },
1957
+ {
1958
+ "type": "null"
1959
+ }
1960
+ ]
1961
+ },
1962
+ "input_file_ids": {
1963
+ "type": "array",
1964
+ "items": {
1965
+ "type": "string",
1966
+ "maxLength": 300
1967
+ },
1968
+ "maxItems": 232
1969
+ },
1970
+ "output_node_files": {
1971
+ "type": "array",
1972
+ "items": {
1973
+ "type": "object",
1974
+ "required": [
1975
+ "node_id",
1976
+ "file_id",
1977
+ "node_type",
1978
+ "node_subtype"
1979
+ ],
1980
+ "properties": {
1981
+ "node_id": {
1982
+ "type": "string",
1983
+ "maxLength": 64
1984
+ },
1985
+ "file_id": {
1986
+ "type": "string",
1987
+ "maxLength": 300
1988
+ },
1989
+ "node_type": {
1990
+ "type": "string",
1991
+ "maxLength": 20
1992
+ },
1993
+ "node_subtype": {
1994
+ "type": "string",
1995
+ "maxLength": 100
1996
+ }
1997
+ },
1998
+ "additionalProperties": false
1999
+ },
2000
+ "maxItems": 232
2001
+ },
2002
+ "job_type": {
2003
+ "type": "string",
2004
+ "maxLength": 20
2005
+ },
2006
+ "created_by_id": {
2007
+ "type": "string",
2008
+ "maxLength": 200
2009
+ },
2010
+ "reason": {
2011
+ "anyOf": [
2012
+ {
2013
+ "type": "string",
2014
+ "maxLength": 500
2015
+ },
2016
+ {
2017
+ "type": "null"
2018
+ }
2019
+ ]
2020
+ }
2021
+ },
2022
+ "additionalProperties": false
2023
+ },
2024
+ "declaredErrors": [
2025
+ "NOT_FOUND",
2026
+ "UNAUTHORIZED"
2027
+ ],
2028
+ "idempotency": "none",
2029
+ "fidelity": "behavioral"
2030
+ },
2031
+ {
2032
+ "id": "jobs.get_details",
2033
+ "description": "Processing status and per-node file statistics of a job.",
2034
+ "inputSchema": {
2035
+ "type": "object",
2036
+ "required": [
2037
+ "job_id"
2038
+ ],
2039
+ "properties": {
2040
+ "job_id": {
2041
+ "type": "string",
2042
+ "minLength": 1,
2043
+ "maxLength": 512
2044
+ }
2045
+ },
2046
+ "additionalProperties": false
2047
+ },
2048
+ "outputSchema": {
2049
+ "type": "object",
2050
+ "required": [
2051
+ "id",
2052
+ "processing_status",
2053
+ "node_stats",
2054
+ "message"
2055
+ ],
2056
+ "properties": {
2057
+ "id": {
2058
+ "type": "string",
2059
+ "minLength": 1,
2060
+ "maxLength": 512
2061
+ },
2062
+ "processing_status": {
2063
+ "type": "string",
2064
+ "maxLength": 40
2065
+ },
2066
+ "node_stats": {
2067
+ "type": "array",
2068
+ "items": {
2069
+ "type": "object",
2070
+ "required": [
2071
+ "node_name",
2072
+ "node_type",
2073
+ "node_subtype",
2074
+ "ready",
2075
+ "in_progress",
2076
+ "success",
2077
+ "failure"
2078
+ ],
2079
+ "properties": {
2080
+ "node_name": {
2081
+ "type": "string",
2082
+ "maxLength": 200
2083
+ },
2084
+ "node_type": {
2085
+ "type": "string",
2086
+ "maxLength": 20
2087
+ },
2088
+ "node_subtype": {
2089
+ "type": "string",
2090
+ "maxLength": 100
2091
+ },
2092
+ "ready": {
2093
+ "type": "integer",
2094
+ "minimum": 0
2095
+ },
2096
+ "in_progress": {
2097
+ "type": "integer",
2098
+ "minimum": 0
2099
+ },
2100
+ "success": {
2101
+ "type": "integer",
2102
+ "minimum": 0
2103
+ },
2104
+ "failure": {
2105
+ "type": "integer",
2106
+ "minimum": 0
2107
+ }
2108
+ },
2109
+ "additionalProperties": false
2110
+ },
2111
+ "maxItems": 16
2112
+ },
2113
+ "message": {
2114
+ "type": "string",
2115
+ "maxLength": 500
2116
+ }
2117
+ },
2118
+ "additionalProperties": false
2119
+ },
2120
+ "declaredErrors": [
2121
+ "NOT_FOUND",
2122
+ "UNAUTHORIZED"
2123
+ ],
2124
+ "idempotency": "none",
2125
+ "fidelity": "behavioral"
2126
+ },
2127
+ {
2128
+ "id": "jobs.get_failed_files",
2129
+ "description": "The files a job could not process, with the provider-style error text.",
2130
+ "inputSchema": {
2131
+ "type": "object",
2132
+ "required": [
2133
+ "job_id"
2134
+ ],
2135
+ "properties": {
2136
+ "job_id": {
2137
+ "type": "string",
2138
+ "minLength": 1,
2139
+ "maxLength": 512
2140
+ }
2141
+ },
2142
+ "additionalProperties": false
2143
+ },
2144
+ "outputSchema": {
2145
+ "type": "object",
2146
+ "required": [
2147
+ "failed_files"
2148
+ ],
2149
+ "properties": {
2150
+ "failed_files": {
2151
+ "type": "array",
2152
+ "items": {
2153
+ "type": "object",
2154
+ "required": [
2155
+ "document",
2156
+ "error"
2157
+ ],
2158
+ "properties": {
2159
+ "document": {
2160
+ "type": "string",
2161
+ "maxLength": 500
2162
+ },
2163
+ "error": {
2164
+ "type": "string",
2165
+ "maxLength": 500
2166
+ }
2167
+ },
2168
+ "additionalProperties": false
2169
+ },
2170
+ "maxItems": 232
2171
+ }
2172
+ },
2173
+ "additionalProperties": false
2174
+ },
2175
+ "declaredErrors": [
2176
+ "NOT_FOUND",
2177
+ "UNAUTHORIZED"
2178
+ ],
2179
+ "idempotency": "none",
2180
+ "fidelity": "behavioral"
2181
+ },
2182
+ {
2183
+ "id": "jobs.list",
2184
+ "description": "List jobs of the workspace (newest first), filtered by workflow_id and derived status, page-numbered; a page that would pass the response budget fails RESPONSE_TOO_LARGE (lower page_size) instead of being shortened.",
2185
+ "inputSchema": {
2186
+ "type": "object",
2187
+ "properties": {
2188
+ "workflow_id": {},
2189
+ "status": {},
2190
+ "page": {},
2191
+ "page_size": {},
2192
+ "__request_error": {
2193
+ "type": "string",
2194
+ "maxLength": 300
2195
+ }
2196
+ },
2197
+ "additionalProperties": false
2198
+ },
2199
+ "outputSchema": {
2200
+ "type": "array",
2201
+ "items": {
2202
+ "type": "object",
2203
+ "required": [
2204
+ "id",
2205
+ "workflow_id",
2206
+ "workflow_name",
2207
+ "status",
2208
+ "stop_requested",
2209
+ "created_at",
2210
+ "runtime",
2211
+ "input_file_ids",
2212
+ "output_node_files",
2213
+ "job_type",
2214
+ "created_by_id",
2215
+ "reason"
2216
+ ],
2217
+ "properties": {
2218
+ "id": {
2219
+ "type": "string",
2220
+ "minLength": 1,
2221
+ "maxLength": 512
2222
+ },
2223
+ "workflow_id": {
2224
+ "type": "string",
2225
+ "minLength": 1,
2226
+ "maxLength": 512
2227
+ },
2228
+ "workflow_name": {
2229
+ "type": "string",
2230
+ "maxLength": 200
2231
+ },
2232
+ "status": {
2233
+ "type": "string",
2234
+ "enum": [
2235
+ "SCHEDULED",
2236
+ "IN_PROGRESS",
2237
+ "COMPLETED",
2238
+ "STOPPED",
2239
+ "FAILED"
2240
+ ]
2241
+ },
2242
+ "stop_requested": {
2243
+ "type": "boolean"
2244
+ },
2245
+ "created_at": {
2246
+ "type": "string",
2247
+ "maxLength": 40
2248
+ },
2249
+ "runtime": {
2250
+ "anyOf": [
2251
+ {
2252
+ "type": "string",
2253
+ "maxLength": 40
2254
+ },
2255
+ {
2256
+ "type": "null"
2257
+ }
2258
+ ]
2259
+ },
2260
+ "input_file_ids": {
2261
+ "type": "array",
2262
+ "items": {
2263
+ "type": "string",
2264
+ "maxLength": 300
2265
+ },
2266
+ "maxItems": 232
2267
+ },
2268
+ "output_node_files": {
2269
+ "type": "array",
2270
+ "items": {
2271
+ "type": "object",
2272
+ "required": [
2273
+ "node_id",
2274
+ "file_id",
2275
+ "node_type",
2276
+ "node_subtype"
2277
+ ],
2278
+ "properties": {
2279
+ "node_id": {
2280
+ "type": "string",
2281
+ "maxLength": 64
2282
+ },
2283
+ "file_id": {
2284
+ "type": "string",
2285
+ "maxLength": 300
2286
+ },
2287
+ "node_type": {
2288
+ "type": "string",
2289
+ "maxLength": 20
2290
+ },
2291
+ "node_subtype": {
2292
+ "type": "string",
2293
+ "maxLength": 100
2294
+ }
2295
+ },
2296
+ "additionalProperties": false
2297
+ },
2298
+ "maxItems": 232
2299
+ },
2300
+ "job_type": {
2301
+ "type": "string",
2302
+ "maxLength": 20
2303
+ },
2304
+ "created_by_id": {
2305
+ "type": "string",
2306
+ "maxLength": 200
2307
+ },
2308
+ "reason": {
2309
+ "anyOf": [
2310
+ {
2311
+ "type": "string",
2312
+ "maxLength": 500
2313
+ },
2314
+ {
2315
+ "type": "null"
2316
+ }
2317
+ ]
2318
+ }
2319
+ },
2320
+ "additionalProperties": false
2321
+ },
2322
+ "maxItems": 100
2323
+ },
2324
+ "declaredErrors": [
2325
+ "INTERNAL_ERROR",
2326
+ "RESPONSE_TOO_LARGE",
2327
+ "UNAUTHORIZED",
2328
+ "VALIDATION_ERROR"
2329
+ ],
2330
+ "idempotency": "none",
2331
+ "fidelity": "behavioral"
2332
+ },
2333
+ {
2334
+ "id": "sources.check_connection",
2335
+ "description": "Run a synchronous connection check on a source connector: SUCCESS when its required configuration keys are set, otherwise FAILURE with the missing key.",
2336
+ "inputSchema": {
2337
+ "type": "object",
2338
+ "required": [
2339
+ "source_id"
2340
+ ],
2341
+ "properties": {
2342
+ "source_id": {
2343
+ "type": "string",
2344
+ "minLength": 1,
2345
+ "maxLength": 512
2346
+ }
2347
+ },
2348
+ "additionalProperties": false
2349
+ },
2350
+ "outputSchema": {
2351
+ "type": "object",
2352
+ "required": [
2353
+ "status",
2354
+ "reason",
2355
+ "created_at"
2356
+ ],
2357
+ "properties": {
2358
+ "status": {
2359
+ "type": "string",
2360
+ "maxLength": 20
2361
+ },
2362
+ "reason": {
2363
+ "anyOf": [
2364
+ {
2365
+ "type": "string",
2366
+ "maxLength": 500
2367
+ },
2368
+ {
2369
+ "type": "null"
2370
+ }
2371
+ ]
2372
+ },
2373
+ "created_at": {
2374
+ "type": "string",
2375
+ "maxLength": 40
2376
+ }
2377
+ },
2378
+ "additionalProperties": false
2379
+ },
2380
+ "declaredErrors": [
2381
+ "NOT_FOUND",
2382
+ "UNAUTHORIZED"
2383
+ ],
2384
+ "idempotency": "optional",
2385
+ "fidelity": "behavioral"
2386
+ },
2387
+ {
2388
+ "id": "sources.create",
2389
+ "description": "Create a source connector; the required configuration keys of its type must be present and secrets are masked in responses.",
2390
+ "inputSchema": {
2391
+ "type": "object",
2392
+ "properties": {
2393
+ "name": {},
2394
+ "type": {},
2395
+ "config": {},
2396
+ "key": {},
2397
+ "__request_error": {
2398
+ "type": "string",
2399
+ "maxLength": 300
2400
+ }
2401
+ },
2402
+ "additionalProperties": false
2403
+ },
2404
+ "outputSchema": {
2405
+ "type": "object",
2406
+ "required": [
2407
+ "id",
2408
+ "name",
2409
+ "type",
2410
+ "config",
2411
+ "created_at",
2412
+ "updated_at",
2413
+ "key"
2414
+ ],
2415
+ "properties": {
2416
+ "id": {
2417
+ "type": "string",
2418
+ "minLength": 1,
2419
+ "maxLength": 512
2420
+ },
2421
+ "name": {
2422
+ "type": "string",
2423
+ "maxLength": 200
2424
+ },
2425
+ "type": {
2426
+ "type": "string",
2427
+ "maxLength": 64
2428
+ },
2429
+ "config": {
2430
+ "type": "object",
2431
+ "maxProperties": 40,
2432
+ "additionalProperties": {
2433
+ "anyOf": [
2434
+ {
2435
+ "type": "string",
2436
+ "maxLength": 2000
2437
+ },
2438
+ {
2439
+ "type": "number"
2440
+ },
2441
+ {
2442
+ "type": "boolean"
2443
+ },
2444
+ {
2445
+ "type": "null"
2446
+ }
2447
+ ]
2448
+ }
2449
+ },
2450
+ "created_at": {
2451
+ "type": "string",
2452
+ "maxLength": 40
2453
+ },
2454
+ "updated_at": {
2455
+ "anyOf": [
2456
+ {
2457
+ "type": "string",
2458
+ "maxLength": 40
2459
+ },
2460
+ {
2461
+ "type": "null"
2462
+ }
2463
+ ]
2464
+ },
2465
+ "key": {
2466
+ "anyOf": [
2467
+ {
2468
+ "type": "string",
2469
+ "maxLength": 63
2470
+ },
2471
+ {
2472
+ "type": "null"
2473
+ }
2474
+ ]
2475
+ }
2476
+ },
2477
+ "additionalProperties": false
2478
+ },
2479
+ "declaredErrors": [
2480
+ "INTERNAL_ERROR",
2481
+ "UNAUTHORIZED",
2482
+ "VALIDATION_ERROR"
2483
+ ],
2484
+ "idempotency": "optional",
2485
+ "fidelity": "behavioral"
2486
+ },
2487
+ {
2488
+ "id": "sources.delete",
2489
+ "description": "Delete a source connector that no running job uses.",
2490
+ "inputSchema": {
2491
+ "type": "object",
2492
+ "required": [
2493
+ "source_id"
2494
+ ],
2495
+ "properties": {
2496
+ "source_id": {
2497
+ "type": "string",
2498
+ "minLength": 1,
2499
+ "maxLength": 512
2500
+ }
2501
+ },
2502
+ "additionalProperties": false
2503
+ },
2504
+ "outputSchema": {
2505
+ "type": "object",
2506
+ "additionalProperties": false
2507
+ },
2508
+ "declaredErrors": [
2509
+ "INTERNAL_ERROR",
2510
+ "NOT_FOUND",
2511
+ "UNAUTHORIZED",
2512
+ "VALIDATION_ERROR"
2513
+ ],
2514
+ "idempotency": "optional",
2515
+ "fidelity": "behavioral"
2516
+ },
2517
+ {
2518
+ "id": "sources.get",
2519
+ "description": "Read one source connector by id.",
2520
+ "inputSchema": {
2521
+ "type": "object",
2522
+ "required": [
2523
+ "source_id"
2524
+ ],
2525
+ "properties": {
2526
+ "source_id": {
2527
+ "type": "string",
2528
+ "minLength": 1,
2529
+ "maxLength": 512
2530
+ }
2531
+ },
2532
+ "additionalProperties": false
2533
+ },
2534
+ "outputSchema": {
2535
+ "type": "object",
2536
+ "required": [
2537
+ "id",
2538
+ "name",
2539
+ "type",
2540
+ "config",
2541
+ "created_at",
2542
+ "updated_at",
2543
+ "key"
2544
+ ],
2545
+ "properties": {
2546
+ "id": {
2547
+ "type": "string",
2548
+ "minLength": 1,
2549
+ "maxLength": 512
2550
+ },
2551
+ "name": {
2552
+ "type": "string",
2553
+ "maxLength": 200
2554
+ },
2555
+ "type": {
2556
+ "type": "string",
2557
+ "maxLength": 64
2558
+ },
2559
+ "config": {
2560
+ "type": "object",
2561
+ "maxProperties": 40,
2562
+ "additionalProperties": {
2563
+ "anyOf": [
2564
+ {
2565
+ "type": "string",
2566
+ "maxLength": 2000
2567
+ },
2568
+ {
2569
+ "type": "number"
2570
+ },
2571
+ {
2572
+ "type": "boolean"
2573
+ },
2574
+ {
2575
+ "type": "null"
2576
+ }
2577
+ ]
2578
+ }
2579
+ },
2580
+ "created_at": {
2581
+ "type": "string",
2582
+ "maxLength": 40
2583
+ },
2584
+ "updated_at": {
2585
+ "anyOf": [
2586
+ {
2587
+ "type": "string",
2588
+ "maxLength": 40
2589
+ },
2590
+ {
2591
+ "type": "null"
2592
+ }
2593
+ ]
2594
+ },
2595
+ "key": {
2596
+ "anyOf": [
2597
+ {
2598
+ "type": "string",
2599
+ "maxLength": 63
2600
+ },
2601
+ {
2602
+ "type": "null"
2603
+ }
2604
+ ]
2605
+ }
2606
+ },
2607
+ "additionalProperties": false
2608
+ },
2609
+ "declaredErrors": [
2610
+ "NOT_FOUND",
2611
+ "UNAUTHORIZED"
2612
+ ],
2613
+ "idempotency": "none",
2614
+ "fidelity": "stateful"
2615
+ },
2616
+ {
2617
+ "id": "sources.get_connection_check",
2618
+ "description": "Read the latest connection check of a source connector.",
2619
+ "inputSchema": {
2620
+ "type": "object",
2621
+ "required": [
2622
+ "source_id"
2623
+ ],
2624
+ "properties": {
2625
+ "source_id": {
2626
+ "type": "string",
2627
+ "minLength": 1,
2628
+ "maxLength": 512
2629
+ }
2630
+ },
2631
+ "additionalProperties": false
2632
+ },
2633
+ "outputSchema": {
2634
+ "type": "object",
2635
+ "required": [
2636
+ "status",
2637
+ "reason",
2638
+ "created_at"
2639
+ ],
2640
+ "properties": {
2641
+ "status": {
2642
+ "type": "string",
2643
+ "maxLength": 20
2644
+ },
2645
+ "reason": {
2646
+ "anyOf": [
2647
+ {
2648
+ "type": "string",
2649
+ "maxLength": 500
2650
+ },
2651
+ {
2652
+ "type": "null"
2653
+ }
2654
+ ]
2655
+ },
2656
+ "created_at": {
2657
+ "type": "string",
2658
+ "maxLength": 40
2659
+ }
2660
+ },
2661
+ "additionalProperties": false
2662
+ },
2663
+ "declaredErrors": [
2664
+ "NOT_FOUND",
2665
+ "UNAUTHORIZED"
2666
+ ],
2667
+ "idempotency": "none",
2668
+ "fidelity": "stateful"
2669
+ },
2670
+ {
2671
+ "id": "sources.list",
2672
+ "description": "List every source connector of the workspace, optionally filtered by source_type; fails RESPONSE_TOO_LARGE instead of truncating when the array would pass the response budget.",
2673
+ "inputSchema": {
2674
+ "type": "object",
2675
+ "properties": {
2676
+ "source_type": {},
2677
+ "__request_error": {
2678
+ "type": "string",
2679
+ "maxLength": 300
2680
+ }
2681
+ },
2682
+ "additionalProperties": false
2683
+ },
2684
+ "outputSchema": {
2685
+ "type": "array",
2686
+ "items": {
2687
+ "type": "object",
2688
+ "required": [
2689
+ "id",
2690
+ "name",
2691
+ "type",
2692
+ "config",
2693
+ "created_at",
2694
+ "updated_at",
2695
+ "key"
2696
+ ],
2697
+ "properties": {
2698
+ "id": {
2699
+ "type": "string",
2700
+ "minLength": 1,
2701
+ "maxLength": 512
2702
+ },
2703
+ "name": {
2704
+ "type": "string",
2705
+ "maxLength": 200
2706
+ },
2707
+ "type": {
2708
+ "type": "string",
2709
+ "maxLength": 64
2710
+ },
2711
+ "config": {
2712
+ "type": "object",
2713
+ "maxProperties": 40,
2714
+ "additionalProperties": {
2715
+ "anyOf": [
2716
+ {
2717
+ "type": "string",
2718
+ "maxLength": 2000
2719
+ },
2720
+ {
2721
+ "type": "number"
2722
+ },
2723
+ {
2724
+ "type": "boolean"
2725
+ },
2726
+ {
2727
+ "type": "null"
2728
+ }
2729
+ ]
2730
+ }
2731
+ },
2732
+ "created_at": {
2733
+ "type": "string",
2734
+ "maxLength": 40
2735
+ },
2736
+ "updated_at": {
2737
+ "anyOf": [
2738
+ {
2739
+ "type": "string",
2740
+ "maxLength": 40
2741
+ },
2742
+ {
2743
+ "type": "null"
2744
+ }
2745
+ ]
2746
+ },
2747
+ "key": {
2748
+ "anyOf": [
2749
+ {
2750
+ "type": "string",
2751
+ "maxLength": 63
2752
+ },
2753
+ {
2754
+ "type": "null"
2755
+ }
2756
+ ]
2757
+ }
2758
+ },
2759
+ "additionalProperties": false
2760
+ },
2761
+ "maxItems": 2000
2762
+ },
2763
+ "declaredErrors": [
2764
+ "INTERNAL_ERROR",
2765
+ "RESPONSE_TOO_LARGE",
2766
+ "UNAUTHORIZED",
2767
+ "VALIDATION_ERROR"
2768
+ ],
2769
+ "idempotency": "none",
2770
+ "fidelity": "stateful"
2771
+ },
2772
+ {
2773
+ "id": "sources.update",
2774
+ "description": "Update the name or configuration of a source connector; the type cannot change and a masked secret keeps its stored value.",
2775
+ "inputSchema": {
2776
+ "type": "object",
2777
+ "required": [
2778
+ "source_id"
2779
+ ],
2780
+ "properties": {
2781
+ "source_id": {
2782
+ "type": "string",
2783
+ "minLength": 1,
2784
+ "maxLength": 512
2785
+ },
2786
+ "name": {},
2787
+ "type": {},
2788
+ "config": {},
2789
+ "key": {},
2790
+ "__request_error": {
2791
+ "type": "string",
2792
+ "maxLength": 300
2793
+ }
2794
+ },
2795
+ "additionalProperties": false
2796
+ },
2797
+ "outputSchema": {
2798
+ "type": "object",
2799
+ "required": [
2800
+ "id",
2801
+ "name",
2802
+ "type",
2803
+ "config",
2804
+ "created_at",
2805
+ "updated_at",
2806
+ "key"
2807
+ ],
2808
+ "properties": {
2809
+ "id": {
2810
+ "type": "string",
2811
+ "minLength": 1,
2812
+ "maxLength": 512
2813
+ },
2814
+ "name": {
2815
+ "type": "string",
2816
+ "maxLength": 200
2817
+ },
2818
+ "type": {
2819
+ "type": "string",
2820
+ "maxLength": 64
2821
+ },
2822
+ "config": {
2823
+ "type": "object",
2824
+ "maxProperties": 40,
2825
+ "additionalProperties": {
2826
+ "anyOf": [
2827
+ {
2828
+ "type": "string",
2829
+ "maxLength": 2000
2830
+ },
2831
+ {
2832
+ "type": "number"
2833
+ },
2834
+ {
2835
+ "type": "boolean"
2836
+ },
2837
+ {
2838
+ "type": "null"
2839
+ }
2840
+ ]
2841
+ }
2842
+ },
2843
+ "created_at": {
2844
+ "type": "string",
2845
+ "maxLength": 40
2846
+ },
2847
+ "updated_at": {
2848
+ "anyOf": [
2849
+ {
2850
+ "type": "string",
2851
+ "maxLength": 40
2852
+ },
2853
+ {
2854
+ "type": "null"
2855
+ }
2856
+ ]
2857
+ },
2858
+ "key": {
2859
+ "anyOf": [
2860
+ {
2861
+ "type": "string",
2862
+ "maxLength": 63
2863
+ },
2864
+ {
2865
+ "type": "null"
2866
+ }
2867
+ ]
2868
+ }
2869
+ },
2870
+ "additionalProperties": false
2871
+ },
2872
+ "declaredErrors": [
2873
+ "NOT_FOUND",
2874
+ "UNAUTHORIZED",
2875
+ "VALIDATION_ERROR"
2876
+ ],
2877
+ "idempotency": "optional",
2878
+ "fidelity": "behavioral"
2879
+ },
2880
+ {
2881
+ "id": "workflows.create",
2882
+ "description": "Create an auto workflow (default partition + chunk_by_title nodes) or a custom workflow with validated nodes; connectors must exist in the workspace.",
2883
+ "inputSchema": {
2884
+ "type": "object",
2885
+ "properties": {
2886
+ "name": {},
2887
+ "workflow_type": {},
2888
+ "source_id": {},
2889
+ "destination_id": {},
2890
+ "workflow_nodes": {},
2891
+ "schedule": {},
2892
+ "reprocess_all": {},
2893
+ "template_id": {},
2894
+ "source_ids": {},
2895
+ "destination_ids": {},
2896
+ "skip_preflight": {},
2897
+ "key": {},
2898
+ "__request_error": {
2899
+ "type": "string",
2900
+ "maxLength": 300
2901
+ }
2902
+ },
2903
+ "additionalProperties": false
2904
+ },
2905
+ "outputSchema": {
2906
+ "type": "object",
2907
+ "required": [
2908
+ "id",
2909
+ "name",
2910
+ "workflow_type",
2911
+ "source_id",
2912
+ "destination_id",
2913
+ "status",
2914
+ "schedule",
2915
+ "workflow_nodes",
2916
+ "reprocess_all",
2917
+ "created_at",
2918
+ "updated_at",
2919
+ "sources",
2920
+ "destinations",
2921
+ "key"
2922
+ ],
2923
+ "properties": {
2924
+ "id": {
2925
+ "type": "string",
2926
+ "minLength": 1,
2927
+ "maxLength": 512
2928
+ },
2929
+ "name": {
2930
+ "type": "string",
2931
+ "maxLength": 200
2932
+ },
2933
+ "workflow_type": {
2934
+ "type": "string",
2935
+ "enum": [
2936
+ "auto",
2937
+ "custom"
2938
+ ]
2939
+ },
2940
+ "source_id": {
2941
+ "anyOf": [
2942
+ {
2943
+ "type": "string",
2944
+ "minLength": 1,
2945
+ "maxLength": 512
2946
+ },
2947
+ {
2948
+ "type": "null"
2949
+ }
2950
+ ]
2951
+ },
2952
+ "destination_id": {
2953
+ "anyOf": [
2954
+ {
2955
+ "type": "string",
2956
+ "minLength": 1,
2957
+ "maxLength": 512
2958
+ },
2959
+ {
2960
+ "type": "null"
2961
+ }
2962
+ ]
2963
+ },
2964
+ "status": {
2965
+ "type": "string",
2966
+ "enum": [
2967
+ "active",
2968
+ "inactive",
2969
+ "paused"
2970
+ ]
2971
+ },
2972
+ "schedule": {
2973
+ "anyOf": [
2974
+ {
2975
+ "type": "string",
2976
+ "maxLength": 40
2977
+ },
2978
+ {
2979
+ "type": "null"
2980
+ }
2981
+ ]
2982
+ },
2983
+ "workflow_nodes": {
2984
+ "type": "array",
2985
+ "items": {
2986
+ "type": "object",
2987
+ "required": [
2988
+ "id",
2989
+ "name",
2990
+ "type",
2991
+ "subtype",
2992
+ "settings"
2993
+ ],
2994
+ "properties": {
2995
+ "id": {
2996
+ "type": "string",
2997
+ "maxLength": 64
2998
+ },
2999
+ "name": {
3000
+ "type": "string",
3001
+ "maxLength": 200
3002
+ },
3003
+ "type": {
3004
+ "type": "string",
3005
+ "enum": [
3006
+ "partition",
3007
+ "chunk",
3008
+ "embed",
3009
+ "prompter"
3010
+ ]
3011
+ },
3012
+ "subtype": {
3013
+ "type": "string",
3014
+ "maxLength": 100
3015
+ },
3016
+ "settings": {
3017
+ "type": "object",
3018
+ "maxProperties": 40,
3019
+ "additionalProperties": {
3020
+ "anyOf": [
3021
+ {
3022
+ "type": "string",
3023
+ "maxLength": 2000
3024
+ },
3025
+ {
3026
+ "type": "number"
3027
+ },
3028
+ {
3029
+ "type": "boolean"
3030
+ },
3031
+ {
3032
+ "type": "null"
3033
+ }
3034
+ ]
3035
+ }
3036
+ }
3037
+ },
3038
+ "additionalProperties": false
3039
+ },
3040
+ "maxItems": 16
3041
+ },
3042
+ "reprocess_all": {
3043
+ "type": "boolean"
3044
+ },
3045
+ "created_at": {
3046
+ "type": "string",
3047
+ "maxLength": 40
3048
+ },
3049
+ "updated_at": {
3050
+ "anyOf": [
3051
+ {
3052
+ "type": "string",
3053
+ "maxLength": 40
3054
+ },
3055
+ {
3056
+ "type": "null"
3057
+ }
3058
+ ]
3059
+ },
3060
+ "sources": {
3061
+ "type": "array",
3062
+ "items": {
3063
+ "type": "string",
3064
+ "minLength": 1,
3065
+ "maxLength": 512
3066
+ },
3067
+ "maxItems": 1
3068
+ },
3069
+ "destinations": {
3070
+ "type": "array",
3071
+ "items": {
3072
+ "type": "string",
3073
+ "minLength": 1,
3074
+ "maxLength": 512
3075
+ },
3076
+ "maxItems": 1
3077
+ },
3078
+ "key": {
3079
+ "anyOf": [
3080
+ {
3081
+ "type": "string",
3082
+ "maxLength": 63
3083
+ },
3084
+ {
3085
+ "type": "null"
3086
+ }
3087
+ ]
3088
+ }
3089
+ },
3090
+ "additionalProperties": false
3091
+ },
3092
+ "declaredErrors": [
3093
+ "INTERNAL_ERROR",
3094
+ "UNAUTHORIZED",
3095
+ "VALIDATION_ERROR"
3096
+ ],
3097
+ "idempotency": "optional",
3098
+ "fidelity": "behavioral"
3099
+ },
3100
+ {
3101
+ "id": "workflows.delete",
3102
+ "description": "Delete a workflow that has no running job; its past jobs remain.",
3103
+ "inputSchema": {
3104
+ "type": "object",
3105
+ "required": [
3106
+ "workflow_id"
3107
+ ],
3108
+ "properties": {
3109
+ "workflow_id": {
3110
+ "type": "string",
3111
+ "minLength": 1,
3112
+ "maxLength": 512
3113
+ }
3114
+ },
3115
+ "additionalProperties": false
3116
+ },
3117
+ "outputSchema": {
3118
+ "type": "object",
3119
+ "additionalProperties": false
3120
+ },
3121
+ "declaredErrors": [
3122
+ "INTERNAL_ERROR",
3123
+ "NOT_FOUND",
3124
+ "UNAUTHORIZED",
3125
+ "VALIDATION_ERROR"
3126
+ ],
3127
+ "idempotency": "optional",
3128
+ "fidelity": "behavioral"
3129
+ },
3130
+ {
3131
+ "id": "workflows.get",
3132
+ "description": "Read one workflow by id.",
3133
+ "inputSchema": {
3134
+ "type": "object",
3135
+ "required": [
3136
+ "workflow_id"
3137
+ ],
3138
+ "properties": {
3139
+ "workflow_id": {
3140
+ "type": "string",
3141
+ "minLength": 1,
3142
+ "maxLength": 512
3143
+ }
3144
+ },
3145
+ "additionalProperties": false
3146
+ },
3147
+ "outputSchema": {
3148
+ "type": "object",
3149
+ "required": [
3150
+ "id",
3151
+ "name",
3152
+ "workflow_type",
3153
+ "source_id",
3154
+ "destination_id",
3155
+ "status",
3156
+ "schedule",
3157
+ "workflow_nodes",
3158
+ "reprocess_all",
3159
+ "created_at",
3160
+ "updated_at",
3161
+ "sources",
3162
+ "destinations",
3163
+ "key"
3164
+ ],
3165
+ "properties": {
3166
+ "id": {
3167
+ "type": "string",
3168
+ "minLength": 1,
3169
+ "maxLength": 512
3170
+ },
3171
+ "name": {
3172
+ "type": "string",
3173
+ "maxLength": 200
3174
+ },
3175
+ "workflow_type": {
3176
+ "type": "string",
3177
+ "enum": [
3178
+ "auto",
3179
+ "custom"
3180
+ ]
3181
+ },
3182
+ "source_id": {
3183
+ "anyOf": [
3184
+ {
3185
+ "type": "string",
3186
+ "minLength": 1,
3187
+ "maxLength": 512
3188
+ },
3189
+ {
3190
+ "type": "null"
3191
+ }
3192
+ ]
3193
+ },
3194
+ "destination_id": {
3195
+ "anyOf": [
3196
+ {
3197
+ "type": "string",
3198
+ "minLength": 1,
3199
+ "maxLength": 512
3200
+ },
3201
+ {
3202
+ "type": "null"
3203
+ }
3204
+ ]
3205
+ },
3206
+ "status": {
3207
+ "type": "string",
3208
+ "enum": [
3209
+ "active",
3210
+ "inactive",
3211
+ "paused"
3212
+ ]
3213
+ },
3214
+ "schedule": {
3215
+ "anyOf": [
3216
+ {
3217
+ "type": "string",
3218
+ "maxLength": 40
3219
+ },
3220
+ {
3221
+ "type": "null"
3222
+ }
3223
+ ]
3224
+ },
3225
+ "workflow_nodes": {
3226
+ "type": "array",
3227
+ "items": {
3228
+ "type": "object",
3229
+ "required": [
3230
+ "id",
3231
+ "name",
3232
+ "type",
3233
+ "subtype",
3234
+ "settings"
3235
+ ],
3236
+ "properties": {
3237
+ "id": {
3238
+ "type": "string",
3239
+ "maxLength": 64
3240
+ },
3241
+ "name": {
3242
+ "type": "string",
3243
+ "maxLength": 200
3244
+ },
3245
+ "type": {
3246
+ "type": "string",
3247
+ "enum": [
3248
+ "partition",
3249
+ "chunk",
3250
+ "embed",
3251
+ "prompter"
3252
+ ]
3253
+ },
3254
+ "subtype": {
3255
+ "type": "string",
3256
+ "maxLength": 100
3257
+ },
3258
+ "settings": {
3259
+ "type": "object",
3260
+ "maxProperties": 40,
3261
+ "additionalProperties": {
3262
+ "anyOf": [
3263
+ {
3264
+ "type": "string",
3265
+ "maxLength": 2000
3266
+ },
3267
+ {
3268
+ "type": "number"
3269
+ },
3270
+ {
3271
+ "type": "boolean"
3272
+ },
3273
+ {
3274
+ "type": "null"
3275
+ }
3276
+ ]
3277
+ }
3278
+ }
3279
+ },
3280
+ "additionalProperties": false
3281
+ },
3282
+ "maxItems": 16
3283
+ },
3284
+ "reprocess_all": {
3285
+ "type": "boolean"
3286
+ },
3287
+ "created_at": {
3288
+ "type": "string",
3289
+ "maxLength": 40
3290
+ },
3291
+ "updated_at": {
3292
+ "anyOf": [
3293
+ {
3294
+ "type": "string",
3295
+ "maxLength": 40
3296
+ },
3297
+ {
3298
+ "type": "null"
3299
+ }
3300
+ ]
3301
+ },
3302
+ "sources": {
3303
+ "type": "array",
3304
+ "items": {
3305
+ "type": "string",
3306
+ "minLength": 1,
3307
+ "maxLength": 512
3308
+ },
3309
+ "maxItems": 1
3310
+ },
3311
+ "destinations": {
3312
+ "type": "array",
3313
+ "items": {
3314
+ "type": "string",
3315
+ "minLength": 1,
3316
+ "maxLength": 512
3317
+ },
3318
+ "maxItems": 1
3319
+ },
3320
+ "key": {
3321
+ "anyOf": [
3322
+ {
3323
+ "type": "string",
3324
+ "maxLength": 63
3325
+ },
3326
+ {
3327
+ "type": "null"
3328
+ }
3329
+ ]
3330
+ }
3331
+ },
3332
+ "additionalProperties": false
3333
+ },
3334
+ "declaredErrors": [
3335
+ "NOT_FOUND",
3336
+ "UNAUTHORIZED"
3337
+ ],
3338
+ "idempotency": "none",
3339
+ "fidelity": "stateful"
3340
+ },
3341
+ {
3342
+ "id": "workflows.list",
3343
+ "description": "List workflows of the workspace: filters source_id, destination_id, status and name, page-numbered (page, page_size 1-100) and sorted (sort_by, sort_direction); a page that would pass the response budget fails RESPONSE_TOO_LARGE (lower page_size) instead of being shortened.",
3344
+ "inputSchema": {
3345
+ "type": "object",
3346
+ "properties": {
3347
+ "source_id": {},
3348
+ "destination_id": {},
3349
+ "status": {},
3350
+ "name": {},
3351
+ "page": {},
3352
+ "page_size": {},
3353
+ "sort_by": {},
3354
+ "sort_direction": {},
3355
+ "show_only_soft_deleted": {},
3356
+ "show_recommender_workflows": {},
3357
+ "dag_node_configuration_id": {},
3358
+ "created_since": {},
3359
+ "created_before": {},
3360
+ "__request_error": {
3361
+ "type": "string",
3362
+ "maxLength": 300
3363
+ }
3364
+ },
3365
+ "additionalProperties": false
3366
+ },
3367
+ "outputSchema": {
3368
+ "type": "array",
3369
+ "items": {
3370
+ "type": "object",
3371
+ "required": [
3372
+ "id",
3373
+ "name",
3374
+ "workflow_type",
3375
+ "source_id",
3376
+ "destination_id",
3377
+ "status",
3378
+ "schedule",
3379
+ "workflow_nodes",
3380
+ "reprocess_all",
3381
+ "created_at",
3382
+ "updated_at",
3383
+ "sources",
3384
+ "destinations",
3385
+ "key"
3386
+ ],
3387
+ "properties": {
3388
+ "id": {
3389
+ "type": "string",
3390
+ "minLength": 1,
3391
+ "maxLength": 512
3392
+ },
3393
+ "name": {
3394
+ "type": "string",
3395
+ "maxLength": 200
3396
+ },
3397
+ "workflow_type": {
3398
+ "type": "string",
3399
+ "enum": [
3400
+ "auto",
3401
+ "custom"
3402
+ ]
3403
+ },
3404
+ "source_id": {
3405
+ "anyOf": [
3406
+ {
3407
+ "type": "string",
3408
+ "minLength": 1,
3409
+ "maxLength": 512
3410
+ },
3411
+ {
3412
+ "type": "null"
3413
+ }
3414
+ ]
3415
+ },
3416
+ "destination_id": {
3417
+ "anyOf": [
3418
+ {
3419
+ "type": "string",
3420
+ "minLength": 1,
3421
+ "maxLength": 512
3422
+ },
3423
+ {
3424
+ "type": "null"
3425
+ }
3426
+ ]
3427
+ },
3428
+ "status": {
3429
+ "type": "string",
3430
+ "enum": [
3431
+ "active",
3432
+ "inactive",
3433
+ "paused"
3434
+ ]
3435
+ },
3436
+ "schedule": {
3437
+ "anyOf": [
3438
+ {
3439
+ "type": "string",
3440
+ "maxLength": 40
3441
+ },
3442
+ {
3443
+ "type": "null"
3444
+ }
3445
+ ]
3446
+ },
3447
+ "workflow_nodes": {
3448
+ "type": "array",
3449
+ "items": {
3450
+ "type": "object",
3451
+ "required": [
3452
+ "id",
3453
+ "name",
3454
+ "type",
3455
+ "subtype",
3456
+ "settings"
3457
+ ],
3458
+ "properties": {
3459
+ "id": {
3460
+ "type": "string",
3461
+ "maxLength": 64
3462
+ },
3463
+ "name": {
3464
+ "type": "string",
3465
+ "maxLength": 200
3466
+ },
3467
+ "type": {
3468
+ "type": "string",
3469
+ "enum": [
3470
+ "partition",
3471
+ "chunk",
3472
+ "embed",
3473
+ "prompter"
3474
+ ]
3475
+ },
3476
+ "subtype": {
3477
+ "type": "string",
3478
+ "maxLength": 100
3479
+ },
3480
+ "settings": {
3481
+ "type": "object",
3482
+ "maxProperties": 40,
3483
+ "additionalProperties": {
3484
+ "anyOf": [
3485
+ {
3486
+ "type": "string",
3487
+ "maxLength": 2000
3488
+ },
3489
+ {
3490
+ "type": "number"
3491
+ },
3492
+ {
3493
+ "type": "boolean"
3494
+ },
3495
+ {
3496
+ "type": "null"
3497
+ }
3498
+ ]
3499
+ }
3500
+ }
3501
+ },
3502
+ "additionalProperties": false
3503
+ },
3504
+ "maxItems": 16
3505
+ },
3506
+ "reprocess_all": {
3507
+ "type": "boolean"
3508
+ },
3509
+ "created_at": {
3510
+ "type": "string",
3511
+ "maxLength": 40
3512
+ },
3513
+ "updated_at": {
3514
+ "anyOf": [
3515
+ {
3516
+ "type": "string",
3517
+ "maxLength": 40
3518
+ },
3519
+ {
3520
+ "type": "null"
3521
+ }
3522
+ ]
3523
+ },
3524
+ "sources": {
3525
+ "type": "array",
3526
+ "items": {
3527
+ "type": "string",
3528
+ "minLength": 1,
3529
+ "maxLength": 512
3530
+ },
3531
+ "maxItems": 1
3532
+ },
3533
+ "destinations": {
3534
+ "type": "array",
3535
+ "items": {
3536
+ "type": "string",
3537
+ "minLength": 1,
3538
+ "maxLength": 512
3539
+ },
3540
+ "maxItems": 1
3541
+ },
3542
+ "key": {
3543
+ "anyOf": [
3544
+ {
3545
+ "type": "string",
3546
+ "maxLength": 63
3547
+ },
3548
+ {
3549
+ "type": "null"
3550
+ }
3551
+ ]
3552
+ }
3553
+ },
3554
+ "additionalProperties": false
3555
+ },
3556
+ "maxItems": 100
3557
+ },
3558
+ "declaredErrors": [
3559
+ "INTERNAL_ERROR",
3560
+ "RESPONSE_TOO_LARGE",
3561
+ "UNAUTHORIZED",
3562
+ "VALIDATION_ERROR"
3563
+ ],
3564
+ "idempotency": "none",
3565
+ "fidelity": "stateful"
3566
+ },
3567
+ {
3568
+ "id": "workflows.run",
3569
+ "description": "Run an active workflow over the files its source connector holds plus optional runtime input_files; creates a SCHEDULED job whose progress is derived from virtual time.",
3570
+ "inputSchema": {
3571
+ "type": "object",
3572
+ "required": [
3573
+ "workflow_id"
3574
+ ],
3575
+ "properties": {
3576
+ "workflow_id": {
3577
+ "type": "string",
3578
+ "minLength": 1,
3579
+ "maxLength": 512
3580
+ },
3581
+ "input_files": {
3582
+ "type": "array",
3583
+ "items": {
3584
+ "type": "object",
3585
+ "required": [
3586
+ "filename",
3587
+ "content"
3588
+ ],
3589
+ "properties": {
3590
+ "filename": {
3591
+ "type": "string",
3592
+ "maxLength": 500
3593
+ },
3594
+ "content_type": {
3595
+ "anyOf": [
3596
+ {
3597
+ "type": "string",
3598
+ "maxLength": 200
3599
+ },
3600
+ {
3601
+ "type": "null"
3602
+ }
3603
+ ]
3604
+ },
3605
+ "content": {
3606
+ "type": "string",
3607
+ "maxLength": 1100000
3608
+ },
3609
+ "last_modified": {
3610
+ "type": "string",
3611
+ "maxLength": 100
3612
+ },
3613
+ "bad_transfer": {
3614
+ "type": "boolean"
3615
+ }
3616
+ },
3617
+ "additionalProperties": false
3618
+ },
3619
+ "maxItems": 32
3620
+ },
3621
+ "__request_error": {
3622
+ "type": "string",
3623
+ "maxLength": 300
3624
+ }
3625
+ },
3626
+ "additionalProperties": false
3627
+ },
3628
+ "outputSchema": {
3629
+ "type": "object",
3630
+ "required": [
3631
+ "id",
3632
+ "workflow_id",
3633
+ "workflow_name",
3634
+ "status",
3635
+ "stop_requested",
3636
+ "created_at",
3637
+ "runtime",
3638
+ "input_file_ids",
3639
+ "output_node_files",
3640
+ "job_type",
3641
+ "created_by_id",
3642
+ "reason"
3643
+ ],
3644
+ "properties": {
3645
+ "id": {
3646
+ "type": "string",
3647
+ "minLength": 1,
3648
+ "maxLength": 512
3649
+ },
3650
+ "workflow_id": {
3651
+ "type": "string",
3652
+ "minLength": 1,
3653
+ "maxLength": 512
3654
+ },
3655
+ "workflow_name": {
3656
+ "type": "string",
3657
+ "maxLength": 200
3658
+ },
3659
+ "status": {
3660
+ "type": "string",
3661
+ "enum": [
3662
+ "SCHEDULED",
3663
+ "IN_PROGRESS",
3664
+ "COMPLETED",
3665
+ "STOPPED",
3666
+ "FAILED"
3667
+ ]
3668
+ },
3669
+ "stop_requested": {
3670
+ "type": "boolean"
3671
+ },
3672
+ "created_at": {
3673
+ "type": "string",
3674
+ "maxLength": 40
3675
+ },
3676
+ "runtime": {
3677
+ "anyOf": [
3678
+ {
3679
+ "type": "string",
3680
+ "maxLength": 40
3681
+ },
3682
+ {
3683
+ "type": "null"
3684
+ }
3685
+ ]
3686
+ },
3687
+ "input_file_ids": {
3688
+ "type": "array",
3689
+ "items": {
3690
+ "type": "string",
3691
+ "maxLength": 300
3692
+ },
3693
+ "maxItems": 232
3694
+ },
3695
+ "output_node_files": {
3696
+ "type": "array",
3697
+ "items": {
3698
+ "type": "object",
3699
+ "required": [
3700
+ "node_id",
3701
+ "file_id",
3702
+ "node_type",
3703
+ "node_subtype"
3704
+ ],
3705
+ "properties": {
3706
+ "node_id": {
3707
+ "type": "string",
3708
+ "maxLength": 64
3709
+ },
3710
+ "file_id": {
3711
+ "type": "string",
3712
+ "maxLength": 300
3713
+ },
3714
+ "node_type": {
3715
+ "type": "string",
3716
+ "maxLength": 20
3717
+ },
3718
+ "node_subtype": {
3719
+ "type": "string",
3720
+ "maxLength": 100
3721
+ }
3722
+ },
3723
+ "additionalProperties": false
3724
+ },
3725
+ "maxItems": 232
3726
+ },
3727
+ "job_type": {
3728
+ "type": "string",
3729
+ "maxLength": 20
3730
+ },
3731
+ "created_by_id": {
3732
+ "type": "string",
3733
+ "maxLength": 200
3734
+ },
3735
+ "reason": {
3736
+ "anyOf": [
3737
+ {
3738
+ "type": "string",
3739
+ "maxLength": 500
3740
+ },
3741
+ {
3742
+ "type": "null"
3743
+ }
3744
+ ]
3745
+ }
3746
+ },
3747
+ "additionalProperties": false
3748
+ },
3749
+ "declaredErrors": [
3750
+ "INTERNAL_ERROR",
3751
+ "NOT_FOUND",
3752
+ "UNAUTHORIZED",
3753
+ "VALIDATION_ERROR"
3754
+ ],
3755
+ "idempotency": "optional",
3756
+ "fidelity": "behavioral"
3757
+ },
3758
+ {
3759
+ "id": "workflows.update",
3760
+ "description": "Update a workflow's fields, nodes or status (active, inactive, paused).",
3761
+ "inputSchema": {
3762
+ "type": "object",
3763
+ "required": [
3764
+ "workflow_id"
3765
+ ],
3766
+ "properties": {
3767
+ "workflow_id": {
3768
+ "type": "string",
3769
+ "minLength": 1,
3770
+ "maxLength": 512
3771
+ },
3772
+ "name": {},
3773
+ "workflow_type": {},
3774
+ "source_id": {},
3775
+ "destination_id": {},
3776
+ "workflow_nodes": {},
3777
+ "schedule": {},
3778
+ "reprocess_all": {},
3779
+ "template_id": {},
3780
+ "source_ids": {},
3781
+ "destination_ids": {},
3782
+ "skip_preflight": {},
3783
+ "status": {},
3784
+ "__request_error": {
3785
+ "type": "string",
3786
+ "maxLength": 300
3787
+ }
3788
+ },
3789
+ "additionalProperties": false
3790
+ },
3791
+ "outputSchema": {
3792
+ "type": "object",
3793
+ "required": [
3794
+ "id",
3795
+ "name",
3796
+ "workflow_type",
3797
+ "source_id",
3798
+ "destination_id",
3799
+ "status",
3800
+ "schedule",
3801
+ "workflow_nodes",
3802
+ "reprocess_all",
3803
+ "created_at",
3804
+ "updated_at",
3805
+ "sources",
3806
+ "destinations",
3807
+ "key"
3808
+ ],
3809
+ "properties": {
3810
+ "id": {
3811
+ "type": "string",
3812
+ "minLength": 1,
3813
+ "maxLength": 512
3814
+ },
3815
+ "name": {
3816
+ "type": "string",
3817
+ "maxLength": 200
3818
+ },
3819
+ "workflow_type": {
3820
+ "type": "string",
3821
+ "enum": [
3822
+ "auto",
3823
+ "custom"
3824
+ ]
3825
+ },
3826
+ "source_id": {
3827
+ "anyOf": [
3828
+ {
3829
+ "type": "string",
3830
+ "minLength": 1,
3831
+ "maxLength": 512
3832
+ },
3833
+ {
3834
+ "type": "null"
3835
+ }
3836
+ ]
3837
+ },
3838
+ "destination_id": {
3839
+ "anyOf": [
3840
+ {
3841
+ "type": "string",
3842
+ "minLength": 1,
3843
+ "maxLength": 512
3844
+ },
3845
+ {
3846
+ "type": "null"
3847
+ }
3848
+ ]
3849
+ },
3850
+ "status": {
3851
+ "type": "string",
3852
+ "enum": [
3853
+ "active",
3854
+ "inactive",
3855
+ "paused"
3856
+ ]
3857
+ },
3858
+ "schedule": {
3859
+ "anyOf": [
3860
+ {
3861
+ "type": "string",
3862
+ "maxLength": 40
3863
+ },
3864
+ {
3865
+ "type": "null"
3866
+ }
3867
+ ]
3868
+ },
3869
+ "workflow_nodes": {
3870
+ "type": "array",
3871
+ "items": {
3872
+ "type": "object",
3873
+ "required": [
3874
+ "id",
3875
+ "name",
3876
+ "type",
3877
+ "subtype",
3878
+ "settings"
3879
+ ],
3880
+ "properties": {
3881
+ "id": {
3882
+ "type": "string",
3883
+ "maxLength": 64
3884
+ },
3885
+ "name": {
3886
+ "type": "string",
3887
+ "maxLength": 200
3888
+ },
3889
+ "type": {
3890
+ "type": "string",
3891
+ "enum": [
3892
+ "partition",
3893
+ "chunk",
3894
+ "embed",
3895
+ "prompter"
3896
+ ]
3897
+ },
3898
+ "subtype": {
3899
+ "type": "string",
3900
+ "maxLength": 100
3901
+ },
3902
+ "settings": {
3903
+ "type": "object",
3904
+ "maxProperties": 40,
3905
+ "additionalProperties": {
3906
+ "anyOf": [
3907
+ {
3908
+ "type": "string",
3909
+ "maxLength": 2000
3910
+ },
3911
+ {
3912
+ "type": "number"
3913
+ },
3914
+ {
3915
+ "type": "boolean"
3916
+ },
3917
+ {
3918
+ "type": "null"
3919
+ }
3920
+ ]
3921
+ }
3922
+ }
3923
+ },
3924
+ "additionalProperties": false
3925
+ },
3926
+ "maxItems": 16
3927
+ },
3928
+ "reprocess_all": {
3929
+ "type": "boolean"
3930
+ },
3931
+ "created_at": {
3932
+ "type": "string",
3933
+ "maxLength": 40
3934
+ },
3935
+ "updated_at": {
3936
+ "anyOf": [
3937
+ {
3938
+ "type": "string",
3939
+ "maxLength": 40
3940
+ },
3941
+ {
3942
+ "type": "null"
3943
+ }
3944
+ ]
3945
+ },
3946
+ "sources": {
3947
+ "type": "array",
3948
+ "items": {
3949
+ "type": "string",
3950
+ "minLength": 1,
3951
+ "maxLength": 512
3952
+ },
3953
+ "maxItems": 1
3954
+ },
3955
+ "destinations": {
3956
+ "type": "array",
3957
+ "items": {
3958
+ "type": "string",
3959
+ "minLength": 1,
3960
+ "maxLength": 512
3961
+ },
3962
+ "maxItems": 1
3963
+ },
3964
+ "key": {
3965
+ "anyOf": [
3966
+ {
3967
+ "type": "string",
3968
+ "maxLength": 63
3969
+ },
3970
+ {
3971
+ "type": "null"
3972
+ }
3973
+ ]
3974
+ }
3975
+ },
3976
+ "additionalProperties": false
3977
+ },
3978
+ "declaredErrors": [
3979
+ "NOT_FOUND",
3980
+ "UNAUTHORIZED",
3981
+ "VALIDATION_ERROR"
3982
+ ],
3983
+ "idempotency": "optional",
3984
+ "fidelity": "behavioral"
3985
+ }
3986
+ ],
3987
+ "events": [
3988
+ {
3989
+ "id": "job.cancelled",
3990
+ "payloadSchema": {
3991
+ "type": "object",
3992
+ "required": [
3993
+ "job_id",
3994
+ "workflow_id"
3995
+ ],
3996
+ "properties": {
3997
+ "job_id": {
3998
+ "type": "string",
3999
+ "maxLength": 512
4000
+ },
4001
+ "workflow_id": {
4002
+ "type": "string",
4003
+ "maxLength": 512
4004
+ }
4005
+ },
4006
+ "additionalProperties": false
4007
+ }
4008
+ },
4009
+ {
4010
+ "id": "job.created",
4011
+ "payloadSchema": {
4012
+ "type": "object",
4013
+ "required": [
4014
+ "job_id",
4015
+ "workflow_id",
4016
+ "workflow_name",
4017
+ "input_file_count",
4018
+ "runtime_file_count"
4019
+ ],
4020
+ "properties": {
4021
+ "job_id": {
4022
+ "type": "string",
4023
+ "maxLength": 512
4024
+ },
4025
+ "workflow_id": {
4026
+ "type": "string",
4027
+ "maxLength": 512
4028
+ },
4029
+ "workflow_name": {
4030
+ "type": "string",
4031
+ "maxLength": 200
4032
+ },
4033
+ "input_file_count": {
4034
+ "type": "integer",
4035
+ "minimum": 0
4036
+ },
4037
+ "runtime_file_count": {
4038
+ "type": "integer",
4039
+ "minimum": 0
4040
+ }
4041
+ },
4042
+ "additionalProperties": false
4043
+ }
4044
+ },
4045
+ {
4046
+ "id": "partition.completed",
4047
+ "payloadSchema": {
4048
+ "type": "object",
4049
+ "required": [
4050
+ "log_id",
4051
+ "filenames",
4052
+ "filetypes",
4053
+ "strategy",
4054
+ "chunking_strategy",
4055
+ "element_count",
4056
+ "page_count",
4057
+ "input_bytes"
4058
+ ],
4059
+ "properties": {
4060
+ "log_id": {
4061
+ "type": "string",
4062
+ "maxLength": 20
4063
+ },
4064
+ "filenames": {
4065
+ "type": "array",
4066
+ "items": {
4067
+ "type": "string",
4068
+ "maxLength": 200
4069
+ },
4070
+ "maxItems": 32
4071
+ },
4072
+ "filetypes": {
4073
+ "type": "array",
4074
+ "items": {
4075
+ "type": "string",
4076
+ "maxLength": 100
4077
+ },
4078
+ "maxItems": 32
4079
+ },
4080
+ "strategy": {
4081
+ "type": "string",
4082
+ "maxLength": 20
4083
+ },
4084
+ "chunking_strategy": {
4085
+ "anyOf": [
4086
+ {
4087
+ "type": "string",
4088
+ "maxLength": 20
4089
+ },
4090
+ {
4091
+ "type": "null"
4092
+ }
4093
+ ]
4094
+ },
4095
+ "element_count": {
4096
+ "type": "integer",
4097
+ "minimum": 0
4098
+ },
4099
+ "page_count": {
4100
+ "type": "integer",
4101
+ "minimum": 0
4102
+ },
4103
+ "input_bytes": {
4104
+ "type": "integer",
4105
+ "minimum": 0
4106
+ }
4107
+ },
4108
+ "additionalProperties": false
4109
+ }
4110
+ }
4111
+ ],
4112
+ "faults": [
4113
+ {
4114
+ "id": "partition-overloaded",
4115
+ "appliesTo": [
4116
+ "general.partition"
4117
+ ],
4118
+ "timing": "before",
4119
+ "error": {
4120
+ "code": "SERVICE_OVERLOADED",
4121
+ "message": "Server is under heavy load. Please try again later.",
4122
+ "retryable": true
4123
+ }
4124
+ },
4125
+ {
4126
+ "id": "partition-rate-limited",
4127
+ "appliesTo": [
4128
+ "general.partition"
4129
+ ],
4130
+ "timing": "before",
4131
+ "error": {
4132
+ "code": "RATE_LIMITED",
4133
+ "message": "Rate limit exceeded. Please retry after a short delay.",
4134
+ "retryable": true
4135
+ }
4136
+ },
4137
+ {
4138
+ "id": "run-response-lost",
4139
+ "appliesTo": [
4140
+ "workflows.run"
4141
+ ],
4142
+ "timing": "after_commit",
4143
+ "error": {
4144
+ "code": "INTERNAL_ERROR",
4145
+ "message": "Internal Server Error",
4146
+ "retryable": true
4147
+ }
4148
+ }
4149
+ ],
4150
+ "subscriptions": [],
4151
+ "http": [
4152
+ {
4153
+ "id": "cancel-job",
4154
+ "operationId": "jobs.cancel",
4155
+ "method": "POST",
4156
+ "path": "/api/v1/jobs/{job_id}/cancel",
4157
+ "auth": {
4158
+ "kind": "header",
4159
+ "name": "unstructured-api-key"
4160
+ },
4161
+ "requestBody": "none",
4162
+ "response": {
4163
+ "successStatus": 200,
4164
+ "errors": [
4165
+ {
4166
+ "code": "NOT_FOUND",
4167
+ "status": 404
4168
+ },
4169
+ {
4170
+ "code": "UNAUTHORIZED",
4171
+ "status": 401
4172
+ },
4173
+ {
4174
+ "code": "VALIDATION_ERROR",
4175
+ "status": 422
4176
+ }
4177
+ ]
4178
+ }
4179
+ },
4180
+ {
4181
+ "id": "create-destination",
4182
+ "operationId": "destinations.create",
4183
+ "method": "POST",
4184
+ "path": "/api/v1/destinations",
4185
+ "auth": {
4186
+ "kind": "header",
4187
+ "name": "unstructured-api-key"
4188
+ },
4189
+ "requestBody": "json",
4190
+ "response": {
4191
+ "successStatus": 200,
4192
+ "errors": [
4193
+ {
4194
+ "code": "INTERNAL_ERROR",
4195
+ "status": 500
4196
+ },
4197
+ {
4198
+ "code": "UNAUTHORIZED",
4199
+ "status": 401
4200
+ },
4201
+ {
4202
+ "code": "VALIDATION_ERROR",
4203
+ "status": 422
4204
+ }
4205
+ ]
4206
+ }
4207
+ },
4208
+ {
4209
+ "id": "create-source",
4210
+ "operationId": "sources.create",
4211
+ "method": "POST",
4212
+ "path": "/api/v1/sources",
4213
+ "auth": {
4214
+ "kind": "header",
4215
+ "name": "unstructured-api-key"
4216
+ },
4217
+ "requestBody": "json",
4218
+ "response": {
4219
+ "successStatus": 200,
4220
+ "errors": [
4221
+ {
4222
+ "code": "INTERNAL_ERROR",
4223
+ "status": 500
4224
+ },
4225
+ {
4226
+ "code": "UNAUTHORIZED",
4227
+ "status": 401
4228
+ },
4229
+ {
4230
+ "code": "VALIDATION_ERROR",
4231
+ "status": 422
4232
+ }
4233
+ ]
4234
+ }
4235
+ },
4236
+ {
4237
+ "id": "create-source-connection-check",
4238
+ "operationId": "sources.check_connection",
4239
+ "method": "POST",
4240
+ "path": "/api/v1/sources/{source_id}/connection-check",
4241
+ "auth": {
4242
+ "kind": "header",
4243
+ "name": "unstructured-api-key"
4244
+ },
4245
+ "requestBody": "none",
4246
+ "response": {
4247
+ "successStatus": 200,
4248
+ "errors": [
4249
+ {
4250
+ "code": "NOT_FOUND",
4251
+ "status": 404
4252
+ },
4253
+ {
4254
+ "code": "UNAUTHORIZED",
4255
+ "status": 401
4256
+ }
4257
+ ]
4258
+ }
4259
+ },
4260
+ {
4261
+ "id": "create-workflow",
4262
+ "operationId": "workflows.create",
4263
+ "method": "POST",
4264
+ "path": "/api/v1/workflows",
4265
+ "auth": {
4266
+ "kind": "header",
4267
+ "name": "unstructured-api-key"
4268
+ },
4269
+ "requestBody": "json",
4270
+ "response": {
4271
+ "successStatus": 200,
4272
+ "errors": [
4273
+ {
4274
+ "code": "INTERNAL_ERROR",
4275
+ "status": 500
4276
+ },
4277
+ {
4278
+ "code": "UNAUTHORIZED",
4279
+ "status": 401
4280
+ },
4281
+ {
4282
+ "code": "VALIDATION_ERROR",
4283
+ "status": 422
4284
+ }
4285
+ ]
4286
+ }
4287
+ },
4288
+ {
4289
+ "id": "delete-destination",
4290
+ "operationId": "destinations.delete",
4291
+ "method": "DELETE",
4292
+ "path": "/api/v1/destinations/{destination_id}",
4293
+ "auth": {
4294
+ "kind": "header",
4295
+ "name": "unstructured-api-key"
4296
+ },
4297
+ "requestBody": "none",
4298
+ "response": {
4299
+ "successStatus": 200,
4300
+ "errors": [
4301
+ {
4302
+ "code": "INTERNAL_ERROR",
4303
+ "status": 500
4304
+ },
4305
+ {
4306
+ "code": "NOT_FOUND",
4307
+ "status": 404
4308
+ },
4309
+ {
4310
+ "code": "UNAUTHORIZED",
4311
+ "status": 401
4312
+ },
4313
+ {
4314
+ "code": "VALIDATION_ERROR",
4315
+ "status": 422
4316
+ }
4317
+ ]
4318
+ }
4319
+ },
4320
+ {
4321
+ "id": "delete-source",
4322
+ "operationId": "sources.delete",
4323
+ "method": "DELETE",
4324
+ "path": "/api/v1/sources/{source_id}",
4325
+ "auth": {
4326
+ "kind": "header",
4327
+ "name": "unstructured-api-key"
4328
+ },
4329
+ "requestBody": "none",
4330
+ "response": {
4331
+ "successStatus": 200,
4332
+ "errors": [
4333
+ {
4334
+ "code": "INTERNAL_ERROR",
4335
+ "status": 500
4336
+ },
4337
+ {
4338
+ "code": "NOT_FOUND",
4339
+ "status": 404
4340
+ },
4341
+ {
4342
+ "code": "UNAUTHORIZED",
4343
+ "status": 401
4344
+ },
4345
+ {
4346
+ "code": "VALIDATION_ERROR",
4347
+ "status": 422
4348
+ }
4349
+ ]
4350
+ }
4351
+ },
4352
+ {
4353
+ "id": "delete-workflow",
4354
+ "operationId": "workflows.delete",
4355
+ "method": "DELETE",
4356
+ "path": "/api/v1/workflows/{workflow_id}",
4357
+ "auth": {
4358
+ "kind": "header",
4359
+ "name": "unstructured-api-key"
4360
+ },
4361
+ "requestBody": "none",
4362
+ "response": {
4363
+ "successStatus": 200,
4364
+ "errors": [
4365
+ {
4366
+ "code": "INTERNAL_ERROR",
4367
+ "status": 500
4368
+ },
4369
+ {
4370
+ "code": "NOT_FOUND",
4371
+ "status": 404
4372
+ },
4373
+ {
4374
+ "code": "UNAUTHORIZED",
4375
+ "status": 401
4376
+ },
4377
+ {
4378
+ "code": "VALIDATION_ERROR",
4379
+ "status": 422
4380
+ }
4381
+ ]
4382
+ }
4383
+ },
4384
+ {
4385
+ "id": "download-job-output",
4386
+ "operationId": "jobs.download_output",
4387
+ "method": "GET",
4388
+ "path": "/api/v1/jobs/{job_id}/download",
4389
+ "auth": {
4390
+ "kind": "header",
4391
+ "name": "unstructured-api-key"
4392
+ },
4393
+ "requestBody": "none",
4394
+ "response": {
4395
+ "successStatus": 200,
4396
+ "errors": [
4397
+ {
4398
+ "code": "NOT_FOUND",
4399
+ "status": 404
4400
+ },
4401
+ {
4402
+ "code": "RESPONSE_TOO_LARGE",
4403
+ "status": 413
4404
+ },
4405
+ {
4406
+ "code": "UNAUTHORIZED",
4407
+ "status": 401
4408
+ },
4409
+ {
4410
+ "code": "VALIDATION_ERROR",
4411
+ "status": 422
4412
+ }
4413
+ ]
4414
+ }
4415
+ },
4416
+ {
4417
+ "id": "get-destination",
4418
+ "operationId": "destinations.get",
4419
+ "method": "GET",
4420
+ "path": "/api/v1/destinations/{destination_id}",
4421
+ "auth": {
4422
+ "kind": "header",
4423
+ "name": "unstructured-api-key"
4424
+ },
4425
+ "requestBody": "none",
4426
+ "response": {
4427
+ "successStatus": 200,
4428
+ "errors": [
4429
+ {
4430
+ "code": "NOT_FOUND",
4431
+ "status": 404
4432
+ },
4433
+ {
4434
+ "code": "UNAUTHORIZED",
4435
+ "status": 401
4436
+ }
4437
+ ]
4438
+ }
4439
+ },
4440
+ {
4441
+ "id": "get-job",
4442
+ "operationId": "jobs.get",
4443
+ "method": "GET",
4444
+ "path": "/api/v1/jobs/{job_id}",
4445
+ "auth": {
4446
+ "kind": "header",
4447
+ "name": "unstructured-api-key"
4448
+ },
4449
+ "requestBody": "none",
4450
+ "response": {
4451
+ "successStatus": 200,
4452
+ "errors": [
4453
+ {
4454
+ "code": "NOT_FOUND",
4455
+ "status": 404
4456
+ },
4457
+ {
4458
+ "code": "UNAUTHORIZED",
4459
+ "status": 401
4460
+ }
4461
+ ]
4462
+ }
4463
+ },
4464
+ {
4465
+ "id": "get-job-details",
4466
+ "operationId": "jobs.get_details",
4467
+ "method": "GET",
4468
+ "path": "/api/v1/jobs/{job_id}/details",
4469
+ "auth": {
4470
+ "kind": "header",
4471
+ "name": "unstructured-api-key"
4472
+ },
4473
+ "requestBody": "none",
4474
+ "response": {
4475
+ "successStatus": 200,
4476
+ "errors": [
4477
+ {
4478
+ "code": "NOT_FOUND",
4479
+ "status": 404
4480
+ },
4481
+ {
4482
+ "code": "UNAUTHORIZED",
4483
+ "status": 401
4484
+ }
4485
+ ]
4486
+ }
4487
+ },
4488
+ {
4489
+ "id": "get-job-failed-files",
4490
+ "operationId": "jobs.get_failed_files",
4491
+ "method": "GET",
4492
+ "path": "/api/v1/jobs/{job_id}/failed-files",
4493
+ "auth": {
4494
+ "kind": "header",
4495
+ "name": "unstructured-api-key"
4496
+ },
4497
+ "requestBody": "none",
4498
+ "response": {
4499
+ "successStatus": 200,
4500
+ "errors": [
4501
+ {
4502
+ "code": "NOT_FOUND",
4503
+ "status": 404
4504
+ },
4505
+ {
4506
+ "code": "UNAUTHORIZED",
4507
+ "status": 401
4508
+ }
4509
+ ]
4510
+ }
4511
+ },
4512
+ {
4513
+ "id": "get-source",
4514
+ "operationId": "sources.get",
4515
+ "method": "GET",
4516
+ "path": "/api/v1/sources/{source_id}",
4517
+ "auth": {
4518
+ "kind": "header",
4519
+ "name": "unstructured-api-key"
4520
+ },
4521
+ "requestBody": "none",
4522
+ "response": {
4523
+ "successStatus": 200,
4524
+ "errors": [
4525
+ {
4526
+ "code": "NOT_FOUND",
4527
+ "status": 404
4528
+ },
4529
+ {
4530
+ "code": "UNAUTHORIZED",
4531
+ "status": 401
4532
+ }
4533
+ ]
4534
+ }
4535
+ },
4536
+ {
4537
+ "id": "get-source-connection-check",
4538
+ "operationId": "sources.get_connection_check",
4539
+ "method": "GET",
4540
+ "path": "/api/v1/sources/{source_id}/connection-check",
4541
+ "auth": {
4542
+ "kind": "header",
4543
+ "name": "unstructured-api-key"
4544
+ },
4545
+ "requestBody": "none",
4546
+ "response": {
4547
+ "successStatus": 200,
4548
+ "errors": [
4549
+ {
4550
+ "code": "NOT_FOUND",
4551
+ "status": 404
4552
+ },
4553
+ {
4554
+ "code": "UNAUTHORIZED",
4555
+ "status": 401
4556
+ }
4557
+ ]
4558
+ }
4559
+ },
4560
+ {
4561
+ "id": "get-workflow",
4562
+ "operationId": "workflows.get",
4563
+ "method": "GET",
4564
+ "path": "/api/v1/workflows/{workflow_id}",
4565
+ "auth": {
4566
+ "kind": "header",
4567
+ "name": "unstructured-api-key"
4568
+ },
4569
+ "requestBody": "none",
4570
+ "response": {
4571
+ "successStatus": 200,
4572
+ "errors": [
4573
+ {
4574
+ "code": "NOT_FOUND",
4575
+ "status": 404
4576
+ },
4577
+ {
4578
+ "code": "UNAUTHORIZED",
4579
+ "status": 401
4580
+ }
4581
+ ]
4582
+ }
4583
+ },
4584
+ {
4585
+ "id": "list-destinations",
4586
+ "operationId": "destinations.list",
4587
+ "method": "GET",
4588
+ "path": "/api/v1/destinations",
4589
+ "auth": {
4590
+ "kind": "header",
4591
+ "name": "unstructured-api-key"
4592
+ },
4593
+ "requestBody": "none",
4594
+ "response": {
4595
+ "successStatus": 200,
4596
+ "errors": [
4597
+ {
4598
+ "code": "INTERNAL_ERROR",
4599
+ "status": 500
4600
+ },
4601
+ {
4602
+ "code": "RESPONSE_TOO_LARGE",
4603
+ "status": 413
4604
+ },
4605
+ {
4606
+ "code": "UNAUTHORIZED",
4607
+ "status": 401
4608
+ },
4609
+ {
4610
+ "code": "VALIDATION_ERROR",
4611
+ "status": 422
4612
+ }
4613
+ ]
4614
+ }
4615
+ },
4616
+ {
4617
+ "id": "list-jobs",
4618
+ "operationId": "jobs.list",
4619
+ "method": "GET",
4620
+ "path": "/api/v1/jobs",
4621
+ "auth": {
4622
+ "kind": "header",
4623
+ "name": "unstructured-api-key"
4624
+ },
4625
+ "requestBody": "none",
4626
+ "response": {
4627
+ "successStatus": 200,
4628
+ "errors": [
4629
+ {
4630
+ "code": "INTERNAL_ERROR",
4631
+ "status": 500
4632
+ },
4633
+ {
4634
+ "code": "RESPONSE_TOO_LARGE",
4635
+ "status": 413
4636
+ },
4637
+ {
4638
+ "code": "UNAUTHORIZED",
4639
+ "status": 401
4640
+ },
4641
+ {
4642
+ "code": "VALIDATION_ERROR",
4643
+ "status": 422
4644
+ }
4645
+ ]
4646
+ }
4647
+ },
4648
+ {
4649
+ "id": "list-sources",
4650
+ "operationId": "sources.list",
4651
+ "method": "GET",
4652
+ "path": "/api/v1/sources",
4653
+ "auth": {
4654
+ "kind": "header",
4655
+ "name": "unstructured-api-key"
4656
+ },
4657
+ "requestBody": "none",
4658
+ "response": {
4659
+ "successStatus": 200,
4660
+ "errors": [
4661
+ {
4662
+ "code": "INTERNAL_ERROR",
4663
+ "status": 500
4664
+ },
4665
+ {
4666
+ "code": "RESPONSE_TOO_LARGE",
4667
+ "status": 413
4668
+ },
4669
+ {
4670
+ "code": "UNAUTHORIZED",
4671
+ "status": 401
4672
+ },
4673
+ {
4674
+ "code": "VALIDATION_ERROR",
4675
+ "status": 422
4676
+ }
4677
+ ]
4678
+ }
4679
+ },
4680
+ {
4681
+ "id": "list-workflows",
4682
+ "operationId": "workflows.list",
4683
+ "method": "GET",
4684
+ "path": "/api/v1/workflows",
4685
+ "auth": {
4686
+ "kind": "header",
4687
+ "name": "unstructured-api-key"
4688
+ },
4689
+ "requestBody": "none",
4690
+ "response": {
4691
+ "successStatus": 200,
4692
+ "errors": [
4693
+ {
4694
+ "code": "INTERNAL_ERROR",
4695
+ "status": 500
4696
+ },
4697
+ {
4698
+ "code": "RESPONSE_TOO_LARGE",
4699
+ "status": 413
4700
+ },
4701
+ {
4702
+ "code": "UNAUTHORIZED",
4703
+ "status": 401
4704
+ },
4705
+ {
4706
+ "code": "VALIDATION_ERROR",
4707
+ "status": 422
4708
+ }
4709
+ ]
4710
+ }
4711
+ },
4712
+ {
4713
+ "id": "partition",
4714
+ "operationId": "general.partition",
4715
+ "method": "POST",
4716
+ "path": "/general/v0/general",
4717
+ "auth": {
4718
+ "kind": "header",
4719
+ "name": "unstructured-api-key"
4720
+ },
4721
+ "requestBody": "text",
4722
+ "response": {
4723
+ "successStatus": 200,
4724
+ "errors": [
4725
+ {
4726
+ "code": "INVALID_FILE",
4727
+ "status": 422
4728
+ },
4729
+ {
4730
+ "code": "INVALID_REQUEST",
4731
+ "status": 400
4732
+ },
4733
+ {
4734
+ "code": "RATE_LIMITED",
4735
+ "status": 429
4736
+ },
4737
+ {
4738
+ "code": "RESPONSE_TOO_LARGE",
4739
+ "status": 413
4740
+ },
4741
+ {
4742
+ "code": "SERVICE_OVERLOADED",
4743
+ "status": 503
4744
+ },
4745
+ {
4746
+ "code": "UNAUTHORIZED",
4747
+ "status": 401
4748
+ },
4749
+ {
4750
+ "code": "UNSUPPORTED_FILE_TYPE",
4751
+ "status": 400
4752
+ },
4753
+ {
4754
+ "code": "VALIDATION_ERROR",
4755
+ "status": 422
4756
+ }
4757
+ ]
4758
+ }
4759
+ },
4760
+ {
4761
+ "id": "run-workflow",
4762
+ "operationId": "workflows.run",
4763
+ "method": "POST",
4764
+ "path": "/api/v1/workflows/{workflow_id}/run",
4765
+ "auth": {
4766
+ "kind": "header",
4767
+ "name": "unstructured-api-key"
4768
+ },
4769
+ "requestBody": "text",
4770
+ "response": {
4771
+ "successStatus": 202,
4772
+ "errors": [
4773
+ {
4774
+ "code": "INTERNAL_ERROR",
4775
+ "status": 500
4776
+ },
4777
+ {
4778
+ "code": "NOT_FOUND",
4779
+ "status": 404
4780
+ },
4781
+ {
4782
+ "code": "UNAUTHORIZED",
4783
+ "status": 401
4784
+ },
4785
+ {
4786
+ "code": "VALIDATION_ERROR",
4787
+ "status": 422
4788
+ }
4789
+ ]
4790
+ }
4791
+ },
4792
+ {
4793
+ "id": "update-destination",
4794
+ "operationId": "destinations.update",
4795
+ "method": "PUT",
4796
+ "path": "/api/v1/destinations/{destination_id}",
4797
+ "auth": {
4798
+ "kind": "header",
4799
+ "name": "unstructured-api-key"
4800
+ },
4801
+ "requestBody": "json",
4802
+ "response": {
4803
+ "successStatus": 200,
4804
+ "errors": [
4805
+ {
4806
+ "code": "NOT_FOUND",
4807
+ "status": 404
4808
+ },
4809
+ {
4810
+ "code": "UNAUTHORIZED",
4811
+ "status": 401
4812
+ },
4813
+ {
4814
+ "code": "VALIDATION_ERROR",
4815
+ "status": 422
4816
+ }
4817
+ ]
4818
+ }
4819
+ },
4820
+ {
4821
+ "id": "update-source",
4822
+ "operationId": "sources.update",
4823
+ "method": "PUT",
4824
+ "path": "/api/v1/sources/{source_id}",
4825
+ "auth": {
4826
+ "kind": "header",
4827
+ "name": "unstructured-api-key"
4828
+ },
4829
+ "requestBody": "json",
4830
+ "response": {
4831
+ "successStatus": 200,
4832
+ "errors": [
4833
+ {
4834
+ "code": "NOT_FOUND",
4835
+ "status": 404
4836
+ },
4837
+ {
4838
+ "code": "UNAUTHORIZED",
4839
+ "status": 401
4840
+ },
4841
+ {
4842
+ "code": "VALIDATION_ERROR",
4843
+ "status": 422
4844
+ }
4845
+ ]
4846
+ }
4847
+ },
4848
+ {
4849
+ "id": "update-workflow",
4850
+ "operationId": "workflows.update",
4851
+ "method": "PUT",
4852
+ "path": "/api/v1/workflows/{workflow_id}",
4853
+ "auth": {
4854
+ "kind": "header",
4855
+ "name": "unstructured-api-key"
4856
+ },
4857
+ "requestBody": "json",
4858
+ "response": {
4859
+ "successStatus": 200,
4860
+ "errors": [
4861
+ {
4862
+ "code": "NOT_FOUND",
4863
+ "status": 404
4864
+ },
4865
+ {
4866
+ "code": "UNAUTHORIZED",
4867
+ "status": 401
4868
+ },
4869
+ {
4870
+ "code": "VALIDATION_ERROR",
4871
+ "status": 422
4872
+ }
4873
+ ]
4874
+ }
4875
+ }
4876
+ ],
4877
+ "callbacks": [],
4878
+ "compatibility": [],
4879
+ "connections": [
4880
+ {
4881
+ "id": "unstructured-api",
4882
+ "title": "Unstructured clients (server URL and API key overrides)",
4883
+ "protocol": "http",
4884
+ "environment": {
4885
+ "UNSTRUCTURED_API_URL": "FIREDRILL_HTTP_URL",
4886
+ "UNSTRUCTURED_API_KEY": "FIREDRILL_HTTP_TOKEN"
4887
+ },
4888
+ "instructions": "Point an Unstructured client at UNSTRUCTURED_API_URL with UNSTRUCTURED_API_KEY as the unstructured-api-key header value (for example unstructured-client's server_url and api_key_auth). Both the Partition Endpoint route /general/v0/general and the Workflow Endpoint routes under /api/v1 are served from this one origin; collection routes take no trailing slash. Only UTF-8 text documents can be partitioned. No official client has been verified against this Tool."
4889
+ }
4890
+ ]
4891
+ }
4892
+ }