list

GET

https://api.groundx.ai/api/v1/workflow

GET

/api/v1/workflow

1 from groundx import GroundX
2 
3 client = GroundX(
4     api_key="YOUR_API_KEY",
5 )
6 client.workflows.list()

Try it

200Retrieved

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

Get all workflows associated with the API key.

Authentication

X-API-Keystring

API Key authentication via header

Response

Look up success

workflowslist of objects