delete (singular)

DELETE

https://api.groundx.ai/api/v1/ingest/document/:documentId

DELETE

/api/v1/ingest/document/:documentId

1 from groundx import GroundX
2 
3 client = GroundX(
4     api_key="YOUR_API_KEY",
5 )
6 client.documents.delete_by_id(
7     document_id="documentId",
8 )

Try it

200Deleted

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

Delete a single document hosted on GroundX

Path parameters

documentIdUUIDRequired

A documentId which correspond to a document ingested by GroundX

Response

Document successfully deleted

ingestobject

Path parameters

Headers

Response