update | Documentation

from groundx import GroundX, DocumentUpdate
client = GroundX(
    api_key="YOUR_API_KEY_HERE",
)
client.documents.update(
    documents=[
        DocumentUpdate(
            document_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
        )
    ],
)

{
  "ingest": {
    "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
    "status": "queued",
    "id": 12345,
    "progress": {
      "cancelled": {
        "documents": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "bucketId": 101,
            "fileName": "Project_Plan_2024.pdf",
            "fileSize": "2.3MB",
            "fileType": "pdf",
            "filter": {
              "key": "finance",
              "another_key": {
                "nested": "quarter1"
              }
            },
            "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
            "processLevel": "none",
            "searchData": {},
            "sourceUrl": "https://documents.example.com/project_plan_2024.pdf",
            "status": "cancelled",
            "statusMessage": "User cancelled the processing",
            "textUrl": "https://textstorage.example.com/project_plan_2024.txt",
            "xrayUrl": "https://xray.example.com/project_plan_2024.json"
          }
        ],
        "total": 1
      },
      "complete": {
        "documents": [
          {
            "documentId": "7e9f1d2a-3c4b-4d5e-8f6a-7b8c9d0e1f2a",
            "bucketId": 101,
            "fileName": "Meeting_Notes_March.docx",
            "fileSize": "1.1MB",
            "fileType": "docx",
            "filter": {
              "key": "meetings",
              "another_key": {
                "nested": "march"
              }
            },
            "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
            "processLevel": "full",
            "searchData": {},
            "sourceUrl": "https://documents.example.com/meeting_notes_march.docx",
            "status": "complete",
            "statusMessage": "Document processed successfully",
            "textUrl": "https://textstorage.example.com/meeting_notes_march.txt",
            "xrayUrl": "https://xray.example.com/meeting_notes_march.json"
          }
        ],
        "total": 1
      },
      "errors": {
        "documents": [
          {
            "documentId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
            "bucketId": 102,
            "fileName": "Financial_Report_2023.csv",
            "fileSize": "3.5MB",
            "fileType": "csv",
            "filter": {
              "key": "finance",
              "another_key": {
                "nested": "annual"
              }
            },
            "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
            "processLevel": "full",
            "searchData": {},
            "sourceUrl": "https://documents.example.com/financial_report_2023.csv",
            "status": "error",
            "statusMessage": "File format not supported",
            "textUrl": "https://textstorage.example.com/financial_report_2023.txt",
            "xrayUrl": "https://xray.example.com/financial_report_2023.json"
          }
        ],
        "total": 1
      },
      "processing": {
        "documents": [
          {
            "documentId": "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
            "bucketId": 103,
            "fileName": "Product_Design_Specs.svg",
            "fileSize": "5.0MB",
            "fileType": "svg",
            "filter": {
              "key": "design",
              "another_key": {
                "nested": "specs"
              }
            },
            "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
            "processLevel": "full",
            "searchData": {},
            "sourceUrl": "https://documents.example.com/product_design_specs.svg",
            "status": "processing",
            "statusMessage": "Currently processing document",
            "textUrl": "https://textstorage.example.com/product_design_specs.txt",
            "xrayUrl": "https://xray.example.com/product_design_specs.json"
          }
        ],
        "total": 1
      },
      "queued": {
        "documents": [
          {
            "documentId": "5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f",
            "bucketId": 104,
            "fileName": "User_Manual_2024.pdf",
            "fileSize": "4.2MB",
            "fileType": "pdf",
            "filter": {
              "key": "manuals",
              "another_key": {
                "nested": "user"
              }
            },
            "processId": "9b2c1f4e-8d3a-4f7a-9c2e-1a2b3c4d5e6f",
            "processLevel": "none",
            "searchData": {},
            "sourceUrl": "https://documents.example.com/user_manual_2024.pdf",
            "status": "queued",
            "statusMessage": "Waiting in queue",
            "textUrl": "https://textstorage.example.com/user_manual_2024.txt",
            "xrayUrl": "https://xray.example.com/user_manual_2024.json"
          }
        ],
        "total": 1
      }
    },
    "statusMessage": "Documents are queued for processing"
  }
}

Update the attributes of documents that have been uploaded to GroundX.

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