get_processing_status_by_id

GET

https://api.groundx.ai/api/v1/ingest/:processId

GET

/api/v1/ingest/:processId

1 from groundx import GroundX
2 
3 client = GroundX(
4     api_key="YOUR_API_KEY",
5 )
6 client.documents.get_processing_status_by_id(
7     process_id="processId",
8 )

Try it

200Retrieved

1 {
2   "ingest": {
3     "processId": "processId",
4     "progress": {
5       "cancelled": {
6         "documents": [
7           {
8             "bucketId": 0,
9             "documentId": "documentId",
10             "fileName": "fileName",
11             "fileSize": "1.4MB",
12             "fileType": "bmp",
13             "processId": "processId",
14             "searchData": {},
15             "sourceUrl": "sourceUrl",
16             "status": "queued",
17             "statusMessage": "statusMessage",
18             "xrayUrl": "xrayUrl"
19           }
20         ],
21         "total": 0
22       },
23       "complete": {
24         "documents": [
25           {
26             "bucketId": 0,
27             "documentId": "documentId",
28             "fileName": "fileName",
29             "fileSize": "1.4MB",
30             "fileType": "bmp",
31             "processId": "processId",
32             "searchData": {},
33             "sourceUrl": "sourceUrl",
34             "status": "queued",
35             "statusMessage": "statusMessage",
36             "xrayUrl": "xrayUrl"
37           }
38         ],
39         "total": 0
40       },
41       "errors": {
42         "documents": [
43           {
44             "bucketId": 0,
45             "documentId": "documentId",
46             "fileName": "fileName",
47             "fileSize": "1.4MB",
48             "fileType": "bmp",
49             "processId": "processId",
50             "searchData": {},
51             "sourceUrl": "sourceUrl",
52             "status": "queued",
53             "statusMessage": "statusMessage",
54             "xrayUrl": "xrayUrl"
55           }
56         ],
57         "total": 0
58       },
59       "processing": {
60         "documents": [
61           {
62             "bucketId": 0,
63             "documentId": "documentId",
64             "fileName": "fileName",
65             "fileSize": "1.4MB",
66             "fileType": "bmp",
67             "processId": "processId",
68             "searchData": {},
69             "sourceUrl": "sourceUrl",
70             "status": "queued",
71             "statusMessage": "statusMessage",
72             "xrayUrl": "xrayUrl"
73           }
74         ],
75         "total": 0
76       }
77     },
78     "status": "queued",
79     "statusMessage": "statusMessage"
80   }
81 }

Get the current status of an ingest, initiated with documents.ingest_remote, documents.ingest_local, or documents.crawl_website, by specifying the processId (the processId is included in the response of the documents.ingest functions).

Path parameters

processIdUUIDRequired

the processId for the ingest process being checked

Response

Look up success

ingestobject

Path parameters

Headers

Response