get

GET

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

GET

/api/v1/workflow/:id

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

Try it

200Retrieved

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

look up a specific workflow by groupId, bucketId, or workflowId.

Authentication

X-API-Keystring

API Key authentication via header

Path Parameters

idinteger or stringRequired

The id of the group, bucket, or workflow to look up.

Response

Look up success

workflowobject

Workflow information