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

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

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).

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

processIdstringRequiredformat: "uuid"

the processId for the ingest process being checked

Response

Look up success

ingestobject

Authentication

Path parameters

Response

Errors