Sign Up
DocumentationAPI ReferenceSDKs
DocumentationAPI ReferenceSDKs
  • Documents
    • Ingest Documents
    • Ingest Directories
    • POSTcrawl_website
    • GETget_processing_status_by_id
    • GETlist
    • GETget
    • GETlookup
    • DELdelete (singular)
    • DELdelete (multiple)
    • GETget_processes
  • Search
    • POSTsearch.content
    • POSTsearch.documents
  • Buckets
    • GETlist
    • GETget
    • POSTcreate
    • PUTupdate
    • DELdelete
  • Groups
    • GETlist
    • GETget
    • POSTcreate
    • PUTupdate
    • DELdelete
    • POSTaddBucket
    • DELremoveBucket
  • Workflows
    • GETlist
    • POSTcreate
    • POSTadd_to_account
    • DELremove_from_account
    • POSTadd_to_id
    • DELremove_from_id
    • GETget
    • PUTupdate
    • DELdelete
  • Customer
    • GETget
  • Health
    • GETlist
    • GETget
Sign Up
LogoLogo
Workflows

GET
https://api.groundx.ai/api/v1/workflow
GET
/api/v1/workflow
1from groundx import GroundX
2
3client = GroundX(
4 api_key="YOUR_API_KEY",
5)
6client.workflows.list()
Try it
200Retrieved
1{
2 "workflows": [
3 {
4 "chunkStrategy": "element",
5 "documentId": "string",
6 "id": 1,
7 "name": "string",
8 "steps": {
9 "chunk-instruct": {
10 "all": {
11 "engine": {
12 "apiKey": "string",
13 "baseURL": "string",
14 "engineID": "string",
15 "reasoningEffort": "minimal",
16 "service": "openai"
17 },
18 "field": "doc-sum",
19 "includes": {},
20 "prompt": {
21 "request": {
22 "abbreviated": "string",
23 "prompt": "string",
24 "role": "assistant"
25 },
26 "task": {
27 "abbreviated": "string",
28 "prompt": "string",
29 "role": "assistant"
30 }
31 }
32 },
33 "figure": {
34 "engine": {
35 "apiKey": "string",
36 "baseURL": "string",
37 "engineID": "string",
38 "reasoningEffort": "minimal",
39 "service": "openai"
40 },
41 "field": "doc-sum",
42 "includes": {},
43 "prompt": {
44 "request": {
45 "abbreviated": "string",
46 "prompt": "string",
47 "role": "assistant"
48 },
49 "task": {
50 "abbreviated": "string",
51 "prompt": "string",
52 "role": "assistant"
53 }
54 }
55 },
56 "json": {
57 "engine": {
58 "apiKey": "string",
59 "baseURL": "string",
60 "engineID": "string",
61 "reasoningEffort": "minimal",
62 "service": "openai"
63 },
64 "field": "doc-sum",
65 "includes": {},
66 "prompt": {
67 "request": {
68 "abbreviated": "string",
69 "prompt": "string",
70 "role": "assistant"
71 },
72 "task": {
73 "abbreviated": "string",
74 "prompt": "string",
75 "role": "assistant"
76 }
77 }
78 },
79 "paragraph": {
80 "engine": {
81 "apiKey": "string",
82 "baseURL": "string",
83 "engineID": "string",
84 "reasoningEffort": "minimal",
85 "service": "openai"
86 },
87 "field": "doc-sum",
88 "includes": {},
89 "prompt": {
90 "request": {
91 "abbreviated": "string",
92 "prompt": "string",
93 "role": "assistant"
94 },
95 "task": {
96 "abbreviated": "string",
97 "prompt": "string",
98 "role": "assistant"
99 }
100 }
101 },
102 "table": {
103 "engine": {
104 "apiKey": "string",
105 "baseURL": "string",
106 "engineID": "string",
107 "reasoningEffort": "minimal",
108 "service": "openai"
109 },
110 "field": "doc-sum",
111 "includes": {},
112 "prompt": {
113 "request": {
114 "abbreviated": "string",
115 "prompt": "string",
116 "role": "assistant"
117 },
118 "task": {
119 "abbreviated": "string",
120 "prompt": "string",
121 "role": "assistant"
122 }
123 }
124 },
125 "table-figure": {
126 "engine": {
127 "apiKey": "string",
128 "baseURL": "string",
129 "engineID": "string",
130 "reasoningEffort": "minimal",
131 "service": "openai"
132 },
133 "field": "doc-sum",
134 "includes": {},
135 "prompt": {
136 "request": {
137 "abbreviated": "string",
138 "prompt": "string",
139 "role": "assistant"
140 },
141 "task": {
142 "abbreviated": "string",
143 "prompt": "string",
144 "role": "assistant"
145 }
146 }
147 }
148 },
149 "chunk-summary": {
150 "all": {
151 "engine": {
152 "apiKey": "string",
153 "baseURL": "string",
154 "engineID": "string",
155 "reasoningEffort": "minimal",
156 "service": "openai"
157 },
158 "field": "doc-sum",
159 "includes": {},
160 "prompt": {
161 "request": {
162 "abbreviated": "string",
163 "prompt": "string",
164 "role": "assistant"
165 },
166 "task": {
167 "abbreviated": "string",
168 "prompt": "string",
169 "role": "assistant"
170 }
171 }
172 },
173 "figure": {
174 "engine": {
175 "apiKey": "string",
176 "baseURL": "string",
177 "engineID": "string",
178 "reasoningEffort": "minimal",
179 "service": "openai"
180 },
181 "field": "doc-sum",
182 "includes": {},
183 "prompt": {
184 "request": {
185 "abbreviated": "string",
186 "prompt": "string",
187 "role": "assistant"
188 },
189 "task": {
190 "abbreviated": "string",
191 "prompt": "string",
192 "role": "assistant"
193 }
194 }
195 },
196 "json": {
197 "engine": {
198 "apiKey": "string",
199 "baseURL": "string",
200 "engineID": "string",
201 "reasoningEffort": "minimal",
202 "service": "openai"
203 },
204 "field": "doc-sum",
205 "includes": {},
206 "prompt": {
207 "request": {
208 "abbreviated": "string",
209 "prompt": "string",
210 "role": "assistant"
211 },
212 "task": {
213 "abbreviated": "string",
214 "prompt": "string",
215 "role": "assistant"
216 }
217 }
218 },
219 "paragraph": {
220 "engine": {
221 "apiKey": "string",
222 "baseURL": "string",
223 "engineID": "string",
224 "reasoningEffort": "minimal",
225 "service": "openai"
226 },
227 "field": "doc-sum",
228 "includes": {},
229 "prompt": {
230 "request": {
231 "abbreviated": "string",
232 "prompt": "string",
233 "role": "assistant"
234 },
235 "task": {
236 "abbreviated": "string",
237 "prompt": "string",
238 "role": "assistant"
239 }
240 }
241 },
242 "table": {
243 "engine": {
244 "apiKey": "string",
245 "baseURL": "string",
246 "engineID": "string",
247 "reasoningEffort": "minimal",
248 "service": "openai"
249 },
250 "field": "doc-sum",
251 "includes": {},
252 "prompt": {
253 "request": {
254 "abbreviated": "string",
255 "prompt": "string",
256 "role": "assistant"
257 },
258 "task": {
259 "abbreviated": "string",
260 "prompt": "string",
261 "role": "assistant"
262 }
263 }
264 },
265 "table-figure": {
266 "engine": {
267 "apiKey": "string",
268 "baseURL": "string",
269 "engineID": "string",
270 "reasoningEffort": "minimal",
271 "service": "openai"
272 },
273 "field": "doc-sum",
274 "includes": {},
275 "prompt": {
276 "request": {
277 "abbreviated": "string",
278 "prompt": "string",
279 "role": "assistant"
280 },
281 "task": {
282 "abbreviated": "string",
283 "prompt": "string",
284 "role": "assistant"
285 }
286 }
287 }
288 },
289 "doc-keys": {
290 "all": {
291 "engine": {
292 "apiKey": "string",
293 "baseURL": "string",
294 "engineID": "string",
295 "reasoningEffort": "minimal",
296 "service": "openai"
297 },
298 "field": "doc-sum",
299 "includes": {},
300 "prompt": {
301 "request": {
302 "abbreviated": "string",
303 "prompt": "string",
304 "role": "assistant"
305 },
306 "task": {
307 "abbreviated": "string",
308 "prompt": "string",
309 "role": "assistant"
310 }
311 }
312 },
313 "figure": {
314 "engine": {
315 "apiKey": "string",
316 "baseURL": "string",
317 "engineID": "string",
318 "reasoningEffort": "minimal",
319 "service": "openai"
320 },
321 "field": "doc-sum",
322 "includes": {},
323 "prompt": {
324 "request": {
325 "abbreviated": "string",
326 "prompt": "string",
327 "role": "assistant"
328 },
329 "task": {
330 "abbreviated": "string",
331 "prompt": "string",
332 "role": "assistant"
333 }
334 }
335 },
336 "json": {
337 "engine": {
338 "apiKey": "string",
339 "baseURL": "string",
340 "engineID": "string",
341 "reasoningEffort": "minimal",
342 "service": "openai"
343 },
344 "field": "doc-sum",
345 "includes": {},
346 "prompt": {
347 "request": {
348 "abbreviated": "string",
349 "prompt": "string",
350 "role": "assistant"
351 },
352 "task": {
353 "abbreviated": "string",
354 "prompt": "string",
355 "role": "assistant"
356 }
357 }
358 },
359 "paragraph": {
360 "engine": {
361 "apiKey": "string",
362 "baseURL": "string",
363 "engineID": "string",
364 "reasoningEffort": "minimal",
365 "service": "openai"
366 },
367 "field": "doc-sum",
368 "includes": {},
369 "prompt": {
370 "request": {
371 "abbreviated": "string",
372 "prompt": "string",
373 "role": "assistant"
374 },
375 "task": {
376 "abbreviated": "string",
377 "prompt": "string",
378 "role": "assistant"
379 }
380 }
381 },
382 "table": {
383 "engine": {
384 "apiKey": "string",
385 "baseURL": "string",
386 "engineID": "string",
387 "reasoningEffort": "minimal",
388 "service": "openai"
389 },
390 "field": "doc-sum",
391 "includes": {},
392 "prompt": {
393 "request": {
394 "abbreviated": "string",
395 "prompt": "string",
396 "role": "assistant"
397 },
398 "task": {
399 "abbreviated": "string",
400 "prompt": "string",
401 "role": "assistant"
402 }
403 }
404 },
405 "table-figure": {
406 "engine": {
407 "apiKey": "string",
408 "baseURL": "string",
409 "engineID": "string",
410 "reasoningEffort": "minimal",
411 "service": "openai"
412 },
413 "field": "doc-sum",
414 "includes": {},
415 "prompt": {
416 "request": {
417 "abbreviated": "string",
418 "prompt": "string",
419 "role": "assistant"
420 },
421 "task": {
422 "abbreviated": "string",
423 "prompt": "string",
424 "role": "assistant"
425 }
426 }
427 }
428 },
429 "doc-summary": {
430 "all": {
431 "engine": {
432 "apiKey": "string",
433 "baseURL": "string",
434 "engineID": "string",
435 "reasoningEffort": "minimal",
436 "service": "openai"
437 },
438 "field": "doc-sum",
439 "includes": {},
440 "prompt": {
441 "request": {
442 "abbreviated": "string",
443 "prompt": "string",
444 "role": "assistant"
445 },
446 "task": {
447 "abbreviated": "string",
448 "prompt": "string",
449 "role": "assistant"
450 }
451 }
452 },
453 "figure": {
454 "engine": {
455 "apiKey": "string",
456 "baseURL": "string",
457 "engineID": "string",
458 "reasoningEffort": "minimal",
459 "service": "openai"
460 },
461 "field": "doc-sum",
462 "includes": {},
463 "prompt": {
464 "request": {
465 "abbreviated": "string",
466 "prompt": "string",
467 "role": "assistant"
468 },
469 "task": {
470 "abbreviated": "string",
471 "prompt": "string",
472 "role": "assistant"
473 }
474 }
475 },
476 "json": {
477 "engine": {
478 "apiKey": "string",
479 "baseURL": "string",
480 "engineID": "string",
481 "reasoningEffort": "minimal",
482 "service": "openai"
483 },
484 "field": "doc-sum",
485 "includes": {},
486 "prompt": {
487 "request": {
488 "abbreviated": "string",
489 "prompt": "string",
490 "role": "assistant"
491 },
492 "task": {
493 "abbreviated": "string",
494 "prompt": "string",
495 "role": "assistant"
496 }
497 }
498 },
499 "paragraph": {
500 "engine": {
501 "apiKey": "string",
502 "baseURL": "string",
503 "engineID": "string",
504 "reasoningEffort": "minimal",
505 "service": "openai"
506 },
507 "field": "doc-sum",
508 "includes": {},
509 "prompt": {
510 "request": {
511 "abbreviated": "string",
512 "prompt": "string",
513 "role": "assistant"
514 },
515 "task": {
516 "abbreviated": "string",
517 "prompt": "string",
518 "role": "assistant"
519 }
520 }
521 },
522 "table": {
523 "engine": {
524 "apiKey": "string",
525 "baseURL": "string",
526 "engineID": "string",
527 "reasoningEffort": "minimal",
528 "service": "openai"
529 },
530 "field": "doc-sum",
531 "includes": {},
532 "prompt": {
533 "request": {
534 "abbreviated": "string",
535 "prompt": "string",
536 "role": "assistant"
537 },
538 "task": {
539 "abbreviated": "string",
540 "prompt": "string",
541 "role": "assistant"
542 }
543 }
544 },
545 "table-figure": {
546 "engine": {
547 "apiKey": "string",
548 "baseURL": "string",
549 "engineID": "string",
550 "reasoningEffort": "minimal",
551 "service": "openai"
552 },
553 "field": "doc-sum",
554 "includes": {},
555 "prompt": {
556 "request": {
557 "abbreviated": "string",
558 "prompt": "string",
559 "role": "assistant"
560 },
561 "task": {
562 "abbreviated": "string",
563 "prompt": "string",
564 "role": "assistant"
565 }
566 }
567 }
568 },
569 "search-query": {
570 "all": {
571 "engine": {
572 "apiKey": "string",
573 "baseURL": "string",
574 "engineID": "string",
575 "reasoningEffort": "minimal",
576 "service": "openai"
577 },
578 "field": "doc-sum",
579 "includes": {},
580 "prompt": {
581 "request": {
582 "abbreviated": "string",
583 "prompt": "string",
584 "role": "assistant"
585 },
586 "task": {
587 "abbreviated": "string",
588 "prompt": "string",
589 "role": "assistant"
590 }
591 }
592 },
593 "figure": {
594 "engine": {
595 "apiKey": "string",
596 "baseURL": "string",
597 "engineID": "string",
598 "reasoningEffort": "minimal",
599 "service": "openai"
600 },
601 "field": "doc-sum",
602 "includes": {},
603 "prompt": {
604 "request": {
605 "abbreviated": "string",
606 "prompt": "string",
607 "role": "assistant"
608 },
609 "task": {
610 "abbreviated": "string",
611 "prompt": "string",
612 "role": "assistant"
613 }
614 }
615 },
616 "json": {
617 "engine": {
618 "apiKey": "string",
619 "baseURL": "string",
620 "engineID": "string",
621 "reasoningEffort": "minimal",
622 "service": "openai"
623 },
624 "field": "doc-sum",
625 "includes": {},
626 "prompt": {
627 "request": {
628 "abbreviated": "string",
629 "prompt": "string",
630 "role": "assistant"
631 },
632 "task": {
633 "abbreviated": "string",
634 "prompt": "string",
635 "role": "assistant"
636 }
637 }
638 },
639 "paragraph": {
640 "engine": {
641 "apiKey": "string",
642 "baseURL": "string",
643 "engineID": "string",
644 "reasoningEffort": "minimal",
645 "service": "openai"
646 },
647 "field": "doc-sum",
648 "includes": {},
649 "prompt": {
650 "request": {
651 "abbreviated": "string",
652 "prompt": "string",
653 "role": "assistant"
654 },
655 "task": {
656 "abbreviated": "string",
657 "prompt": "string",
658 "role": "assistant"
659 }
660 }
661 },
662 "table": {
663 "engine": {
664 "apiKey": "string",
665 "baseURL": "string",
666 "engineID": "string",
667 "reasoningEffort": "minimal",
668 "service": "openai"
669 },
670 "field": "doc-sum",
671 "includes": {},
672 "prompt": {
673 "request": {
674 "abbreviated": "string",
675 "prompt": "string",
676 "role": "assistant"
677 },
678 "task": {
679 "abbreviated": "string",
680 "prompt": "string",
681 "role": "assistant"
682 }
683 }
684 },
685 "table-figure": {
686 "engine": {
687 "apiKey": "string",
688 "baseURL": "string",
689 "engineID": "string",
690 "reasoningEffort": "minimal",
691 "service": "openai"
692 },
693 "field": "doc-sum",
694 "includes": {},
695 "prompt": {
696 "request": {
697 "abbreviated": "string",
698 "prompt": "string",
699 "role": "assistant"
700 },
701 "task": {
702 "abbreviated": "string",
703 "prompt": "string",
704 "role": "assistant"
705 }
706 }
707 }
708 },
709 "sect-instruct": {
710 "all": {
711 "engine": {
712 "apiKey": "string",
713 "baseURL": "string",
714 "engineID": "string",
715 "reasoningEffort": "minimal",
716 "service": "openai"
717 },
718 "field": "doc-sum",
719 "includes": {},
720 "prompt": {
721 "request": {
722 "abbreviated": "string",
723 "prompt": "string",
724 "role": "assistant"
725 },
726 "task": {
727 "abbreviated": "string",
728 "prompt": "string",
729 "role": "assistant"
730 }
731 }
732 },
733 "figure": {
734 "engine": {
735 "apiKey": "string",
736 "baseURL": "string",
737 "engineID": "string",
738 "reasoningEffort": "minimal",
739 "service": "openai"
740 },
741 "field": "doc-sum",
742 "includes": {},
743 "prompt": {
744 "request": {
745 "abbreviated": "string",
746 "prompt": "string",
747 "role": "assistant"
748 },
749 "task": {
750 "abbreviated": "string",
751 "prompt": "string",
752 "role": "assistant"
753 }
754 }
755 },
756 "json": {
757 "engine": {
758 "apiKey": "string",
759 "baseURL": "string",
760 "engineID": "string",
761 "reasoningEffort": "minimal",
762 "service": "openai"
763 },
764 "field": "doc-sum",
765 "includes": {},
766 "prompt": {
767 "request": {
768 "abbreviated": "string",
769 "prompt": "string",
770 "role": "assistant"
771 },
772 "task": {
773 "abbreviated": "string",
774 "prompt": "string",
775 "role": "assistant"
776 }
777 }
778 },
779 "paragraph": {
780 "engine": {
781 "apiKey": "string",
782 "baseURL": "string",
783 "engineID": "string",
784 "reasoningEffort": "minimal",
785 "service": "openai"
786 },
787 "field": "doc-sum",
788 "includes": {},
789 "prompt": {
790 "request": {
791 "abbreviated": "string",
792 "prompt": "string",
793 "role": "assistant"
794 },
795 "task": {
796 "abbreviated": "string",
797 "prompt": "string",
798 "role": "assistant"
799 }
800 }
801 },
802 "table": {
803 "engine": {
804 "apiKey": "string",
805 "baseURL": "string",
806 "engineID": "string",
807 "reasoningEffort": "minimal",
808 "service": "openai"
809 },
810 "field": "doc-sum",
811 "includes": {},
812 "prompt": {
813 "request": {
814 "abbreviated": "string",
815 "prompt": "string",
816 "role": "assistant"
817 },
818 "task": {
819 "abbreviated": "string",
820 "prompt": "string",
821 "role": "assistant"
822 }
823 }
824 },
825 "table-figure": {
826 "engine": {
827 "apiKey": "string",
828 "baseURL": "string",
829 "engineID": "string",
830 "reasoningEffort": "minimal",
831 "service": "openai"
832 },
833 "field": "doc-sum",
834 "includes": {},
835 "prompt": {
836 "request": {
837 "abbreviated": "string",
838 "prompt": "string",
839 "role": "assistant"
840 },
841 "task": {
842 "abbreviated": "string",
843 "prompt": "string",
844 "role": "assistant"
845 }
846 }
847 }
848 },
849 "sect-summary": {
850 "all": {
851 "engine": {
852 "apiKey": "string",
853 "baseURL": "string",
854 "engineID": "string",
855 "reasoningEffort": "minimal",
856 "service": "openai"
857 },
858 "field": "doc-sum",
859 "includes": {},
860 "prompt": {
861 "request": {
862 "abbreviated": "string",
863 "prompt": "string",
864 "role": "assistant"
865 },
866 "task": {
867 "abbreviated": "string",
868 "prompt": "string",
869 "role": "assistant"
870 }
871 }
872 },
873 "figure": {
874 "engine": {
875 "apiKey": "string",
876 "baseURL": "string",
877 "engineID": "string",
878 "reasoningEffort": "minimal",
879 "service": "openai"
880 },
881 "field": "doc-sum",
882 "includes": {},
883 "prompt": {
884 "request": {
885 "abbreviated": "string",
886 "prompt": "string",
887 "role": "assistant"
888 },
889 "task": {
890 "abbreviated": "string",
891 "prompt": "string",
892 "role": "assistant"
893 }
894 }
895 },
896 "json": {
897 "engine": {
898 "apiKey": "string",
899 "baseURL": "string",
900 "engineID": "string",
901 "reasoningEffort": "minimal",
902 "service": "openai"
903 },
904 "field": "doc-sum",
905 "includes": {},
906 "prompt": {
907 "request": {
908 "abbreviated": "string",
909 "prompt": "string",
910 "role": "assistant"
911 },
912 "task": {
913 "abbreviated": "string",
914 "prompt": "string",
915 "role": "assistant"
916 }
917 }
918 },
919 "paragraph": {
920 "engine": {
921 "apiKey": "string",
922 "baseURL": "string",
923 "engineID": "string",
924 "reasoningEffort": "minimal",
925 "service": "openai"
926 },
927 "field": "doc-sum",
928 "includes": {},
929 "prompt": {
930 "request": {
931 "abbreviated": "string",
932 "prompt": "string",
933 "role": "assistant"
934 },
935 "task": {
936 "abbreviated": "string",
937 "prompt": "string",
938 "role": "assistant"
939 }
940 }
941 },
942 "table": {
943 "engine": {
944 "apiKey": "string",
945 "baseURL": "string",
946 "engineID": "string",
947 "reasoningEffort": "minimal",
948 "service": "openai"
949 },
950 "field": "doc-sum",
951 "includes": {},
952 "prompt": {
953 "request": {
954 "abbreviated": "string",
955 "prompt": "string",
956 "role": "assistant"
957 },
958 "task": {
959 "abbreviated": "string",
960 "prompt": "string",
961 "role": "assistant"
962 }
963 }
964 },
965 "table-figure": {
966 "engine": {
967 "apiKey": "string",
968 "baseURL": "string",
969 "engineID": "string",
970 "reasoningEffort": "minimal",
971 "service": "openai"
972 },
973 "field": "doc-sum",
974 "includes": {},
975 "prompt": {
976 "request": {
977 "abbreviated": "string",
978 "prompt": "string",
979 "role": "assistant"
980 },
981 "task": {
982 "abbreviated": "string",
983 "prompt": "string",
984 "role": "assistant"
985 }
986 }
987 }
988 }
989 },
990 "relationships": {
991 "account": true,
992 "documents": [
993 "string"
994 ],
995 "ids": [
996 1
997 ]
998 },
999 "workflowId": "string"
1000 }
1001 ]
1002}
Was this page helpful?
Previous

create

Next
Built with
Get all workflows associated with the API key.
list

Authentication

X-API-Keystring
API Key authentication via header

Response

Look up success
workflowslist of objects