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

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

delete

Next
Built with
Update an existing workflow.
update

Authentication

X-API-Keystring
API Key authentication via header

Path Parameters

idstringRequiredformat: "uuid"
The workflowId of the workflow being updated.

Request

This endpoint expects an object.
chunkStrategyenumOptional
Allowed values:
namestringOptional
The name of the workflow being created.
stepsobjectOptional
A collection of workflow steps

Response

Update success
workflowobject
Workflow information