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

update

PUT
https://api.groundx.ai/api/v1/ingest/documents
PUT
/api/v1/ingest/documents
1from groundx import GroundX, DocumentUpdate
2
3client = GroundX(
4    api_key="YOUR_API_KEY_HERE",
5)
6
7client.documents.update(
8    documents=[
9        DocumentUpdate(
10            document_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
11        )
12    ],
13)
1{
2  "ingest": {
3    "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
4    "status": "queued",
5    "id": 12345,
6    "progress": {
7      "cancelled": {
8        "documents": [
9          {
10            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11            "bucketId": 101,
12            "fileName": "Project_Plan_2024.pdf",
13            "fileSize": "2.3MB",
14            "fileType": "pdf",
15            "filter": {
16              "key": "finance",
17              "another_key": {
18                "nested": "quarter1"
19              }
20            },
21            "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
22            "processLevel": "none",
23            "searchData": {},
24            "sourceUrl": "https://documents.example.com/project_plan_2024.pdf",
25            "status": "cancelled",
26            "statusMessage": "User cancelled the processing",
27            "textUrl": "https://textstorage.example.com/project_plan_2024.txt",
28            "xrayUrl": "https://xray.example.com/project_plan_2024.json"
29          }
30        ],
31        "total": 1
32      },
33      "complete": {
34        "documents": [
35          {
36            "documentId": "7e9f1d2a-3c4b-4d5e-8f6a-7b8c9d0e1f2a",
37            "bucketId": 101,
38            "fileName": "Meeting_Notes_March.docx",
39            "fileSize": "1.1MB",
40            "fileType": "docx",
41            "filter": {
42              "key": "meetings",
43              "another_key": {
44                "nested": "march"
45              }
46            },
47            "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
48            "processLevel": "full",
49            "searchData": {},
50            "sourceUrl": "https://documents.example.com/meeting_notes_march.docx",
51            "status": "complete",
52            "statusMessage": "Document processed successfully",
53            "textUrl": "https://textstorage.example.com/meeting_notes_march.txt",
54            "xrayUrl": "https://xray.example.com/meeting_notes_march.json"
55          }
56        ],
57        "total": 1
58      },
59      "errors": {
60        "documents": [
61          {
62            "documentId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
63            "bucketId": 102,
64            "fileName": "Financial_Report_2023.csv",
65            "fileSize": "3.5MB",
66            "fileType": "csv",
67            "filter": {
68              "key": "finance",
69              "another_key": {
70                "nested": "annual"
71              }
72            },
73            "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
74            "processLevel": "full",
75            "searchData": {},
76            "sourceUrl": "https://documents.example.com/financial_report_2023.csv",
77            "status": "error",
78            "statusMessage": "File format not supported",
79            "textUrl": "https://textstorage.example.com/financial_report_2023.txt",
80            "xrayUrl": "https://xray.example.com/financial_report_2023.json"
81          }
82        ],
83        "total": 1
84      },
85      "processing": {
86        "documents": [
87          {
88            "documentId": "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
89            "bucketId": 103,
90            "fileName": "Product_Design_Specs.svg",
91            "fileSize": "5.0MB",
92            "fileType": "svg",
93            "filter": {
94              "key": "design",
95              "another_key": {
96                "nested": "specs"
97              }
98            },
99            "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
100            "processLevel": "full",
101            "searchData": {},
102            "sourceUrl": "https://documents.example.com/product_design_specs.svg",
103            "status": "processing",
104            "statusMessage": "Currently processing document",
105            "textUrl": "https://textstorage.example.com/product_design_specs.txt",
106            "xrayUrl": "https://xray.example.com/product_design_specs.json"
107          }
108        ],
109        "total": 1
110      },
111      "queued": {
112        "documents": [
113          {
114            "documentId": "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
115            "bucketId": 104,
116            "fileName": "User_Manual_2024.pdf",
117            "fileSize": "4.2MB",
118            "fileType": "pdf",
119            "filter": {
120              "key": "manuals",
121              "another_key": {
122                "nested": "user"
123              }
124            },
125            "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
126            "processLevel": "none",
127            "searchData": {},
128            "sourceUrl": "https://documents.example.com/user_manual_2024.pdf",
129            "status": "queued",
130            "statusMessage": "Waiting in queue",
131            "textUrl": "https://textstorage.example.com/user_manual_2024.txt",
132            "xrayUrl": "https://xray.example.com/user_manual_2024.json"
133          }
134        ],
135        "total": 1
136      }
137    },
138    "statusMessage": "Documents are queued for processing"
139  }
140}
Update the attributes of documents that have been uploaded to GroundX.
Was this page helpful?
Previous

cancel_process

Next
Built with

Authentication

X-API-Keystring
API Key authentication via header

Request

This endpoint expects an object.
documentslist of objectsRequired
callbackUrlstringOptionalformat: "uri"
An endpoint that will receive processing event updates as POST.
callbackDatastringOptional
A string that is returned, along with processing event updates, to the callback URL.

Response

Documents successfully submitted for updates
ingestobject

Errors

400
Bad Request Error
401
Unauthorized Error