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

cancel_process

DELETE
https://api.groundx.ai/api/v1/ingest/:processId
DELETE
/api/v1/ingest/:processId
1from groundx import GroundX
2
3client = GroundX(
4    api_key="YOUR_API_KEY_HERE",
5)
6
7client.documents.cancel_process(
8    process_id="processId",
9)
1{
2  "ingest": {
3    "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4    "status": "cancelled",
5    "id": 42,
6    "progress": {
7      "cancelled": {
8        "documents": [
9          {
10            "documentId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
11            "bucketId": 7,
12            "fileName": "contract_cancelled.pdf",
13            "fileSize": "2.3MB",
14            "fileType": "pdf",
15            "filter": {
16              "category": "legal",
17              "priority": {
18                "level": "high"
19              }
20            },
21            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
22            "processLevel": "full",
23            "searchData": {},
24            "sourceUrl": "https://documents.example.com/contracts/contract_cancelled.pdf",
25            "status": "cancelled",
26            "statusMessage": "Document ingestion cancelled by user",
27            "textUrl": "https://textstorage.example.com/extracted/contract_cancelled.txt",
28            "xrayUrl": "https://xray.example.com/results/contract_cancelled.json"
29          }
30        ],
31        "total": 1
32      },
33      "complete": {
34        "documents": [
35          {
36            "documentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
37            "bucketId": 7,
38            "fileName": "report_final.docx",
39            "fileSize": "1.8MB",
40            "fileType": "docx",
41            "filter": {
42              "category": "report",
43              "year": {
44                "value": "2023"
45              }
46            },
47            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
48            "processLevel": "full",
49            "searchData": {},
50            "sourceUrl": "https://documents.example.com/reports/report_final.docx",
51            "status": "complete",
52            "statusMessage": "Document ingestion completed successfully",
53            "textUrl": "https://textstorage.example.com/extracted/report_final.txt",
54            "xrayUrl": "https://xray.example.com/results/report_final.json"
55          }
56        ],
57        "total": 1
58      },
59      "errors": {
60        "documents": [
61          {
62            "documentId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
63            "bucketId": 7,
64            "fileName": "invoice_error.csv",
65            "fileSize": "0.9MB",
66            "fileType": "csv",
67            "filter": {
68              "category": "finance",
69              "status": {
70                "errorType": "parsing"
71              }
72            },
73            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
74            "processLevel": "none",
75            "searchData": {},
76            "sourceUrl": "https://documents.example.com/invoices/invoice_error.csv",
77            "status": "error",
78            "statusMessage": "Failed to parse CSV file",
79            "textUrl": "https://textstorage.example.com/extracted/invoice_error.txt",
80            "xrayUrl": "https://xray.example.com/results/invoice_error.json"
81          }
82        ],
83        "total": 1
84      },
85      "processing": {
86        "documents": [
87          {
88            "documentId": "9c858901-8a57-4791-81fe-4c455b099bc9",
89            "bucketId": 7,
90            "fileName": "presentation_draft.pptx",
91            "fileSize": "3.5MB",
92            "fileType": "pptx",
93            "filter": {
94              "category": "marketing",
95              "stage": {
96                "value": "draft"
97              }
98            },
99            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
100            "processLevel": "full",
101            "searchData": {},
102            "sourceUrl": "https://documents.example.com/presentations/presentation_draft.pptx",
103            "status": "processing",
104            "statusMessage": "Document is currently being processed",
105            "textUrl": "https://textstorage.example.com/extracted/presentation_draft.txt",
106            "xrayUrl": "https://xray.example.com/results/presentation_draft.json"
107          }
108        ],
109        "total": 1
110      },
111      "queued": {
112        "documents": [
113          {
114            "documentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
115            "bucketId": 7,
116            "fileName": "notes.txt",
117            "fileSize": "0.1MB",
118            "fileType": "txt",
119            "filter": {
120              "category": "notes",
121              "importance": {
122                "level": "low"
123              }
124            },
125            "processId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
126            "processLevel": "none",
127            "searchData": {},
128            "sourceUrl": "https://documents.example.com/notes/notes.txt",
129            "status": "queued",
130            "statusMessage": "Document is queued for ingestion",
131            "textUrl": "https://textstorage.example.com/extracted/notes.txt",
132            "xrayUrl": "https://xray.example.com/results/notes.json"
133          }
134        ],
135        "total": 1
136      }
137    },
138    "statusMessage": "Ingest process cancelled successfully"
139  }
140}
Cancel an ingest process, along with any files that have not been completely ingested.
Was this page helpful?
Previous

get_extract

Next
Built with

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

processIdstringRequiredformat: "uuid"
the processId for the ingest process to be cancelled

Response

Cancel success
ingestobject

Errors

400
Bad Request Error
401
Unauthorized Error