For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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
    • POSTcopy
    • PUTupdate
    • DELcancel_process
    • GETget_extract
    • GETget_xray
  • Search
    • POSTsearch.content
    • POSTsearch.documents
  • Buckets
    • GETlist
    • GETget
    • POSTcreate
    • PUTupdate
    • DELdelete
  • Groups
    • GETlist
    • GETget
    • POSTcreate
    • PUTupdate
    • DELdelete
    • POSTaddBucket
    • DELremoveBucket
  • Workflows
    • GETlist
    • POSTcreate
    • GETget_account
    • POSTadd_to_account
    • DELremove_from_account
    • POSTadd_to_id
    • DELremove_from_id
    • GETget
    • PUTupdate
    • DELdelete
  • Customer
    • GETget
  • API Key
    • GETlist
    • POSTcreate
    • PUTupdate
    • DELdelete
  • Health
    • GETlist
    • GETget
Sign Up
LogoLogo
Documents

get_processing_status_by_id

GET
https://api.groundx.ai/api/v1/ingest/:processId
GET
/api/v1/ingest/:processId
1from groundx import GroundX
2
3client = GroundX(
4    api_key="YOUR_API_KEY_HERE",
5)
6
7client.documents.get_processing_status_by_id(
8    process_id="processId",
9)
1{
2  "ingest": {
3    "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4    "status": "processing",
5    "id": 42,
6    "progress": {
7      "cancelled": {
8        "documents": [
9          {
10            "documentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
11            "bucketId": 7,
12            "fileName": "cancelled_report.pdf",
13            "fileSize": "2.3MB",
14            "fileType": "pdf",
15            "filter": {
16              "category": "finance",
17              "review_status": {
18                "approved": "no"
19              }
20            },
21            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
22            "processLevel": "none",
23            "searchData": {},
24            "sourceUrl": "https://example.com/docs/cancelled_report.pdf",
25            "status": "cancelled",
26            "statusMessage": "User cancelled upload",
27            "textUrl": "https://storage.groundx.ai/texts/cancelled_report.txt",
28            "xrayUrl": "https://storage.groundx.ai/xray/cancelled_report.json"
29          }
30        ],
31        "total": 1
32      },
33      "complete": {
34        "documents": [
35          {
36            "documentId": "a123f1ee-6c54-4b01-90e6-d701748f1234",
37            "bucketId": 7,
38            "fileName": "final_report.docx",
39            "fileSize": "1.8MB",
40            "fileType": "docx",
41            "filter": {
42              "category": "legal",
43              "review_status": {
44                "approved": "yes"
45              }
46            },
47            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
48            "processLevel": "full",
49            "searchData": {},
50            "sourceUrl": "https://example.com/docs/final_report.docx",
51            "status": "complete",
52            "statusMessage": "Document processed successfully",
53            "textUrl": "https://storage.groundx.ai/texts/final_report.txt",
54            "xrayUrl": "https://storage.groundx.ai/xray/final_report.json"
55          }
56        ],
57        "total": 1
58      },
59      "errors": {
60        "documents": [
61          {
62            "documentId": "b456f1ee-6c54-4b01-90e6-d701748f5678",
63            "bucketId": 7,
64            "fileName": "error_log.csv",
65            "fileSize": "0.9MB",
66            "fileType": "csv",
67            "filter": {
68              "category": "logs",
69              "error_type": {
70                "critical": "true"
71              }
72            },
73            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
74            "processLevel": "none",
75            "searchData": {},
76            "sourceUrl": "https://example.com/docs/error_log.csv",
77            "status": "error",
78            "statusMessage": "File corrupted during upload",
79            "textUrl": "https://storage.groundx.ai/texts/error_log.txt",
80            "xrayUrl": "https://storage.groundx.ai/xray/error_log.json"
81          }
82        ],
83        "total": 1
84      },
85      "processing": {
86        "documents": [
87          {
88            "documentId": "c789f1ee-6c54-4b01-90e6-d701748f9012",
89            "bucketId": 7,
90            "fileName": "processing_data.xlsx",
91            "fileSize": "3.1MB",
92            "fileType": "xlsx",
93            "filter": {
94              "category": "data",
95              "priority": {
96                "level": "high"
97              }
98            },
99            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
100            "processLevel": "full",
101            "searchData": {},
102            "sourceUrl": "https://example.com/docs/processing_data.xlsx",
103            "status": "processing",
104            "statusMessage": "Currently processing document",
105            "textUrl": "https://storage.groundx.ai/texts/processing_data.txt",
106            "xrayUrl": "https://storage.groundx.ai/xray/processing_data.json"
107          }
108        ],
109        "total": 1
110      },
111      "queued": {
112        "documents": [
113          {
114            "documentId": "d012f1ee-6c54-4b01-90e6-d701748f3456",
115            "bucketId": 7,
116            "fileName": "queued_presentation.pptx",
117            "fileSize": "4.5MB",
118            "fileType": "pptx",
119            "filter": {
120              "category": "marketing",
121              "status": {
122                "ready_for_processing": "true"
123              }
124            },
125            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
126            "processLevel": "none",
127            "searchData": {},
128            "sourceUrl": "https://example.com/docs/queued_presentation.pptx",
129            "status": "queued",
130            "statusMessage": "Waiting in queue",
131            "textUrl": "https://storage.groundx.ai/texts/queued_presentation.txt",
132            "xrayUrl": "https://storage.groundx.ai/xray/queued_presentation.json"
133          }
134        ],
135        "total": 1
136      }
137    },
138    "statusMessage": "Ingest process is currently running"
139  }
140}

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

Was this page helpful?
Previous

list

Next
Built with

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

Errors

400
Bad Request Error
401
Unauthorized Error