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_HERE",
5 )
6 
7 client.workflows.list()

200Retrieved

1 {
2   "workflows": [
3     {
4       "chunkStrategy": "element",
5       "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6       "id": 42,
7       "name": "Customer Support Ticket Analysis",
8       "updatedAt": "2024-04-10T14:22:00Z",
9       "extract": {},
10       "template": {
11         "GREETING": "Hello, how can I assist you today?",
12         "CLOSING": "Thank you for contacting support."
13       },
14       "sectionStrategy": "chunks",
15       "steps": {
16         "chunk-instruct": {
17           "all": {
18             "engine": {
19               "apiKey": "sk-abc123def456ghi789jkl",
20               "baseURL": "https://api.openai.com/v1",
21               "engineID": "gpt-4",
22               "reasoningEffort": "medium",
23               "requestPassthrough": {
24                 "temperature": 0.7,
25                 "max_tokens": 500
26               },
27               "service": "openai"
28             },
29             "field": "chunk-instruct",
30             "includes": {
31               "metadata": true,
32               "text": true
33             },
34             "prompt": {
35               "request": {
36                 "abbreviated": "Instr. chunk",
37                 "additionalContext": "Focus on key instructions in the chunk.",
38                 "prompt": "Please extract the main instructions from the following text chunk.",
39                 "role": "assistant"
40               },
41               "task": {
42                 "abbreviated": "Task chunk",
43                 "additionalContext": "Summarize instructions for chunk processing.",
44                 "prompt": "Summarize the instructions contained in this chunk.",
45                 "role": "assistant"
46               }
47             }
48           },
49           "figure": {
50             "engine": {
51               "apiKey": "sk-abc123def456ghi789jkl",
52               "baseURL": "https://api.openai.com/v1",
53               "engineID": "gpt-4",
54               "reasoningEffort": "medium",
55               "requestPassthrough": {
56                 "temperature": 0.6,
57                 "max_tokens": 300
58               },
59               "service": "openai"
60             },
61             "field": "chunk-instruct",
62             "includes": {
63               "metadata": true,
64               "imageDescription": true
65             },
66             "prompt": {
67               "request": {
68                 "abbreviated": "Instr. figure",
69                 "additionalContext": "Describe the figure content briefly.",
70                 "prompt": "Describe the key elements of the figure in this chunk.",
71                 "role": "assistant"
72               },
73               "task": {
74                 "abbreviated": "Task figure",
75                 "additionalContext": "Summarize figure instructions.",
76                 "prompt": "Summarize the instructions related to the figure.",
77                 "role": "assistant"
78               }
79             }
80           },
81           "json": {
82             "engine": {
83               "apiKey": "sk-abc123def456ghi789jkl",
84               "baseURL": "https://api.openai.com/v1",
85               "engineID": "gpt-4",
86               "reasoningEffort": "medium",
87               "requestPassthrough": {
88                 "temperature": 0.5,
89                 "max_tokens": 400
90               },
91               "service": "openai"
92             },
93             "field": "chunk-instruct",
94             "includes": {
95               "metadata": true,
96               "jsonSchema": true
97             },
98             "prompt": {
99               "request": {
100                 "abbreviated": "Instr. JSON",
101                 "additionalContext": "Analyze JSON structure for instructions.",
102                 "prompt": "Extract instructions from the JSON data provided.",
103                 "role": "assistant"
104               },
105               "task": {
106                 "abbreviated": "Task JSON",
107                 "additionalContext": "Summarize JSON instructions.",
108                 "prompt": "Summarize the instructions found in this JSON chunk.",
109                 "role": "assistant"
110               }
111             }
112           },
113           "paragraph": {
114             "engine": {
115               "apiKey": "sk-abc123def456ghi789jkl",
116               "baseURL": "https://api.openai.com/v1",
117               "engineID": "gpt-4",
118               "reasoningEffort": "medium",
119               "requestPassthrough": {
120                 "temperature": 0.7,
121                 "max_tokens": 450
122               },
123               "service": "openai"
124             },
125             "field": "chunk-instruct",
126             "includes": {
127               "metadata": true,
128               "text": true
129             },
130             "prompt": {
131               "request": {
132                 "abbreviated": "Instr. para",
133                 "additionalContext": "Focus on paragraph instructions.",
134                 "prompt": "Identify instructions in this paragraph.",
135                 "role": "assistant"
136               },
137               "task": {
138                 "abbreviated": "Task para",
139                 "additionalContext": "Summarize paragraph instructions.",
140                 "prompt": "Summarize the instructions in this paragraph chunk.",
141                 "role": "assistant"
142               }
143             }
144           },
145           "table": {
146             "engine": {
147               "apiKey": "sk-abc123def456ghi789jkl",
148               "baseURL": "https://api.openai.com/v1",
149               "engineID": "gpt-4",
150               "reasoningEffort": "medium",
151               "requestPassthrough": {
152                 "temperature": 0.6,
153                 "max_tokens": 350
154               },
155               "service": "openai"
156             },
157             "field": "chunk-instruct",
158             "includes": {
159               "metadata": true,
160               "tableData": true
161             },
162             "prompt": {
163               "request": {
164                 "abbreviated": "Instr. table",
165                 "additionalContext": "Analyze table for instructions.",
166                 "prompt": "Extract instructions from the table data.",
167                 "role": "assistant"
168               },
169               "task": {
170                 "abbreviated": "Task table",
171                 "additionalContext": "Summarize table instructions.",
172                 "prompt": "Summarize instructions found in this table chunk.",
173                 "role": "assistant"
174               }
175             }
176           },
177           "table-figure": {
178             "engine": {
179               "apiKey": "sk-abc123def456ghi789jkl",
180               "baseURL": "https://api.openai.com/v1",
181               "engineID": "gpt-4",
182               "reasoningEffort": "medium",
183               "requestPassthrough": {
184                 "temperature": 0.6,
185                 "max_tokens": 350
186               },
187               "service": "openai"
188             },
189             "field": "chunk-instruct",
190             "includes": {
191               "metadata": true,
192               "tableFigureData": true
193             },
194             "prompt": {
195               "request": {
196                 "abbreviated": "Instr. tbl-fig",
197                 "additionalContext": "Describe instructions in table-figure.",
198                 "prompt": "Extract instructions from the combined table and figure data.",
199                 "role": "assistant"
200               },
201               "task": {
202                 "abbreviated": "Task tbl-fig",
203                 "additionalContext": "Summarize table-figure instructions.",
204                 "prompt": "Summarize instructions in this table-figure chunk.",
205                 "role": "assistant"
206               }
207             }
208           }
209         },
210         "chunk-keys": null,
211         "chunk-summary": null,
212         "doc-keys": null,
213         "doc-summary": null,
214         "search-query": null,
215         "sect-instruct": null,
216         "sect-keys": null,
217         "sect-summary": null
218       },
219       "customSteps": [
220         {
221           "name": "custom_sentiment_analysis",
222           "level": "chunk",
223           "kind": "summary",
224           "config": {
225             "all": {
226               "engine": {
227                 "apiKey": "sk-customsentiment1234567890",
228                 "baseURL": "https://api.customllm.com/v1",
229                 "engineID": "custom-sentiment-v1",
230                 "reasoningEffort": "low",
231                 "requestPassthrough": {
232                   "temperature": 0.3,
233                   "max_tokens": 200
234                 },
235                 "service": "hosted"
236               },
237               "includes": {
238                 "sentimentScore": true,
239                 "sentimentLabel": true
240               },
241               "prompt": {
242                 "request": {
243                   "abbreviated": "Sentiment Req",
244                   "additionalContext": "Analyze sentiment of the chunk text.",
245                   "prompt": "Determine the sentiment of the following text chunk.",
246                   "role": "assistant"
247                 },
248                 "task": {
249                   "abbreviated": "Sentiment Task",
250                   "additionalContext": "Summarize sentiment analysis results.",
251                   "prompt": "Summarize the sentiment detected in this chunk.",
252                   "role": "assistant"
253                 }
254               }
255             },
256             "figure": null,
257             "json": null,
258             "paragraph": null,
259             "table": null,
260             "table-figure": null
261           },
262           "requiredTemplateKeys": [
263             "SENTIMENT_THRESHOLD"
264           ]
265         }
266       ],
267       "outputRoutes": [
268         {
269           "workflowGroup": "sentiment_analysis",
270           "workflowField": "sentiment_score",
271           "finalPath": "/results/*/sentimentScore",
272           "stepName": "custom_sentiment_analysis",
273           "level": "chunk",
274           "outputMap": "customChunkOutputs",
275           "outputKey": "sentiment_score",
276           "readbackPath": "results.sentimentScore"
277         }
278       ],
279       "leafFields": [
280         {
281           "finalPath": "/results/*/sentimentScore",
282           "workflowGroup": "sentiment_analysis",
283           "workflowField": "sentiment_score",
284           "stepName": "custom_sentiment_analysis",
285           "level": "chunk",
286           "outputKey": "sentiment_score",
287           "fieldType": "number",
288           "isRepeated": true,
289           "repetitionScope": "item"
290         }
291       ],
292       "relationships": {
293         "account": true,
294         "documents": [
295           "7c9e6679-7425-40de-944b-e07fc1f90ae7"
296         ],
297         "ids": [
298           42
299         ]
300       },
301       "workflowId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
302     }
303   ]
304 }

List workflow IDs, names, update times, and attachments. Use GET /v1/workflow/{id} to get the full workflow.

Authentication

X-API-Keystring

API Key authentication via header

Response

Look up success

workflowslist of objects